##// END OF EJS Templates
check-code: Only call check-code if __name__ = "__main__"....
Pierre-Yves David -
r10716:5f92bde7 default
parent child Browse files
Show More
@@ -1,169 +1,170 b''
1 #!/usr/bin/env python
1 #!/usr/bin/env python
2 #
2 #
3 # check-code - a style and portability checker for Mercurial
3 # check-code - a style and portability checker for Mercurial
4 #
4 #
5 # Copyright 2010 Matt Mackall <mpm@selenic.com>
5 # Copyright 2010 Matt Mackall <mpm@selenic.com>
6 #
6 #
7 # This software may be used and distributed according to the terms of the
7 # This software may be used and distributed according to the terms of the
8 # GNU General Public License version 2 or any later version.
8 # GNU General Public License version 2 or any later version.
9
9
10 import sys, re, glob
10 import sys, re, glob
11
11
12 def repquote(m):
12 def repquote(m):
13 t = re.sub(r"\w", "x", m.group(2))
13 t = re.sub(r"\w", "x", m.group(2))
14 t = re.sub(r"[^\sx]", "o", t)
14 t = re.sub(r"[^\sx]", "o", t)
15 return m.group(1) + t + m.group(1)
15 return m.group(1) + t + m.group(1)
16
16
17 def repcomment(m):
17 def repcomment(m):
18 return m.group(1) + "#" * len(m.group(2))
18 return m.group(1) + "#" * len(m.group(2))
19
19
20 def repccomment(m):
20 def repccomment(m):
21 t = re.sub(r"((?<=\n) )|\S", "x", m.group(2))
21 t = re.sub(r"((?<=\n) )|\S", "x", m.group(2))
22 return m.group(1) + t + "*/"
22 return m.group(1) + t + "*/"
23
23
24 def repcallspaces(m):
24 def repcallspaces(m):
25 t = re.sub(r"\n\s+", "\n", m.group(2))
25 t = re.sub(r"\n\s+", "\n", m.group(2))
26 return m.group(1) + t
26 return m.group(1) + t
27
27
28 def repinclude(m):
28 def repinclude(m):
29 return m.group(1) + "<foo>"
29 return m.group(1) + "<foo>"
30
30
31 def rephere(m):
31 def rephere(m):
32 t = re.sub(r"\S", "x", m.group(2))
32 t = re.sub(r"\S", "x", m.group(2))
33 return m.group(1) + t
33 return m.group(1) + t
34
34
35
35
36 testpats = [
36 testpats = [
37 (r'(pushd|popd)', "don't use 'pushd' or 'popd', use 'cd'"),
37 (r'(pushd|popd)', "don't use 'pushd' or 'popd', use 'cd'"),
38 (r'\W\$?\(\([^\)]*\)\)', "don't use (()) or $(()), use 'expr'"),
38 (r'\W\$?\(\([^\)]*\)\)', "don't use (()) or $(()), use 'expr'"),
39 (r'^function', "don't use 'function', use old style"),
39 (r'^function', "don't use 'function', use old style"),
40 (r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"),
40 (r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"),
41 (r'echo.*\\n', "don't use 'echo \\n', use printf"),
41 (r'echo.*\\n', "don't use 'echo \\n', use printf"),
42 (r'^diff.*-\w*N', "don't use 'diff -N'"),
42 (r'^diff.*-\w*N', "don't use 'diff -N'"),
43 (r'(^| )wc[^|]*$', "filter wc output"),
43 (r'(^| )wc[^|]*$', "filter wc output"),
44 (r'head -c', "don't use 'head -c', use 'dd'"),
44 (r'head -c', "don't use 'head -c', use 'dd'"),
45 (r'ls.*-\w*R', "don't use 'ls -R', use 'find'"),
45 (r'ls.*-\w*R', "don't use 'ls -R', use 'find'"),
46 (r'printf.*\\\d\d\d', "don't use 'printf \NNN', use Python"),
46 (r'printf.*\\\d\d\d', "don't use 'printf \NNN', use Python"),
47 (r'printf.*\\x', "don't use printf \\x, use Python"),
47 (r'printf.*\\x', "don't use printf \\x, use Python"),
48 (r'\$\(.*\)', "don't use $(expr), use `expr`"),
48 (r'\$\(.*\)', "don't use $(expr), use `expr`"),
49 (r'rm -rf \*', "don't use naked rm -rf, target a directory"),
49 (r'rm -rf \*', "don't use naked rm -rf, target a directory"),
50 (r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w',
50 (r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w',
51 "use egrep for extended grep syntax"),
51 "use egrep for extended grep syntax"),
52 (r'/bin/', "don't use explicit paths for tools"),
52 (r'/bin/', "don't use explicit paths for tools"),
53 (r'\$PWD', "don't use $PWD, use `pwd`"),
53 (r'\$PWD', "don't use $PWD, use `pwd`"),
54 (r'[^\n]\Z', "no trailing newline"),
54 (r'[^\n]\Z', "no trailing newline"),
55 (r'export.*=', "don't export and assign at once"),
55 (r'export.*=', "don't export and assign at once"),
56 ]
56 ]
57
57
58 testfilters = [
58 testfilters = [
59 (r"( *)(#([^\n]*\S)?)", repcomment),
59 (r"( *)(#([^\n]*\S)?)", repcomment),
60 (r"<<(\S+)((.|\n)*?\n\1)", rephere),
60 (r"<<(\S+)((.|\n)*?\n\1)", rephere),
61 ]
61 ]
62
62
63 pypats = [
63 pypats = [
64 (r'^\s*\t', "don't use tabs"),
64 (r'^\s*\t', "don't use tabs"),
65 (r'\S;\s*\n', "semicolon"),
65 (r'\S;\s*\n', "semicolon"),
66 (r'\w,\w', "missing whitespace after ,"),
66 (r'\w,\w', "missing whitespace after ,"),
67 (r'\w[+/*\-<>]\w', "missing whitespace in expression"),
67 (r'\w[+/*\-<>]\w', "missing whitespace in expression"),
68 (r'^\s+\w+=\w+[^,)]$', "missing whitespace in assignment"),
68 (r'^\s+\w+=\w+[^,)]$', "missing whitespace in assignment"),
69 (r'.{85}', "line too long"),
69 (r'.{85}', "line too long"),
70 (r'[^\n]\Z', "no trailing newline"),
70 (r'[^\n]\Z', "no trailing newline"),
71 # (r'^\s+[^_ ][^_. ]+_[^_]+\s*=', "don't use underbars in identifiers"),
71 # (r'^\s+[^_ ][^_. ]+_[^_]+\s*=', "don't use underbars in identifiers"),
72 # (r'\w*[a-z][A-Z]\w*\s*=', "don't use camelcase in identifiers"),
72 # (r'\w*[a-z][A-Z]\w*\s*=', "don't use camelcase in identifiers"),
73 (r'^\s*(if|while|def|class|except|try)\s[^[]*:\s*[^\]#\s]+',
73 (r'^\s*(if|while|def|class|except|try)\s[^[]*:\s*[^\]#\s]+',
74 "linebreak after :"),
74 "linebreak after :"),
75 (r'class\s[^(]:', "old-style class, use class foo(object)"),
75 (r'class\s[^(]:', "old-style class, use class foo(object)"),
76 (r'^\s+del\(', "del isn't a function"),
76 (r'^\s+del\(', "del isn't a function"),
77 (r'^\s+except\(', "except isn't a function"),
77 (r'^\s+except\(', "except isn't a function"),
78 (r',]', "unneeded trailing ',' in list"),
78 (r',]', "unneeded trailing ',' in list"),
79 # (r'class\s[A-Z][^\(]*\((?!Exception)',
79 # (r'class\s[A-Z][^\(]*\((?!Exception)',
80 # "don't capitalize non-exception classes"),
80 # "don't capitalize non-exception classes"),
81 # (r'in range\(', "use xrange"),
81 # (r'in range\(', "use xrange"),
82 # (r'^\s*print\s+', "avoid using print in core and extensions"),
82 # (r'^\s*print\s+', "avoid using print in core and extensions"),
83 (r'[\x80-\xff]', "non-ASCII character literal"),
83 (r'[\x80-\xff]', "non-ASCII character literal"),
84 (r'("\')\.format\(', "str.format() not available in Python 2.4"),
84 (r'("\')\.format\(', "str.format() not available in Python 2.4"),
85 (r'^\s*with\s+', "with not available in Python 2.4"),
85 (r'^\s*with\s+', "with not available in Python 2.4"),
86 (r'^\s*(any|all)\(', "any/all not available in Python 2.4"),
86 (r'^\s*(any|all)\(', "any/all not available in Python 2.4"),
87 (r'if\s.*\selse', "if ... else form not available in Python 2.4"),
87 (r'if\s.*\selse', "if ... else form not available in Python 2.4"),
88 (r'([\(\[]\s\S)|(\S\s[\)\]])', "gratuitous whitespace in () or []"),
88 (r'([\(\[]\s\S)|(\S\s[\)\]])', "gratuitous whitespace in () or []"),
89 # (r'\s\s=', "gratuitous whitespace before ="),
89 # (r'\s\s=', "gratuitous whitespace before ="),
90 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=)\S', "missing whitespace around operator"),
90 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=)\S', "missing whitespace around operator"),
91 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=)\s', "missing whitespace around operator"),
91 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=)\s', "missing whitespace around operator"),
92 (r'\s(\+=|-=|!=|<>|<=|>=|<<=|>>=)\S', "missing whitespace around operator"),
92 (r'\s(\+=|-=|!=|<>|<=|>=|<<=|>>=)\S', "missing whitespace around operator"),
93 (r'[^+=*!<>&| -](\s=|=\s)[^= ]', "wrong whitespace around ="),
93 (r'[^+=*!<>&| -](\s=|=\s)[^= ]', "wrong whitespace around ="),
94 (r'raise Exception', "don't raise generic exceptions"),
94 (r'raise Exception', "don't raise generic exceptions"),
95 (r'ui\.(status|progress|write|note)\([\'\"]x', "unwrapped ui message"),
95 (r'ui\.(status|progress|write|note)\([\'\"]x', "unwrapped ui message"),
96 ]
96 ]
97
97
98 pyfilters = [
98 pyfilters = [
99 (r'''(?<!")(")(([^"\n]|\\")+)"(?!")''', repquote),
99 (r'''(?<!")(")(([^"\n]|\\")+)"(?!")''', repquote),
100 (r"""(?<!')(')(([^'\n]|\\')+)'(?!')""", repquote),
100 (r"""(?<!')(')(([^'\n]|\\')+)'(?!')""", repquote),
101 (r"""(''')(([^']|\\'|'{1,2}(?!'))*)'''""", repquote),
101 (r"""(''')(([^']|\\'|'{1,2}(?!'))*)'''""", repquote),
102 (r'''(""")(([^"]|\\"|"{1,2}(?!"))*)"""''', repquote),
102 (r'''(""")(([^"]|\\"|"{1,2}(?!"))*)"""''', repquote),
103 (r"( *)(#([^\n]*\S)?)", repcomment),
103 (r"( *)(#([^\n]*\S)?)", repcomment),
104 ]
104 ]
105
105
106 cpats = [
106 cpats = [
107 (r'//', "don't use //-style comments"),
107 (r'//', "don't use //-style comments"),
108 (r'^ ', "don't use spaces to indent"),
108 (r'^ ', "don't use spaces to indent"),
109 (r'\S\t', "don't use tabs except for indent"),
109 (r'\S\t', "don't use tabs except for indent"),
110 (r'(\S\s+|^\s+)\n', "trailing whitespace"),
110 (r'(\S\s+|^\s+)\n', "trailing whitespace"),
111 (r'.{85}', "line too long"),
111 (r'.{85}', "line too long"),
112 (r'(while|if|do|for)\(', "use space after while/if/do/for"),
112 (r'(while|if|do|for)\(', "use space after while/if/do/for"),
113 (r'return\(', "return is not a function"),
113 (r'return\(', "return is not a function"),
114 (r' ;', "no space before ;"),
114 (r' ;', "no space before ;"),
115 (r'\w+\* \w+', "use int *foo, not int* foo"),
115 (r'\w+\* \w+', "use int *foo, not int* foo"),
116 (r'\([^\)]+\) \w+', "use (int)foo, not (int) foo"),
116 (r'\([^\)]+\) \w+', "use (int)foo, not (int) foo"),
117 (r'\S+ (\+\+|--)', "use foo++, not foo ++"),
117 (r'\S+ (\+\+|--)', "use foo++, not foo ++"),
118 (r'\w,\w', "missing whitespace after ,"),
118 (r'\w,\w', "missing whitespace after ,"),
119 (r'\w[+/*]\w', "missing whitespace in expression"),
119 (r'\w[+/*]\w', "missing whitespace in expression"),
120 (r'^#\s+\w', "use #foo, not # foo"),
120 (r'^#\s+\w', "use #foo, not # foo"),
121 (r'[^\n]\Z', "no trailing newline"),
121 (r'[^\n]\Z', "no trailing newline"),
122 ]
122 ]
123
123
124 cfilters = [
124 cfilters = [
125 (r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment),
125 (r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment),
126 (r'''(?<!")(")(([^"]|\\")+"(?!"))''', repquote),
126 (r'''(?<!")(")(([^"]|\\")+"(?!"))''', repquote),
127 (r'''(#\s*include\s+<)([^>]+)>''', repinclude),
127 (r'''(#\s*include\s+<)([^>]+)>''', repinclude),
128 (r'(\()([^)]+\))', repcallspaces),
128 (r'(\()([^)]+\))', repcallspaces),
129 ]
129 ]
130
130
131 checks = [
131 checks = [
132 ('python', r'.*\.(py|cgi)$', pyfilters, pypats),
132 ('python', r'.*\.(py|cgi)$', pyfilters, pypats),
133 ('test script', r'(.*/)?test-[^.~]*$', testfilters, testpats),
133 ('test script', r'(.*/)?test-[^.~]*$', testfilters, testpats),
134 ('c', r'.*\.c$', cfilters, cpats),
134 ('c', r'.*\.c$', cfilters, cpats),
135 ]
135 ]
136
136
137 if len(sys.argv) == 1:
137 if __name__ == "__main__":
138 check = glob.glob("*")
138 if len(sys.argv) == 1:
139 else:
139 check = glob.glob("*")
140 check = sys.argv[1:]
140 else:
141 check = sys.argv[1:]
141
142
142 for f in check:
143 for f in check:
143 for name, match, filters, pats in checks:
144 for name, match, filters, pats in checks:
144 fc = 0
145 fc = 0
145 if not re.match(match, f):
146 if not re.match(match, f):
146 continue
147 continue
147 pre = post = open(f).read()
148 pre = post = open(f).read()
148 if "no-" + "check-code" in pre:
149 if "no-" + "check-code" in pre:
150 break
151 for p, r in filters:
152 post = re.sub(p, r, post)
153 # print post # uncomment to show filtered version
154 z = enumerate(zip(pre.splitlines(), post.splitlines(True)))
155 for n, l in z:
156 if "check-code" + "-ignore" in l[0]:
157 continue
158 lc = 0
159 for p, msg in pats:
160 if re.search(p, l[1]):
161 if not lc:
162 print "%s:%d:" % (f, n + 1)
163 print " > %s" % l[0]
164 print " %s" % msg
165 lc += 1
166 fc += 1
167 if fc == 15:
168 print " (too many errors, giving up)"
169 break
149 break
170 break
150 for p, r in filters:
151 post = re.sub(p, r, post)
152 # print post # uncomment to show filtered version
153 z = enumerate(zip(pre.splitlines(), post.splitlines(True)))
154 for n, l in z:
155 if "check-code" + "-ignore" in l[0]:
156 continue
157 lc = 0
158 for p, msg in pats:
159 if re.search(p, l[1]):
160 if not lc:
161 print "%s:%d:" % (f, n + 1)
162 print " > %s" % l[0]
163 print " %s" % msg
164 lc += 1
165 fc += 1
166 if fc == 15:
167 print " (too many errors, giving up)"
168 break
169 break
General Comments 0
You need to be logged in to leave comments. Login now