bugfix + minor mathutils.Vector edits.
[blender.git] / source / test / 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 release/test/pep8.py > pep8_error.txt 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"):
46                 yield os.path.join(dirpath, filename)
47
48
49 def is_pep8(path):
50     print(path)
51     f = open(path, 'r', encoding="utf8")
52     for i in range(PEP8_SEEK_COMMENT):
53         line = f.readline()
54         if line.startswith("# <pep8"):
55             if line.startswith("# <pep8 compliant>"):
56                 return 1
57             elif line.startswith("# <pep8-80 compliant>"):
58                 return 2
59     f.close()
60     return 0
61
62
63 def main():
64     files = []
65     files_skip = []
66     for f in file_list_py("."):
67         if [None for prefix in SKIP_PREFIX if f.startswith(prefix)]:
68             continue
69
70         pep8_type = is_pep8(f)
71
72         if pep8_type:
73             # so we can batch them for each tool.
74             files.append((os.path.abspath(f), pep8_type))
75         else:
76             files_skip.append(f)
77
78     print("\nSkipping...")
79     for f in files_skip:
80         print("    %s" % f)
81
82     # pyflakes
83     print("\n\n\n# running pep8...")
84     for f, pep8_type in files:
85         if pep8_type == 1:
86             # E501:80 line length
87             os.system("pep8 --repeat --ignore=E501 '%s'" % (f))
88         else:
89             os.system("pep8 --repeat '%s'" % (f))
90
91     print("\n\n\n# running pyflakes...")
92     for f, pep8_type in files:
93         os.system("pyflakes '%s'" % f)
94
95     print("\n\n\n# running pylint...")
96     for f, pep8_type in files:
97         # let pep8 complain about line length
98         os.system("pylint --reports=n --max-line-length=1000 '%s'" % f)
99
100 if __name__ == "__main__":
101     main()