script to report deprecated functions of text and their age in days.
[blender.git] / source / tests / pep8.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 import os
22
23 # depends on pep8, pyflakes, pylint
24 # for ubuntu
25 #
26 #   sudo apt-get install pylint pyflakes
27 #
28 #   sudo apt-get install python-setuptools python-pip
29 #   sudo pip install pep8
30 #
31 # in debian install pylint pyflakes pep8 with apt-get/aptitude/etc
32 #
33 # on *nix run
34 #   python source/tests/pep8.py > test_pep8.log 2>&1
35
36 # how many lines to read into the file, pep8 comment
37 # should be directly after the licence header, ~20 in most cases
38 PEP8_SEEK_COMMENT = 40
39 SKIP_PREFIX = "./tools", "./config", "./scons", "./extern"
40
41
42 def file_list_py(path):
43     for dirpath, dirnames, filenames in os.walk(path):
44         for filename in filenames:
45             if filename.endswith(".py") or filename.endswith(".cfg"):
46                 yield os.path.join(dirpath, filename)
47
48
49 def is_pep8(path):
50     print(path)
51     if open(path, 'rb').read(3) == b'\xef\xbb\xbf':
52         print("\nfile contains BOM, remove first 3 bytes: %r\n" % path)
53
54     # templates dont have a header but should be pep8
55     for d in ("presets", "templates", "examples"):
56         if ("%s%s%s" % (os.sep, d, os.sep)) in path:
57             return 1
58
59     f = open(path, 'r', encoding="utf8")
60     for i in range(PEP8_SEEK_COMMENT):
61         line = f.readline()
62         if line.startswith("# <pep8"):
63             if line.startswith("# <pep8 compliant>"):
64                 return 1
65             elif line.startswith("# <pep8-80 compliant>"):
66                 return 2
67     f.close()
68     return 0
69
70
71 def main():
72     files = []
73     files_skip = []
74     for f in file_list_py("."):
75         if [None for prefix in SKIP_PREFIX if f.startswith(prefix)]:
76             continue
77
78         pep8_type = is_pep8(f)
79
80         if pep8_type:
81             # so we can batch them for each tool.
82             files.append((os.path.abspath(f), pep8_type))
83         else:
84             files_skip.append(f)
85
86     print("\nSkipping...")
87     for f in files_skip:
88         print("    %s" % f)
89
90     # strict imports
91     print("\n\n\n# running pep8...")
92     import re
93     import_check = re.compile(r"\s*from\s+[A-z\.]+\s+import \*\s*")
94     for f, pep8_type in files:
95         for i, l in enumerate(open(f, 'r', encoding='utf8')):
96             if import_check.match(l):
97                 print("%s:%d:0: global import bad practice" % (f, i + 1))
98
99     print("\n\n\n# running pep8...")
100     for f, pep8_type in files:
101         if pep8_type == 1:
102             # E501:80 line length
103             os.system("pep8 --repeat --ignore=E501 '%s'" % (f))
104         else:
105             os.system("pep8 --repeat '%s'" % (f))
106
107     # pyflakes
108     print("\n\n\n# running pyflakes...")
109     for f, pep8_type in files:
110         os.system("pyflakes '%s'" % f)
111
112     print("\n\n\n# running pylint...")
113     for f, pep8_type in files:
114         # let pep8 complain about line length
115         os.system("pylint --reports=n --max-line-length=1000 '%s'" % f)
116
117 if __name__ == "__main__":
118     main()