Creating a BGE staging branch.
[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-80 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 license header, ~20 in most cases
38 PEP8_SEEK_COMMENT = 40
39 SKIP_PREFIX = "./tools", "./config", "./scons", "./extern"
40 SKIP_ADDONS = True
41 FORCE_PEP8_ALL = False
42
43
44 def file_list_py(path):
45     for dirpath, dirnames, filenames in os.walk(path):
46         for filename in filenames:
47             if filename.endswith((".py", ".cfg")):
48                 yield os.path.join(dirpath, filename)
49
50
51 def is_pep8(path):
52     print(path)
53     if open(path, 'rb').read(3) == b'\xef\xbb\xbf':
54         print("\nfile contains BOM, remove first 3 bytes: %r\n" % path)
55
56     # templates don't have a header but should be pep8
57     for d in ("presets", "templates", "examples"):
58         if ("%s%s%s" % (os.sep, d, os.sep)) in path:
59             return 1
60
61     f = open(path, 'r', encoding="utf8")
62     for i in range(PEP8_SEEK_COMMENT):
63         line = f.readline()
64         if line.startswith("# <pep8"):
65             if line.startswith("# <pep8 compliant>"):
66                 return 1
67             elif line.startswith("# <pep8-80 compliant>"):
68                 return 2
69     f.close()
70     return 0
71
72
73 def main():
74     files = []
75     files_skip = []
76     for f in file_list_py("."):
77         if [None for prefix in SKIP_PREFIX if f.startswith(prefix)]:
78             continue
79
80         if SKIP_ADDONS:
81             if (os.sep + "addons") in f:
82                 continue
83
84         pep8_type = FORCE_PEP8_ALL or is_pep8(f)
85
86         if pep8_type:
87             # so we can batch them for each tool.
88             files.append((os.path.abspath(f), pep8_type))
89         else:
90             files_skip.append(f)
91
92     print("\nSkipping...")
93     for f in files_skip:
94         print("    %s" % f)
95
96     # strict imports
97     print("\n\n\n# running pep8...")
98     import re
99     import_check = re.compile(r"\s*from\s+[A-z\.]+\s+import \*\s*")
100     for f, pep8_type in files:
101         for i, l in enumerate(open(f, 'r', encoding='utf8')):
102             if import_check.match(l):
103                 print("%s:%d:0: global import bad practice" % (f, i + 1))
104
105     print("\n\n\n# running pep8...")
106
107     # these are very picky and often hard to follow
108     # while keeping common script formatting.
109     ignore = "E122", "E123", "E124", "E125", "E126", "E127", "E128"
110
111     for f, pep8_type in files:
112
113         if pep8_type == 1:
114             # E501:80 line length
115             ignore_tmp = ignore + ("E501", )
116         else:
117             ignore_tmp = ignore
118
119         os.system("pep8 --repeat --ignore=%s '%s'" % (",".join(ignore_tmp), f))
120
121     # pyflakes
122     print("\n\n\n# running pyflakes...")
123     for f, pep8_type in files:
124         os.system("pyflakes '%s'" % f)
125
126     print("\n\n\n# running pylint...")
127     for f, pep8_type in files:
128         # let pep8 complain about line length
129         os.system("pylint "
130                   "--disable="
131                   "C0111,"  # missing doc string
132                   "C0103,"  # invalid name
133                   "W0613,"  # unused argument, may add this back
134                             # but happens a lot for 'context' for eg.
135                   "W0232,"  # class has no __init__, Operator/Panel/Menu etc
136                   "W0142,"  # Used * or ** magic
137                             # even needed in some cases
138                   "R0902,"  # Too many instance attributes
139                   "R0903,"  # Too many statements
140                   "R0911,"  # Too many return statements
141                   "R0912,"  # Too many branches
142                   "R0913,"  # Too many arguments
143                   "R0914,"  # Too many local variables
144                   "R0915,"  # Too many statements
145                   " "
146                   "--include-ids=y "
147                   "--output-format=parseable "
148                   "--reports=n "
149                   "--max-line-length=1000"
150                   " '%s'" % f)
151
152 if __name__ == "__main__":
153     main()