##// END OF EJS Templates
contrib: open a hole in the open().read() ban for open().close()...
Augie Fackler -
r36967:35d814fe default
parent child Browse files
Show More
@@ -1,738 +1,738 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 """style and portability checker for Mercurial
10 """style and portability checker for Mercurial
11
11
12 when a rule triggers wrong, do one of the following (prefer one from top):
12 when a rule triggers wrong, do one of the following (prefer one from top):
13 * do the work-around the rule suggests
13 * do the work-around the rule suggests
14 * doublecheck that it is a false match
14 * doublecheck that it is a false match
15 * improve the rule pattern
15 * improve the rule pattern
16 * add an ignore pattern to the rule (3rd arg) which matches your good line
16 * add an ignore pattern to the rule (3rd arg) which matches your good line
17 (you can append a short comment and match this, like: #re-raises)
17 (you can append a short comment and match this, like: #re-raises)
18 * change the pattern to a warning and list the exception in test-check-code-hg
18 * change the pattern to a warning and list the exception in test-check-code-hg
19 * ONLY use no--check-code for skipping entire files from external sources
19 * ONLY use no--check-code for skipping entire files from external sources
20 """
20 """
21
21
22 from __future__ import absolute_import, print_function
22 from __future__ import absolute_import, print_function
23 import glob
23 import glob
24 import keyword
24 import keyword
25 import optparse
25 import optparse
26 import os
26 import os
27 import re
27 import re
28 import sys
28 import sys
29 if sys.version_info[0] < 3:
29 if sys.version_info[0] < 3:
30 opentext = open
30 opentext = open
31 else:
31 else:
32 def opentext(f):
32 def opentext(f):
33 return open(f, encoding='ascii')
33 return open(f, encoding='ascii')
34 try:
34 try:
35 xrange
35 xrange
36 except NameError:
36 except NameError:
37 xrange = range
37 xrange = range
38 try:
38 try:
39 import re2
39 import re2
40 except ImportError:
40 except ImportError:
41 re2 = None
41 re2 = None
42
42
43 def compilere(pat, multiline=False):
43 def compilere(pat, multiline=False):
44 if multiline:
44 if multiline:
45 pat = '(?m)' + pat
45 pat = '(?m)' + pat
46 if re2:
46 if re2:
47 try:
47 try:
48 return re2.compile(pat)
48 return re2.compile(pat)
49 except re2.error:
49 except re2.error:
50 pass
50 pass
51 return re.compile(pat)
51 return re.compile(pat)
52
52
53 # check "rules depending on implementation of repquote()" in each
53 # check "rules depending on implementation of repquote()" in each
54 # patterns (especially pypats), before changing around repquote()
54 # patterns (especially pypats), before changing around repquote()
55 _repquotefixedmap = {' ': ' ', '\n': '\n', '.': 'p', ':': 'q',
55 _repquotefixedmap = {' ': ' ', '\n': '\n', '.': 'p', ':': 'q',
56 '%': '%', '\\': 'b', '*': 'A', '+': 'P', '-': 'M'}
56 '%': '%', '\\': 'b', '*': 'A', '+': 'P', '-': 'M'}
57 def _repquoteencodechr(i):
57 def _repquoteencodechr(i):
58 if i > 255:
58 if i > 255:
59 return 'u'
59 return 'u'
60 c = chr(i)
60 c = chr(i)
61 if c in _repquotefixedmap:
61 if c in _repquotefixedmap:
62 return _repquotefixedmap[c]
62 return _repquotefixedmap[c]
63 if c.isalpha():
63 if c.isalpha():
64 return 'x'
64 return 'x'
65 if c.isdigit():
65 if c.isdigit():
66 return 'n'
66 return 'n'
67 return 'o'
67 return 'o'
68 _repquotett = ''.join(_repquoteencodechr(i) for i in xrange(256))
68 _repquotett = ''.join(_repquoteencodechr(i) for i in xrange(256))
69
69
70 def repquote(m):
70 def repquote(m):
71 t = m.group('text')
71 t = m.group('text')
72 t = t.translate(_repquotett)
72 t = t.translate(_repquotett)
73 return m.group('quote') + t + m.group('quote')
73 return m.group('quote') + t + m.group('quote')
74
74
75 def reppython(m):
75 def reppython(m):
76 comment = m.group('comment')
76 comment = m.group('comment')
77 if comment:
77 if comment:
78 l = len(comment.rstrip())
78 l = len(comment.rstrip())
79 return "#" * l + comment[l:]
79 return "#" * l + comment[l:]
80 return repquote(m)
80 return repquote(m)
81
81
82 def repcomment(m):
82 def repcomment(m):
83 return m.group(1) + "#" * len(m.group(2))
83 return m.group(1) + "#" * len(m.group(2))
84
84
85 def repccomment(m):
85 def repccomment(m):
86 t = re.sub(r"((?<=\n) )|\S", "x", m.group(2))
86 t = re.sub(r"((?<=\n) )|\S", "x", m.group(2))
87 return m.group(1) + t + "*/"
87 return m.group(1) + t + "*/"
88
88
89 def repcallspaces(m):
89 def repcallspaces(m):
90 t = re.sub(r"\n\s+", "\n", m.group(2))
90 t = re.sub(r"\n\s+", "\n", m.group(2))
91 return m.group(1) + t
91 return m.group(1) + t
92
92
93 def repinclude(m):
93 def repinclude(m):
94 return m.group(1) + "<foo>"
94 return m.group(1) + "<foo>"
95
95
96 def rephere(m):
96 def rephere(m):
97 t = re.sub(r"\S", "x", m.group(2))
97 t = re.sub(r"\S", "x", m.group(2))
98 return m.group(1) + t
98 return m.group(1) + t
99
99
100
100
101 testpats = [
101 testpats = [
102 [
102 [
103 (r'\b(push|pop)d\b', "don't use 'pushd' or 'popd', use 'cd'"),
103 (r'\b(push|pop)d\b', "don't use 'pushd' or 'popd', use 'cd'"),
104 (r'\W\$?\(\([^\)\n]*\)\)', "don't use (()) or $(()), use 'expr'"),
104 (r'\W\$?\(\([^\)\n]*\)\)', "don't use (()) or $(()), use 'expr'"),
105 (r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"),
105 (r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"),
106 (r'(?<!hg )grep.* -a', "don't use 'grep -a', use in-line python"),
106 (r'(?<!hg )grep.* -a', "don't use 'grep -a', use in-line python"),
107 (r'sed.*-i', "don't use 'sed -i', use a temporary file"),
107 (r'sed.*-i', "don't use 'sed -i', use a temporary file"),
108 (r'\becho\b.*\\n', "don't use 'echo \\n', use printf"),
108 (r'\becho\b.*\\n', "don't use 'echo \\n', use printf"),
109 (r'echo -n', "don't use 'echo -n', use printf"),
109 (r'echo -n', "don't use 'echo -n', use printf"),
110 (r'(^|\|\s*)\bwc\b[^|]*$\n(?!.*\(re\))', "filter wc output"),
110 (r'(^|\|\s*)\bwc\b[^|]*$\n(?!.*\(re\))', "filter wc output"),
111 (r'head -c', "don't use 'head -c', use 'dd'"),
111 (r'head -c', "don't use 'head -c', use 'dd'"),
112 (r'tail -n', "don't use the '-n' option to tail, just use '-<num>'"),
112 (r'tail -n', "don't use the '-n' option to tail, just use '-<num>'"),
113 (r'sha1sum', "don't use sha1sum, use $TESTDIR/md5sum.py"),
113 (r'sha1sum', "don't use sha1sum, use $TESTDIR/md5sum.py"),
114 (r'ls.*-\w*R', "don't use 'ls -R', use 'find'"),
114 (r'ls.*-\w*R', "don't use 'ls -R', use 'find'"),
115 (r'printf.*[^\\]\\([1-9]|0\d)', r"don't use 'printf \NNN', use Python"),
115 (r'printf.*[^\\]\\([1-9]|0\d)', r"don't use 'printf \NNN', use Python"),
116 (r'printf.*[^\\]\\x', "don't use printf \\x, use Python"),
116 (r'printf.*[^\\]\\x', "don't use printf \\x, use Python"),
117 (r'\$\(.*\)', "don't use $(expr), use `expr`"),
117 (r'\$\(.*\)', "don't use $(expr), use `expr`"),
118 (r'rm -rf \*', "don't use naked rm -rf, target a directory"),
118 (r'rm -rf \*', "don't use naked rm -rf, target a directory"),
119 (r'\[[^\]]+==', '[ foo == bar ] is a bashism, use [ foo = bar ] instead'),
119 (r'\[[^\]]+==', '[ foo == bar ] is a bashism, use [ foo = bar ] instead'),
120 (r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w',
120 (r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w',
121 "use egrep for extended grep syntax"),
121 "use egrep for extended grep syntax"),
122 (r'(^|\|\s*)e?grep .*\\S', "don't use \\S in regular expression"),
122 (r'(^|\|\s*)e?grep .*\\S', "don't use \\S in regular expression"),
123 (r'(?<!!)/bin/', "don't use explicit paths for tools"),
123 (r'(?<!!)/bin/', "don't use explicit paths for tools"),
124 (r'#!.*/bash', "don't use bash in shebang, use sh"),
124 (r'#!.*/bash', "don't use bash in shebang, use sh"),
125 (r'[^\n]\Z', "no trailing newline"),
125 (r'[^\n]\Z', "no trailing newline"),
126 (r'export .*=', "don't export and assign at once"),
126 (r'export .*=', "don't export and assign at once"),
127 (r'^source\b', "don't use 'source', use '.'"),
127 (r'^source\b', "don't use 'source', use '.'"),
128 (r'touch -d', "don't use 'touch -d', use 'touch -t' instead"),
128 (r'touch -d', "don't use 'touch -d', use 'touch -t' instead"),
129 (r'\bls +[^|\n-]+ +-', "options to 'ls' must come before filenames"),
129 (r'\bls +[^|\n-]+ +-', "options to 'ls' must come before filenames"),
130 (r'[^>\n]>\s*\$HGRCPATH', "don't overwrite $HGRCPATH, append to it"),
130 (r'[^>\n]>\s*\$HGRCPATH', "don't overwrite $HGRCPATH, append to it"),
131 (r'^stop\(\)', "don't use 'stop' as a shell function name"),
131 (r'^stop\(\)', "don't use 'stop' as a shell function name"),
132 (r'(\[|\btest\b).*-e ', "don't use 'test -e', use 'test -f'"),
132 (r'(\[|\btest\b).*-e ', "don't use 'test -e', use 'test -f'"),
133 (r'\[\[\s+[^\]]*\]\]', "don't use '[[ ]]', use '[ ]'"),
133 (r'\[\[\s+[^\]]*\]\]', "don't use '[[ ]]', use '[ ]'"),
134 (r'^alias\b.*=', "don't use alias, use a function"),
134 (r'^alias\b.*=', "don't use alias, use a function"),
135 (r'if\s*!', "don't use '!' to negate exit status"),
135 (r'if\s*!', "don't use '!' to negate exit status"),
136 (r'/dev/u?random', "don't use entropy, use /dev/zero"),
136 (r'/dev/u?random', "don't use entropy, use /dev/zero"),
137 (r'do\s*true;\s*done', "don't use true as loop body, use sleep 0"),
137 (r'do\s*true;\s*done', "don't use true as loop body, use sleep 0"),
138 (r'sed (-e )?\'(\d+|/[^/]*/)i(?!\\\n)',
138 (r'sed (-e )?\'(\d+|/[^/]*/)i(?!\\\n)',
139 "put a backslash-escaped newline after sed 'i' command"),
139 "put a backslash-escaped newline after sed 'i' command"),
140 (r'^diff *-\w*[uU].*$\n(^ \$ |^$)', "prefix diff -u/-U with cmp"),
140 (r'^diff *-\w*[uU].*$\n(^ \$ |^$)', "prefix diff -u/-U with cmp"),
141 (r'^\s+(if)? diff *-\w*[uU]', "prefix diff -u/-U with cmp"),
141 (r'^\s+(if)? diff *-\w*[uU]', "prefix diff -u/-U with cmp"),
142 (r'[\s="`\']python\s(?!bindings)', "don't use 'python', use '$PYTHON'"),
142 (r'[\s="`\']python\s(?!bindings)', "don't use 'python', use '$PYTHON'"),
143 (r'seq ', "don't use 'seq', use $TESTDIR/seq.py"),
143 (r'seq ', "don't use 'seq', use $TESTDIR/seq.py"),
144 (r'\butil\.Abort\b', "directly use error.Abort"),
144 (r'\butil\.Abort\b', "directly use error.Abort"),
145 (r'\|&', "don't use |&, use 2>&1"),
145 (r'\|&', "don't use |&, use 2>&1"),
146 (r'\w = +\w', "only one space after = allowed"),
146 (r'\w = +\w', "only one space after = allowed"),
147 (r'\bsed\b.*[^\\]\\n', "don't use 'sed ... \\n', use a \\ and a newline"),
147 (r'\bsed\b.*[^\\]\\n', "don't use 'sed ... \\n', use a \\ and a newline"),
148 (r'env.*-u', "don't use 'env -u VAR', use 'unset VAR'"),
148 (r'env.*-u', "don't use 'env -u VAR', use 'unset VAR'"),
149 (r'cp.* -r ', "don't use 'cp -r', use 'cp -R'"),
149 (r'cp.* -r ', "don't use 'cp -r', use 'cp -R'"),
150 (r'grep.* -[ABC]', "don't use grep's context flags"),
150 (r'grep.* -[ABC]', "don't use grep's context flags"),
151 (r'find.*-printf',
151 (r'find.*-printf',
152 "don't use 'find -printf', it doesn't exist on BSD find(1)"),
152 "don't use 'find -printf', it doesn't exist on BSD find(1)"),
153 (r'\$RANDOM ', "don't use bash-only $RANDOM to generate random values"),
153 (r'\$RANDOM ', "don't use bash-only $RANDOM to generate random values"),
154 ],
154 ],
155 # warnings
155 # warnings
156 [
156 [
157 (r'^function', "don't use 'function', use old style"),
157 (r'^function', "don't use 'function', use old style"),
158 (r'^diff.*-\w*N', "don't use 'diff -N'"),
158 (r'^diff.*-\w*N', "don't use 'diff -N'"),
159 (r'\$PWD|\${PWD}', "don't use $PWD, use `pwd`"),
159 (r'\$PWD|\${PWD}', "don't use $PWD, use `pwd`"),
160 (r'^([^"\'\n]|("[^"\n]*")|(\'[^\'\n]*\'))*\^', "^ must be quoted"),
160 (r'^([^"\'\n]|("[^"\n]*")|(\'[^\'\n]*\'))*\^', "^ must be quoted"),
161 (r'kill (`|\$\()', "don't use kill, use killdaemons.py")
161 (r'kill (`|\$\()', "don't use kill, use killdaemons.py")
162 ]
162 ]
163 ]
163 ]
164
164
165 testfilters = [
165 testfilters = [
166 (r"( *)(#([^!][^\n]*\S)?)", repcomment),
166 (r"( *)(#([^!][^\n]*\S)?)", repcomment),
167 (r"<<(\S+)((.|\n)*?\n\1)", rephere),
167 (r"<<(\S+)((.|\n)*?\n\1)", rephere),
168 ]
168 ]
169
169
170 uprefix = r"^ \$ "
170 uprefix = r"^ \$ "
171 utestpats = [
171 utestpats = [
172 [
172 [
173 (r'^(\S.*|| [$>] \S.*)[ \t]\n', "trailing whitespace on non-output"),
173 (r'^(\S.*|| [$>] \S.*)[ \t]\n', "trailing whitespace on non-output"),
174 (uprefix + r'.*\|\s*sed[^|>\n]*\n',
174 (uprefix + r'.*\|\s*sed[^|>\n]*\n',
175 "use regex test output patterns instead of sed"),
175 "use regex test output patterns instead of sed"),
176 (uprefix + r'(true|exit 0)', "explicit zero exit unnecessary"),
176 (uprefix + r'(true|exit 0)', "explicit zero exit unnecessary"),
177 (uprefix + r'.*(?<!\[)\$\?', "explicit exit code checks unnecessary"),
177 (uprefix + r'.*(?<!\[)\$\?', "explicit exit code checks unnecessary"),
178 (uprefix + r'.*\|\| echo.*(fail|error)',
178 (uprefix + r'.*\|\| echo.*(fail|error)',
179 "explicit exit code checks unnecessary"),
179 "explicit exit code checks unnecessary"),
180 (uprefix + r'set -e', "don't use set -e"),
180 (uprefix + r'set -e', "don't use set -e"),
181 (uprefix + r'(\s|fi\b|done\b)', "use > for continued lines"),
181 (uprefix + r'(\s|fi\b|done\b)', "use > for continued lines"),
182 (uprefix + r'.*:\.\S*/', "x:.y in a path does not work on msys, rewrite "
182 (uprefix + r'.*:\.\S*/', "x:.y in a path does not work on msys, rewrite "
183 "as x://.y, or see `hg log -k msys` for alternatives", r'-\S+:\.|' #-Rxxx
183 "as x://.y, or see `hg log -k msys` for alternatives", r'-\S+:\.|' #-Rxxx
184 '# no-msys'), # in test-pull.t which is skipped on windows
184 '# no-msys'), # in test-pull.t which is skipped on windows
185 (r'^ [^$>].*27\.0\.0\.1',
185 (r'^ [^$>].*27\.0\.0\.1',
186 'use $LOCALIP not an explicit loopback address'),
186 'use $LOCALIP not an explicit loopback address'),
187 (r'^ (?![>$] ).*\$LOCALIP.*[^)]$',
187 (r'^ (?![>$] ).*\$LOCALIP.*[^)]$',
188 'mark $LOCALIP output lines with (glob) to help tests in BSD jails'),
188 'mark $LOCALIP output lines with (glob) to help tests in BSD jails'),
189 (r'^ (cat|find): .*: \$ENOENT\$',
189 (r'^ (cat|find): .*: \$ENOENT\$',
190 'use test -f to test for file existence'),
190 'use test -f to test for file existence'),
191 (r'^ diff -[^ -]*p',
191 (r'^ diff -[^ -]*p',
192 "don't use (external) diff with -p for portability"),
192 "don't use (external) diff with -p for portability"),
193 (r' readlink ', 'use readlink.py instead of readlink'),
193 (r' readlink ', 'use readlink.py instead of readlink'),
194 (r'^ [-+][-+][-+] .* [-+]0000 \(glob\)',
194 (r'^ [-+][-+][-+] .* [-+]0000 \(glob\)',
195 "glob timezone field in diff output for portability"),
195 "glob timezone field in diff output for portability"),
196 (r'^ @@ -[0-9]+ [+][0-9]+,[0-9]+ @@',
196 (r'^ @@ -[0-9]+ [+][0-9]+,[0-9]+ @@',
197 "use '@@ -N* +N,n @@ (glob)' style chunk header for portability"),
197 "use '@@ -N* +N,n @@ (glob)' style chunk header for portability"),
198 (r'^ @@ -[0-9]+,[0-9]+ [+][0-9]+ @@',
198 (r'^ @@ -[0-9]+,[0-9]+ [+][0-9]+ @@',
199 "use '@@ -N,n +N* @@ (glob)' style chunk header for portability"),
199 "use '@@ -N,n +N* @@ (glob)' style chunk header for portability"),
200 (r'^ @@ -[0-9]+ [+][0-9]+ @@',
200 (r'^ @@ -[0-9]+ [+][0-9]+ @@',
201 "use '@@ -N* +N* @@ (glob)' style chunk header for portability"),
201 "use '@@ -N* +N* @@ (glob)' style chunk header for portability"),
202 (uprefix + r'hg( +-[^ ]+( +[^ ]+)?)* +extdiff'
202 (uprefix + r'hg( +-[^ ]+( +[^ ]+)?)* +extdiff'
203 r'( +(-[^ po-]+|--(?!program|option)[^ ]+|[^-][^ ]*))*$',
203 r'( +(-[^ po-]+|--(?!program|option)[^ ]+|[^-][^ ]*))*$',
204 "use $RUNTESTDIR/pdiff via extdiff (or -o/-p for false-positives)"),
204 "use $RUNTESTDIR/pdiff via extdiff (or -o/-p for false-positives)"),
205 ],
205 ],
206 # warnings
206 # warnings
207 [
207 [
208 (r'^ (?!.*\$LOCALIP)[^*?/\n]* \(glob\)$',
208 (r'^ (?!.*\$LOCALIP)[^*?/\n]* \(glob\)$',
209 "glob match with no glob string (?, *, /, and $LOCALIP)"),
209 "glob match with no glob string (?, *, /, and $LOCALIP)"),
210 ]
210 ]
211 ]
211 ]
212
212
213 # transform plain test rules to unified test's
213 # transform plain test rules to unified test's
214 for i in [0, 1]:
214 for i in [0, 1]:
215 for tp in testpats[i]:
215 for tp in testpats[i]:
216 p = tp[0]
216 p = tp[0]
217 m = tp[1]
217 m = tp[1]
218 if p.startswith(r'^'):
218 if p.startswith(r'^'):
219 p = r"^ [$>] (%s)" % p[1:]
219 p = r"^ [$>] (%s)" % p[1:]
220 else:
220 else:
221 p = r"^ [$>] .*(%s)" % p
221 p = r"^ [$>] .*(%s)" % p
222 utestpats[i].append((p, m) + tp[2:])
222 utestpats[i].append((p, m) + tp[2:])
223
223
224 # don't transform the following rules:
224 # don't transform the following rules:
225 # " > \t" and " \t" should be allowed in unified tests
225 # " > \t" and " \t" should be allowed in unified tests
226 testpats[0].append((r'^( *)\t', "don't use tabs to indent"))
226 testpats[0].append((r'^( *)\t', "don't use tabs to indent"))
227 utestpats[0].append((r'^( ?)\t', "don't use tabs to indent"))
227 utestpats[0].append((r'^( ?)\t', "don't use tabs to indent"))
228
228
229 utestfilters = [
229 utestfilters = [
230 (r"<<(\S+)((.|\n)*?\n > \1)", rephere),
230 (r"<<(\S+)((.|\n)*?\n > \1)", rephere),
231 (r"( +)(#([^!][^\n]*\S)?)", repcomment),
231 (r"( +)(#([^!][^\n]*\S)?)", repcomment),
232 ]
232 ]
233
233
234 pypats = [
234 pypats = [
235 [
235 [
236 (r'^\s*def\s*\w+\s*\(.*,\s*\(',
236 (r'^\s*def\s*\w+\s*\(.*,\s*\(',
237 "tuple parameter unpacking not available in Python 3+"),
237 "tuple parameter unpacking not available in Python 3+"),
238 (r'lambda\s*\(.*,.*\)',
238 (r'lambda\s*\(.*,.*\)',
239 "tuple parameter unpacking not available in Python 3+"),
239 "tuple parameter unpacking not available in Python 3+"),
240 (r'(?<!def)\s+(cmp)\(', "cmp is not available in Python 3+"),
240 (r'(?<!def)\s+(cmp)\(', "cmp is not available in Python 3+"),
241 (r'(?<!\.)\breduce\s*\(.*', "reduce is not available in Python 3+"),
241 (r'(?<!\.)\breduce\s*\(.*', "reduce is not available in Python 3+"),
242 (r'\bdict\(.*=', 'dict() is different in Py2 and 3 and is slower than {}',
242 (r'\bdict\(.*=', 'dict() is different in Py2 and 3 and is slower than {}',
243 'dict-from-generator'),
243 'dict-from-generator'),
244 (r'\.has_key\b', "dict.has_key is not available in Python 3+"),
244 (r'\.has_key\b', "dict.has_key is not available in Python 3+"),
245 (r'\s<>\s', '<> operator is not available in Python 3+, use !='),
245 (r'\s<>\s', '<> operator is not available in Python 3+, use !='),
246 (r'^\s*\t', "don't use tabs"),
246 (r'^\s*\t', "don't use tabs"),
247 (r'\S;\s*\n', "semicolon"),
247 (r'\S;\s*\n', "semicolon"),
248 (r'[^_]_\([ \t\n]*(?:"[^"]+"[ \t\n+]*)+%', "don't use % inside _()"),
248 (r'[^_]_\([ \t\n]*(?:"[^"]+"[ \t\n+]*)+%', "don't use % inside _()"),
249 (r"[^_]_\([ \t\n]*(?:'[^']+'[ \t\n+]*)+%", "don't use % inside _()"),
249 (r"[^_]_\([ \t\n]*(?:'[^']+'[ \t\n+]*)+%", "don't use % inside _()"),
250 (r'(\w|\)),\w', "missing whitespace after ,"),
250 (r'(\w|\)),\w', "missing whitespace after ,"),
251 (r'(\w|\))[+/*\-<>]\w', "missing whitespace in expression"),
251 (r'(\w|\))[+/*\-<>]\w', "missing whitespace in expression"),
252 (r'^\s+(\w|\.)+=\w[^,()\n]*$', "missing whitespace in assignment"),
252 (r'^\s+(\w|\.)+=\w[^,()\n]*$', "missing whitespace in assignment"),
253 (r'\w\s=\s\s+\w', "gratuitous whitespace after ="),
253 (r'\w\s=\s\s+\w', "gratuitous whitespace after ="),
254 ((
254 ((
255 # a line ending with a colon, potentially with trailing comments
255 # a line ending with a colon, potentially with trailing comments
256 r':([ \t]*#[^\n]*)?\n'
256 r':([ \t]*#[^\n]*)?\n'
257 # one that is not a pass and not only a comment
257 # one that is not a pass and not only a comment
258 r'(?P<indent>[ \t]+)[^#][^\n]+\n'
258 r'(?P<indent>[ \t]+)[^#][^\n]+\n'
259 # more lines at the same indent level
259 # more lines at the same indent level
260 r'((?P=indent)[^\n]+\n)*'
260 r'((?P=indent)[^\n]+\n)*'
261 # a pass at the same indent level, which is bogus
261 # a pass at the same indent level, which is bogus
262 r'(?P=indent)pass[ \t\n#]'
262 r'(?P=indent)pass[ \t\n#]'
263 ), 'omit superfluous pass'),
263 ), 'omit superfluous pass'),
264 (r'.{81}', "line too long"),
264 (r'.{81}', "line too long"),
265 (r'[^\n]\Z', "no trailing newline"),
265 (r'[^\n]\Z', "no trailing newline"),
266 (r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),
266 (r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),
267 # (r'^\s+[^_ \n][^_. \n]+_[^_\n]+\s*=',
267 # (r'^\s+[^_ \n][^_. \n]+_[^_\n]+\s*=',
268 # "don't use underbars in identifiers"),
268 # "don't use underbars in identifiers"),
269 (r'^\s+(self\.)?[A-Za-z][a-z0-9]+[A-Z]\w* = ',
269 (r'^\s+(self\.)?[A-Za-z][a-z0-9]+[A-Z]\w* = ',
270 "don't use camelcase in identifiers", r'#.*camelcase-required'),
270 "don't use camelcase in identifiers", r'#.*camelcase-required'),
271 (r'^\s*(if|while|def|class|except|try)\s[^[\n]*:\s*[^\\n]#\s]+',
271 (r'^\s*(if|while|def|class|except|try)\s[^[\n]*:\s*[^\\n]#\s]+',
272 "linebreak after :"),
272 "linebreak after :"),
273 (r'class\s[^( \n]+:', "old-style class, use class foo(object)",
273 (r'class\s[^( \n]+:', "old-style class, use class foo(object)",
274 r'#.*old-style'),
274 r'#.*old-style'),
275 (r'class\s[^( \n]+\(\):',
275 (r'class\s[^( \n]+\(\):',
276 "class foo() creates old style object, use class foo(object)",
276 "class foo() creates old style object, use class foo(object)",
277 r'#.*old-style'),
277 r'#.*old-style'),
278 (r'\b(%s)\(' % '|'.join(k for k in keyword.kwlist
278 (r'\b(%s)\(' % '|'.join(k for k in keyword.kwlist
279 if k not in ('print', 'exec')),
279 if k not in ('print', 'exec')),
280 "Python keyword is not a function"),
280 "Python keyword is not a function"),
281 (r',]', "unneeded trailing ',' in list"),
281 (r',]', "unneeded trailing ',' in list"),
282 # (r'class\s[A-Z][^\(]*\((?!Exception)',
282 # (r'class\s[A-Z][^\(]*\((?!Exception)',
283 # "don't capitalize non-exception classes"),
283 # "don't capitalize non-exception classes"),
284 # (r'in range\(', "use xrange"),
284 # (r'in range\(', "use xrange"),
285 # (r'^\s*print\s+', "avoid using print in core and extensions"),
285 # (r'^\s*print\s+', "avoid using print in core and extensions"),
286 (r'[\x80-\xff]', "non-ASCII character literal"),
286 (r'[\x80-\xff]', "non-ASCII character literal"),
287 (r'("\')\.format\(', "str.format() has no bytes counterpart, use %"),
287 (r'("\')\.format\(', "str.format() has no bytes counterpart, use %"),
288 (r'^\s*(%s)\s\s' % '|'.join(keyword.kwlist),
288 (r'^\s*(%s)\s\s' % '|'.join(keyword.kwlist),
289 "gratuitous whitespace after Python keyword"),
289 "gratuitous whitespace after Python keyword"),
290 (r'([\(\[][ \t]\S)|(\S[ \t][\)\]])', "gratuitous whitespace in () or []"),
290 (r'([\(\[][ \t]\S)|(\S[ \t][\)\]])', "gratuitous whitespace in () or []"),
291 # (r'\s\s=', "gratuitous whitespace before ="),
291 # (r'\s\s=', "gratuitous whitespace before ="),
292 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',
292 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',
293 "missing whitespace around operator"),
293 "missing whitespace around operator"),
294 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\s',
294 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\s',
295 "missing whitespace around operator"),
295 "missing whitespace around operator"),
296 (r'\s(\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',
296 (r'\s(\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',
297 "missing whitespace around operator"),
297 "missing whitespace around operator"),
298 (r'[^^+=*/!<>&| %-](\s=|=\s)[^= ]',
298 (r'[^^+=*/!<>&| %-](\s=|=\s)[^= ]',
299 "wrong whitespace around ="),
299 "wrong whitespace around ="),
300 (r'\([^()]*( =[^=]|[^<>!=]= )',
300 (r'\([^()]*( =[^=]|[^<>!=]= )',
301 "no whitespace around = for named parameters"),
301 "no whitespace around = for named parameters"),
302 (r'raise Exception', "don't raise generic exceptions"),
302 (r'raise Exception', "don't raise generic exceptions"),
303 (r'raise [^,(]+, (\([^\)]+\)|[^,\(\)]+)$',
303 (r'raise [^,(]+, (\([^\)]+\)|[^,\(\)]+)$',
304 "don't use old-style two-argument raise, use Exception(message)"),
304 "don't use old-style two-argument raise, use Exception(message)"),
305 (r' is\s+(not\s+)?["\'0-9-]', "object comparison with literal"),
305 (r' is\s+(not\s+)?["\'0-9-]', "object comparison with literal"),
306 (r' [=!]=\s+(True|False|None)',
306 (r' [=!]=\s+(True|False|None)',
307 "comparison with singleton, use 'is' or 'is not' instead"),
307 "comparison with singleton, use 'is' or 'is not' instead"),
308 (r'^\s*(while|if) [01]:',
308 (r'^\s*(while|if) [01]:',
309 "use True/False for constant Boolean expression"),
309 "use True/False for constant Boolean expression"),
310 (r'^\s*if False(:| +and)', 'Remove code instead of using `if False`'),
310 (r'^\s*if False(:| +and)', 'Remove code instead of using `if False`'),
311 (r'(?:(?<!def)\s+|\()hasattr\(',
311 (r'(?:(?<!def)\s+|\()hasattr\(',
312 'hasattr(foo, bar) is broken on py2, use util.safehasattr(foo, bar) '
312 'hasattr(foo, bar) is broken on py2, use util.safehasattr(foo, bar) '
313 'instead', r'#.*hasattr-py3-only'),
313 'instead', r'#.*hasattr-py3-only'),
314 (r'opener\([^)]*\).read\(',
314 (r'opener\([^)]*\).read\(',
315 "use opener.read() instead"),
315 "use opener.read() instead"),
316 (r'opener\([^)]*\).write\(',
316 (r'opener\([^)]*\).write\(',
317 "use opener.write() instead"),
317 "use opener.write() instead"),
318 (r'[\s\(](open|file)\([^)]*\)\.read\(',
318 (r'[\s\(](open|file)\([^)]*\)\.read\(',
319 "use util.readfile() instead"),
319 "use util.readfile() instead"),
320 (r'[\s\(](open|file)\([^)]*\)\.write\(',
320 (r'[\s\(](open|file)\([^)]*\)\.write\(',
321 "use util.writefile() instead"),
321 "use util.writefile() instead"),
322 (r'^[\s\(]*(open(er)?|file)\([^)]*\)',
322 (r'^[\s\(]*(open(er)?|file)\([^)]*\)(?!\.close\(\))',
323 "always assign an opened file to a variable, and close it afterwards"),
323 "always assign an opened file to a variable, and close it afterwards"),
324 (r'[\s\(](open|file)\([^)]*\)\.',
324 (r'[\s\(](open|file)\([^)]*\)\.(?!close\(\))',
325 "always assign an opened file to a variable, and close it afterwards"),
325 "always assign an opened file to a variable, and close it afterwards"),
326 (r'(?i)descend[e]nt', "the proper spelling is descendAnt"),
326 (r'(?i)descend[e]nt', "the proper spelling is descendAnt"),
327 (r'\.debug\(\_', "don't mark debug messages for translation"),
327 (r'\.debug\(\_', "don't mark debug messages for translation"),
328 (r'\.strip\(\)\.split\(\)', "no need to strip before splitting"),
328 (r'\.strip\(\)\.split\(\)', "no need to strip before splitting"),
329 (r'^\s*except\s*:', "naked except clause", r'#.*re-raises'),
329 (r'^\s*except\s*:', "naked except clause", r'#.*re-raises'),
330 (r'^\s*except\s([^\(,]+|\([^\)]+\))\s*,',
330 (r'^\s*except\s([^\(,]+|\([^\)]+\))\s*,',
331 'legacy exception syntax; use "as" instead of ","'),
331 'legacy exception syntax; use "as" instead of ","'),
332 (r':\n( )*( ){1,3}[^ ]', "must indent 4 spaces"),
332 (r':\n( )*( ){1,3}[^ ]', "must indent 4 spaces"),
333 (r'release\(.*wlock, .*lock\)', "wrong lock release order"),
333 (r'release\(.*wlock, .*lock\)', "wrong lock release order"),
334 (r'\bdef\s+__bool__\b', "__bool__ should be __nonzero__ in Python 2"),
334 (r'\bdef\s+__bool__\b', "__bool__ should be __nonzero__ in Python 2"),
335 (r'os\.path\.join\(.*, *(""|\'\')\)',
335 (r'os\.path\.join\(.*, *(""|\'\')\)',
336 "use pathutil.normasprefix(path) instead of os.path.join(path, '')"),
336 "use pathutil.normasprefix(path) instead of os.path.join(path, '')"),
337 (r'\s0[0-7]+\b', 'legacy octal syntax; use "0o" prefix instead of "0"'),
337 (r'\s0[0-7]+\b', 'legacy octal syntax; use "0o" prefix instead of "0"'),
338 # XXX only catch mutable arguments on the first line of the definition
338 # XXX only catch mutable arguments on the first line of the definition
339 (r'def.*[( ]\w+=\{\}', "don't use mutable default arguments"),
339 (r'def.*[( ]\w+=\{\}', "don't use mutable default arguments"),
340 (r'\butil\.Abort\b', "directly use error.Abort"),
340 (r'\butil\.Abort\b', "directly use error.Abort"),
341 (r'^@(\w*\.)?cachefunc', "module-level @cachefunc is risky, please avoid"),
341 (r'^@(\w*\.)?cachefunc', "module-level @cachefunc is risky, please avoid"),
342 (r'^import atexit', "don't use atexit, use ui.atexit"),
342 (r'^import atexit', "don't use atexit, use ui.atexit"),
343 (r'^import Queue', "don't use Queue, use util.queue + util.empty"),
343 (r'^import Queue', "don't use Queue, use util.queue + util.empty"),
344 (r'^import cStringIO', "don't use cStringIO.StringIO, use util.stringio"),
344 (r'^import cStringIO', "don't use cStringIO.StringIO, use util.stringio"),
345 (r'^import urllib', "don't use urllib, use util.urlreq/util.urlerr"),
345 (r'^import urllib', "don't use urllib, use util.urlreq/util.urlerr"),
346 (r'^import SocketServer', "don't use SockerServer, use util.socketserver"),
346 (r'^import SocketServer', "don't use SockerServer, use util.socketserver"),
347 (r'^import urlparse', "don't use urlparse, use util.urlreq"),
347 (r'^import urlparse', "don't use urlparse, use util.urlreq"),
348 (r'^import xmlrpclib', "don't use xmlrpclib, use util.xmlrpclib"),
348 (r'^import xmlrpclib', "don't use xmlrpclib, use util.xmlrpclib"),
349 (r'^import cPickle', "don't use cPickle, use util.pickle"),
349 (r'^import cPickle', "don't use cPickle, use util.pickle"),
350 (r'^import pickle', "don't use pickle, use util.pickle"),
350 (r'^import pickle', "don't use pickle, use util.pickle"),
351 (r'^import httplib', "don't use httplib, use util.httplib"),
351 (r'^import httplib', "don't use httplib, use util.httplib"),
352 (r'^import BaseHTTPServer', "use util.httpserver instead"),
352 (r'^import BaseHTTPServer', "use util.httpserver instead"),
353 (r'^(from|import) mercurial\.(cext|pure|cffi)',
353 (r'^(from|import) mercurial\.(cext|pure|cffi)',
354 "use mercurial.policy.importmod instead"),
354 "use mercurial.policy.importmod instead"),
355 (r'\.next\(\)', "don't use .next(), use next(...)"),
355 (r'\.next\(\)', "don't use .next(), use next(...)"),
356 (r'([a-z]*).revision\(\1\.node\(',
356 (r'([a-z]*).revision\(\1\.node\(',
357 "don't convert rev to node before passing to revision(nodeorrev)"),
357 "don't convert rev to node before passing to revision(nodeorrev)"),
358 (r'platform\.system\(\)', "don't use platform.system(), use pycompat"),
358 (r'platform\.system\(\)', "don't use platform.system(), use pycompat"),
359
359
360 # rules depending on implementation of repquote()
360 # rules depending on implementation of repquote()
361 (r' x+[xpqo%APM][\'"]\n\s+[\'"]x',
361 (r' x+[xpqo%APM][\'"]\n\s+[\'"]x',
362 'string join across lines with no space'),
362 'string join across lines with no space'),
363 (r'''(?x)ui\.(status|progress|write|note|warn)\(
363 (r'''(?x)ui\.(status|progress|write|note|warn)\(
364 [ \t\n#]*
364 [ \t\n#]*
365 (?# any strings/comments might precede a string, which
365 (?# any strings/comments might precede a string, which
366 # contains translatable message)
366 # contains translatable message)
367 ((['"]|\'\'\'|""")[ \npq%bAPMxno]*(['"]|\'\'\'|""")[ \t\n#]+)*
367 ((['"]|\'\'\'|""")[ \npq%bAPMxno]*(['"]|\'\'\'|""")[ \t\n#]+)*
368 (?# sequence consisting of below might precede translatable message
368 (?# sequence consisting of below might precede translatable message
369 # - formatting string: "% 10s", "%05d", "% -3.2f", "%*s", "%%" ...
369 # - formatting string: "% 10s", "%05d", "% -3.2f", "%*s", "%%" ...
370 # - escaped character: "\\", "\n", "\0" ...
370 # - escaped character: "\\", "\n", "\0" ...
371 # - character other than '%', 'b' as '\', and 'x' as alphabet)
371 # - character other than '%', 'b' as '\', and 'x' as alphabet)
372 (['"]|\'\'\'|""")
372 (['"]|\'\'\'|""")
373 ((%([ n]?[PM]?([np]+|A))?x)|%%|b[bnx]|[ \nnpqAPMo])*x
373 ((%([ n]?[PM]?([np]+|A))?x)|%%|b[bnx]|[ \nnpqAPMo])*x
374 (?# this regexp can't use [^...] style,
374 (?# this regexp can't use [^...] style,
375 # because _preparepats forcibly adds "\n" into [^...],
375 # because _preparepats forcibly adds "\n" into [^...],
376 # even though this regexp wants match it against "\n")''',
376 # even though this regexp wants match it against "\n")''',
377 "missing _() in ui message (use () to hide false-positives)"),
377 "missing _() in ui message (use () to hide false-positives)"),
378 ],
378 ],
379 # warnings
379 # warnings
380 [
380 [
381 # rules depending on implementation of repquote()
381 # rules depending on implementation of repquote()
382 (r'(^| )pp +xxxxqq[ \n][^\n]', "add two newlines after '.. note::'"),
382 (r'(^| )pp +xxxxqq[ \n][^\n]', "add two newlines after '.. note::'"),
383 ]
383 ]
384 ]
384 ]
385
385
386 pyfilters = [
386 pyfilters = [
387 (r"""(?msx)(?P<comment>\#.*?$)|
387 (r"""(?msx)(?P<comment>\#.*?$)|
388 ((?P<quote>('''|\"\"\"|(?<!')'(?!')|(?<!")"(?!")))
388 ((?P<quote>('''|\"\"\"|(?<!')'(?!')|(?<!")"(?!")))
389 (?P<text>(([^\\]|\\.)*?))
389 (?P<text>(([^\\]|\\.)*?))
390 (?P=quote))""", reppython),
390 (?P=quote))""", reppython),
391 ]
391 ]
392
392
393 # non-filter patterns
393 # non-filter patterns
394 pynfpats = [
394 pynfpats = [
395 [
395 [
396 (r'pycompat\.osname\s*[=!]=\s*[\'"]nt[\'"]', "use pycompat.iswindows"),
396 (r'pycompat\.osname\s*[=!]=\s*[\'"]nt[\'"]', "use pycompat.iswindows"),
397 (r'pycompat\.osname\s*[=!]=\s*[\'"]posix[\'"]', "use pycompat.isposix"),
397 (r'pycompat\.osname\s*[=!]=\s*[\'"]posix[\'"]', "use pycompat.isposix"),
398 (r'pycompat\.sysplatform\s*[!=]=\s*[\'"]darwin[\'"]',
398 (r'pycompat\.sysplatform\s*[!=]=\s*[\'"]darwin[\'"]',
399 "use pycompat.isdarwin"),
399 "use pycompat.isdarwin"),
400 ],
400 ],
401 # warnings
401 # warnings
402 [],
402 [],
403 ]
403 ]
404
404
405 # extension non-filter patterns
405 # extension non-filter patterns
406 pyextnfpats = [
406 pyextnfpats = [
407 [(r'^"""\n?[A-Z]', "don't capitalize docstring title")],
407 [(r'^"""\n?[A-Z]', "don't capitalize docstring title")],
408 # warnings
408 # warnings
409 [],
409 [],
410 ]
410 ]
411
411
412 txtfilters = []
412 txtfilters = []
413
413
414 txtpats = [
414 txtpats = [
415 [
415 [
416 ('\s$', 'trailing whitespace'),
416 ('\s$', 'trailing whitespace'),
417 ('.. note::[ \n][^\n]', 'add two newlines after note::')
417 ('.. note::[ \n][^\n]', 'add two newlines after note::')
418 ],
418 ],
419 []
419 []
420 ]
420 ]
421
421
422 cpats = [
422 cpats = [
423 [
423 [
424 (r'//', "don't use //-style comments"),
424 (r'//', "don't use //-style comments"),
425 (r'\S\t', "don't use tabs except for indent"),
425 (r'\S\t', "don't use tabs except for indent"),
426 (r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),
426 (r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),
427 (r'.{81}', "line too long"),
427 (r'.{81}', "line too long"),
428 (r'(while|if|do|for)\(', "use space after while/if/do/for"),
428 (r'(while|if|do|for)\(', "use space after while/if/do/for"),
429 (r'return\(', "return is not a function"),
429 (r'return\(', "return is not a function"),
430 (r' ;', "no space before ;"),
430 (r' ;', "no space before ;"),
431 (r'[^;] \)', "no space before )"),
431 (r'[^;] \)', "no space before )"),
432 (r'[)][{]', "space between ) and {"),
432 (r'[)][{]', "space between ) and {"),
433 (r'\w+\* \w+', "use int *foo, not int* foo"),
433 (r'\w+\* \w+', "use int *foo, not int* foo"),
434 (r'\W\([^\)]+\) \w+', "use (int)foo, not (int) foo"),
434 (r'\W\([^\)]+\) \w+', "use (int)foo, not (int) foo"),
435 (r'\w+ (\+\+|--)', "use foo++, not foo ++"),
435 (r'\w+ (\+\+|--)', "use foo++, not foo ++"),
436 (r'\w,\w', "missing whitespace after ,"),
436 (r'\w,\w', "missing whitespace after ,"),
437 (r'^[^#]\w[+/*]\w', "missing whitespace in expression"),
437 (r'^[^#]\w[+/*]\w', "missing whitespace in expression"),
438 (r'\w\s=\s\s+\w', "gratuitous whitespace after ="),
438 (r'\w\s=\s\s+\w', "gratuitous whitespace after ="),
439 (r'^#\s+\w', "use #foo, not # foo"),
439 (r'^#\s+\w', "use #foo, not # foo"),
440 (r'[^\n]\Z', "no trailing newline"),
440 (r'[^\n]\Z', "no trailing newline"),
441 (r'^\s*#import\b', "use only #include in standard C code"),
441 (r'^\s*#import\b', "use only #include in standard C code"),
442 (r'strcpy\(', "don't use strcpy, use strlcpy or memcpy"),
442 (r'strcpy\(', "don't use strcpy, use strlcpy or memcpy"),
443 (r'strcat\(', "don't use strcat"),
443 (r'strcat\(', "don't use strcat"),
444
444
445 # rules depending on implementation of repquote()
445 # rules depending on implementation of repquote()
446 ],
446 ],
447 # warnings
447 # warnings
448 [
448 [
449 # rules depending on implementation of repquote()
449 # rules depending on implementation of repquote()
450 ]
450 ]
451 ]
451 ]
452
452
453 cfilters = [
453 cfilters = [
454 (r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment),
454 (r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment),
455 (r'''(?P<quote>(?<!")")(?P<text>([^"]|\\")+)"(?!")''', repquote),
455 (r'''(?P<quote>(?<!")")(?P<text>([^"]|\\")+)"(?!")''', repquote),
456 (r'''(#\s*include\s+<)([^>]+)>''', repinclude),
456 (r'''(#\s*include\s+<)([^>]+)>''', repinclude),
457 (r'(\()([^)]+\))', repcallspaces),
457 (r'(\()([^)]+\))', repcallspaces),
458 ]
458 ]
459
459
460 inutilpats = [
460 inutilpats = [
461 [
461 [
462 (r'\bui\.', "don't use ui in util"),
462 (r'\bui\.', "don't use ui in util"),
463 ],
463 ],
464 # warnings
464 # warnings
465 []
465 []
466 ]
466 ]
467
467
468 inrevlogpats = [
468 inrevlogpats = [
469 [
469 [
470 (r'\brepo\.', "don't use repo in revlog"),
470 (r'\brepo\.', "don't use repo in revlog"),
471 ],
471 ],
472 # warnings
472 # warnings
473 []
473 []
474 ]
474 ]
475
475
476 webtemplatefilters = []
476 webtemplatefilters = []
477
477
478 webtemplatepats = [
478 webtemplatepats = [
479 [],
479 [],
480 [
480 [
481 (r'{desc(\|(?!websub|firstline)[^\|]*)+}',
481 (r'{desc(\|(?!websub|firstline)[^\|]*)+}',
482 'follow desc keyword with either firstline or websub'),
482 'follow desc keyword with either firstline or websub'),
483 ]
483 ]
484 ]
484 ]
485
485
486 allfilesfilters = []
486 allfilesfilters = []
487
487
488 allfilespats = [
488 allfilespats = [
489 [
489 [
490 (r'(http|https)://[a-zA-Z0-9./]*selenic.com/',
490 (r'(http|https)://[a-zA-Z0-9./]*selenic.com/',
491 'use mercurial-scm.org domain URL'),
491 'use mercurial-scm.org domain URL'),
492 (r'mercurial@selenic\.com',
492 (r'mercurial@selenic\.com',
493 'use mercurial-scm.org domain for mercurial ML address'),
493 'use mercurial-scm.org domain for mercurial ML address'),
494 (r'mercurial-devel@selenic\.com',
494 (r'mercurial-devel@selenic\.com',
495 'use mercurial-scm.org domain for mercurial-devel ML address'),
495 'use mercurial-scm.org domain for mercurial-devel ML address'),
496 ],
496 ],
497 # warnings
497 # warnings
498 [],
498 [],
499 ]
499 ]
500
500
501 py3pats = [
501 py3pats = [
502 [
502 [
503 (r'os\.environ', "use encoding.environ instead (py3)", r'#.*re-exports'),
503 (r'os\.environ', "use encoding.environ instead (py3)", r'#.*re-exports'),
504 (r'os\.name', "use pycompat.osname instead (py3)"),
504 (r'os\.name', "use pycompat.osname instead (py3)"),
505 (r'os\.getcwd', "use pycompat.getcwd instead (py3)"),
505 (r'os\.getcwd', "use pycompat.getcwd instead (py3)"),
506 (r'os\.sep', "use pycompat.ossep instead (py3)"),
506 (r'os\.sep', "use pycompat.ossep instead (py3)"),
507 (r'os\.pathsep', "use pycompat.ospathsep instead (py3)"),
507 (r'os\.pathsep', "use pycompat.ospathsep instead (py3)"),
508 (r'os\.altsep', "use pycompat.osaltsep instead (py3)"),
508 (r'os\.altsep', "use pycompat.osaltsep instead (py3)"),
509 (r'sys\.platform', "use pycompat.sysplatform instead (py3)"),
509 (r'sys\.platform', "use pycompat.sysplatform instead (py3)"),
510 (r'getopt\.getopt', "use pycompat.getoptb instead (py3)"),
510 (r'getopt\.getopt', "use pycompat.getoptb instead (py3)"),
511 (r'os\.getenv', "use encoding.environ.get instead"),
511 (r'os\.getenv', "use encoding.environ.get instead"),
512 (r'os\.setenv', "modifying the environ dict is not preferred"),
512 (r'os\.setenv', "modifying the environ dict is not preferred"),
513 ],
513 ],
514 # warnings
514 # warnings
515 [],
515 [],
516 ]
516 ]
517
517
518 checks = [
518 checks = [
519 ('python', r'.*\.(py|cgi)$', r'^#!.*python', pyfilters, pypats),
519 ('python', r'.*\.(py|cgi)$', r'^#!.*python', pyfilters, pypats),
520 ('python', r'.*\.(py|cgi)$', r'^#!.*python', [], pynfpats),
520 ('python', r'.*\.(py|cgi)$', r'^#!.*python', [], pynfpats),
521 ('python', r'.*hgext.*\.py$', '', [], pyextnfpats),
521 ('python', r'.*hgext.*\.py$', '', [], pyextnfpats),
522 ('python 3', r'.*(hgext|mercurial)/(?!demandimport|policy|pycompat).*\.py',
522 ('python 3', r'.*(hgext|mercurial)/(?!demandimport|policy|pycompat).*\.py',
523 '', pyfilters, py3pats),
523 '', pyfilters, py3pats),
524 ('test script', r'(.*/)?test-[^.~]*$', '', testfilters, testpats),
524 ('test script', r'(.*/)?test-[^.~]*$', '', testfilters, testpats),
525 ('c', r'.*\.[ch]$', '', cfilters, cpats),
525 ('c', r'.*\.[ch]$', '', cfilters, cpats),
526 ('unified test', r'.*\.t$', '', utestfilters, utestpats),
526 ('unified test', r'.*\.t$', '', utestfilters, utestpats),
527 ('layering violation repo in revlog', r'mercurial/revlog\.py', '',
527 ('layering violation repo in revlog', r'mercurial/revlog\.py', '',
528 pyfilters, inrevlogpats),
528 pyfilters, inrevlogpats),
529 ('layering violation ui in util', r'mercurial/util\.py', '', pyfilters,
529 ('layering violation ui in util', r'mercurial/util\.py', '', pyfilters,
530 inutilpats),
530 inutilpats),
531 ('txt', r'.*\.txt$', '', txtfilters, txtpats),
531 ('txt', r'.*\.txt$', '', txtfilters, txtpats),
532 ('web template', r'mercurial/templates/.*\.tmpl', '',
532 ('web template', r'mercurial/templates/.*\.tmpl', '',
533 webtemplatefilters, webtemplatepats),
533 webtemplatefilters, webtemplatepats),
534 ('all except for .po', r'.*(?<!\.po)$', '',
534 ('all except for .po', r'.*(?<!\.po)$', '',
535 allfilesfilters, allfilespats),
535 allfilesfilters, allfilespats),
536 ]
536 ]
537
537
538 def _preparepats():
538 def _preparepats():
539 for c in checks:
539 for c in checks:
540 failandwarn = c[-1]
540 failandwarn = c[-1]
541 for pats in failandwarn:
541 for pats in failandwarn:
542 for i, pseq in enumerate(pats):
542 for i, pseq in enumerate(pats):
543 # fix-up regexes for multi-line searches
543 # fix-up regexes for multi-line searches
544 p = pseq[0]
544 p = pseq[0]
545 # \s doesn't match \n
545 # \s doesn't match \n
546 p = re.sub(r'(?<!\\)\\s', r'[ \\t]', p)
546 p = re.sub(r'(?<!\\)\\s', r'[ \\t]', p)
547 # [^...] doesn't match newline
547 # [^...] doesn't match newline
548 p = re.sub(r'(?<!\\)\[\^', r'[^\\n', p)
548 p = re.sub(r'(?<!\\)\[\^', r'[^\\n', p)
549
549
550 pats[i] = (re.compile(p, re.MULTILINE),) + pseq[1:]
550 pats[i] = (re.compile(p, re.MULTILINE),) + pseq[1:]
551 filters = c[3]
551 filters = c[3]
552 for i, flt in enumerate(filters):
552 for i, flt in enumerate(filters):
553 filters[i] = re.compile(flt[0]), flt[1]
553 filters[i] = re.compile(flt[0]), flt[1]
554
554
555 class norepeatlogger(object):
555 class norepeatlogger(object):
556 def __init__(self):
556 def __init__(self):
557 self._lastseen = None
557 self._lastseen = None
558
558
559 def log(self, fname, lineno, line, msg, blame):
559 def log(self, fname, lineno, line, msg, blame):
560 """print error related a to given line of a given file.
560 """print error related a to given line of a given file.
561
561
562 The faulty line will also be printed but only once in the case
562 The faulty line will also be printed but only once in the case
563 of multiple errors.
563 of multiple errors.
564
564
565 :fname: filename
565 :fname: filename
566 :lineno: line number
566 :lineno: line number
567 :line: actual content of the line
567 :line: actual content of the line
568 :msg: error message
568 :msg: error message
569 """
569 """
570 msgid = fname, lineno, line
570 msgid = fname, lineno, line
571 if msgid != self._lastseen:
571 if msgid != self._lastseen:
572 if blame:
572 if blame:
573 print("%s:%d (%s):" % (fname, lineno, blame))
573 print("%s:%d (%s):" % (fname, lineno, blame))
574 else:
574 else:
575 print("%s:%d:" % (fname, lineno))
575 print("%s:%d:" % (fname, lineno))
576 print(" > %s" % line)
576 print(" > %s" % line)
577 self._lastseen = msgid
577 self._lastseen = msgid
578 print(" " + msg)
578 print(" " + msg)
579
579
580 _defaultlogger = norepeatlogger()
580 _defaultlogger = norepeatlogger()
581
581
582 def getblame(f):
582 def getblame(f):
583 lines = []
583 lines = []
584 for l in os.popen('hg annotate -un %s' % f):
584 for l in os.popen('hg annotate -un %s' % f):
585 start, line = l.split(':', 1)
585 start, line = l.split(':', 1)
586 user, rev = start.split()
586 user, rev = start.split()
587 lines.append((line[1:-1], user, rev))
587 lines.append((line[1:-1], user, rev))
588 return lines
588 return lines
589
589
590 def checkfile(f, logfunc=_defaultlogger.log, maxerr=None, warnings=False,
590 def checkfile(f, logfunc=_defaultlogger.log, maxerr=None, warnings=False,
591 blame=False, debug=False, lineno=True):
591 blame=False, debug=False, lineno=True):
592 """checks style and portability of a given file
592 """checks style and portability of a given file
593
593
594 :f: filepath
594 :f: filepath
595 :logfunc: function used to report error
595 :logfunc: function used to report error
596 logfunc(filename, linenumber, linecontent, errormessage)
596 logfunc(filename, linenumber, linecontent, errormessage)
597 :maxerr: number of error to display before aborting.
597 :maxerr: number of error to display before aborting.
598 Set to false (default) to report all errors
598 Set to false (default) to report all errors
599
599
600 return True if no error is found, False otherwise.
600 return True if no error is found, False otherwise.
601 """
601 """
602 blamecache = None
602 blamecache = None
603 result = True
603 result = True
604
604
605 try:
605 try:
606 with opentext(f) as fp:
606 with opentext(f) as fp:
607 try:
607 try:
608 pre = post = fp.read()
608 pre = post = fp.read()
609 except UnicodeDecodeError as e:
609 except UnicodeDecodeError as e:
610 print("%s while reading %s" % (e, f))
610 print("%s while reading %s" % (e, f))
611 return result
611 return result
612 except IOError as e:
612 except IOError as e:
613 print("Skipping %s, %s" % (f, str(e).split(':', 1)[0]))
613 print("Skipping %s, %s" % (f, str(e).split(':', 1)[0]))
614 return result
614 return result
615
615
616 for name, match, magic, filters, pats in checks:
616 for name, match, magic, filters, pats in checks:
617 post = pre # discard filtering result of previous check
617 post = pre # discard filtering result of previous check
618 if debug:
618 if debug:
619 print(name, f)
619 print(name, f)
620 fc = 0
620 fc = 0
621 if not (re.match(match, f) or (magic and re.search(magic, pre))):
621 if not (re.match(match, f) or (magic and re.search(magic, pre))):
622 if debug:
622 if debug:
623 print("Skipping %s for %s it doesn't match %s" % (
623 print("Skipping %s for %s it doesn't match %s" % (
624 name, match, f))
624 name, match, f))
625 continue
625 continue
626 if "no-" "check-code" in pre:
626 if "no-" "check-code" in pre:
627 # If you're looking at this line, it's because a file has:
627 # If you're looking at this line, it's because a file has:
628 # no- check- code
628 # no- check- code
629 # but the reason to output skipping is to make life for
629 # but the reason to output skipping is to make life for
630 # tests easier. So, instead of writing it with a normal
630 # tests easier. So, instead of writing it with a normal
631 # spelling, we write it with the expected spelling from
631 # spelling, we write it with the expected spelling from
632 # tests/test-check-code.t
632 # tests/test-check-code.t
633 print("Skipping %s it has no-che?k-code (glob)" % f)
633 print("Skipping %s it has no-che?k-code (glob)" % f)
634 return "Skip" # skip checking this file
634 return "Skip" # skip checking this file
635 for p, r in filters:
635 for p, r in filters:
636 post = re.sub(p, r, post)
636 post = re.sub(p, r, post)
637 nerrs = len(pats[0]) # nerr elements are errors
637 nerrs = len(pats[0]) # nerr elements are errors
638 if warnings:
638 if warnings:
639 pats = pats[0] + pats[1]
639 pats = pats[0] + pats[1]
640 else:
640 else:
641 pats = pats[0]
641 pats = pats[0]
642 # print post # uncomment to show filtered version
642 # print post # uncomment to show filtered version
643
643
644 if debug:
644 if debug:
645 print("Checking %s for %s" % (name, f))
645 print("Checking %s for %s" % (name, f))
646
646
647 prelines = None
647 prelines = None
648 errors = []
648 errors = []
649 for i, pat in enumerate(pats):
649 for i, pat in enumerate(pats):
650 if len(pat) == 3:
650 if len(pat) == 3:
651 p, msg, ignore = pat
651 p, msg, ignore = pat
652 else:
652 else:
653 p, msg = pat
653 p, msg = pat
654 ignore = None
654 ignore = None
655 if i >= nerrs:
655 if i >= nerrs:
656 msg = "warning: " + msg
656 msg = "warning: " + msg
657
657
658 pos = 0
658 pos = 0
659 n = 0
659 n = 0
660 for m in p.finditer(post):
660 for m in p.finditer(post):
661 if prelines is None:
661 if prelines is None:
662 prelines = pre.splitlines()
662 prelines = pre.splitlines()
663 postlines = post.splitlines(True)
663 postlines = post.splitlines(True)
664
664
665 start = m.start()
665 start = m.start()
666 while n < len(postlines):
666 while n < len(postlines):
667 step = len(postlines[n])
667 step = len(postlines[n])
668 if pos + step > start:
668 if pos + step > start:
669 break
669 break
670 pos += step
670 pos += step
671 n += 1
671 n += 1
672 l = prelines[n]
672 l = prelines[n]
673
673
674 if ignore and re.search(ignore, l, re.MULTILINE):
674 if ignore and re.search(ignore, l, re.MULTILINE):
675 if debug:
675 if debug:
676 print("Skipping %s for %s:%s (ignore pattern)" % (
676 print("Skipping %s for %s:%s (ignore pattern)" % (
677 name, f, n))
677 name, f, n))
678 continue
678 continue
679 bd = ""
679 bd = ""
680 if blame:
680 if blame:
681 bd = 'working directory'
681 bd = 'working directory'
682 if not blamecache:
682 if not blamecache:
683 blamecache = getblame(f)
683 blamecache = getblame(f)
684 if n < len(blamecache):
684 if n < len(blamecache):
685 bl, bu, br = blamecache[n]
685 bl, bu, br = blamecache[n]
686 if bl == l:
686 if bl == l:
687 bd = '%s@%s' % (bu, br)
687 bd = '%s@%s' % (bu, br)
688
688
689 errors.append((f, lineno and n + 1, l, msg, bd))
689 errors.append((f, lineno and n + 1, l, msg, bd))
690 result = False
690 result = False
691
691
692 errors.sort()
692 errors.sort()
693 for e in errors:
693 for e in errors:
694 logfunc(*e)
694 logfunc(*e)
695 fc += 1
695 fc += 1
696 if maxerr and fc >= maxerr:
696 if maxerr and fc >= maxerr:
697 print(" (too many errors, giving up)")
697 print(" (too many errors, giving up)")
698 break
698 break
699
699
700 return result
700 return result
701
701
702 def main():
702 def main():
703 parser = optparse.OptionParser("%prog [options] [files | -]")
703 parser = optparse.OptionParser("%prog [options] [files | -]")
704 parser.add_option("-w", "--warnings", action="store_true",
704 parser.add_option("-w", "--warnings", action="store_true",
705 help="include warning-level checks")
705 help="include warning-level checks")
706 parser.add_option("-p", "--per-file", type="int",
706 parser.add_option("-p", "--per-file", type="int",
707 help="max warnings per file")
707 help="max warnings per file")
708 parser.add_option("-b", "--blame", action="store_true",
708 parser.add_option("-b", "--blame", action="store_true",
709 help="use annotate to generate blame info")
709 help="use annotate to generate blame info")
710 parser.add_option("", "--debug", action="store_true",
710 parser.add_option("", "--debug", action="store_true",
711 help="show debug information")
711 help="show debug information")
712 parser.add_option("", "--nolineno", action="store_false",
712 parser.add_option("", "--nolineno", action="store_false",
713 dest='lineno', help="don't show line numbers")
713 dest='lineno', help="don't show line numbers")
714
714
715 parser.set_defaults(per_file=15, warnings=False, blame=False, debug=False,
715 parser.set_defaults(per_file=15, warnings=False, blame=False, debug=False,
716 lineno=True)
716 lineno=True)
717 (options, args) = parser.parse_args()
717 (options, args) = parser.parse_args()
718
718
719 if len(args) == 0:
719 if len(args) == 0:
720 check = glob.glob("*")
720 check = glob.glob("*")
721 elif args == ['-']:
721 elif args == ['-']:
722 # read file list from stdin
722 # read file list from stdin
723 check = sys.stdin.read().splitlines()
723 check = sys.stdin.read().splitlines()
724 else:
724 else:
725 check = args
725 check = args
726
726
727 _preparepats()
727 _preparepats()
728
728
729 ret = 0
729 ret = 0
730 for f in check:
730 for f in check:
731 if not checkfile(f, maxerr=options.per_file, warnings=options.warnings,
731 if not checkfile(f, maxerr=options.per_file, warnings=options.warnings,
732 blame=options.blame, debug=options.debug,
732 blame=options.blame, debug=options.debug,
733 lineno=options.lineno):
733 lineno=options.lineno):
734 ret = 1
734 ret = 1
735 return ret
735 return ret
736
736
737 if __name__ == "__main__":
737 if __name__ == "__main__":
738 sys.exit(main())
738 sys.exit(main())
General Comments 0
You need to be logged in to leave comments. Login now