upstream/mercurial-mirror Commit - r25140:317333e0

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

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

10

"""style and portability checker for Mercurial

10

"""style and portability checker for Mercurial

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, # no-py24)

17

(you can append a short comment and match this, like: #re-raises, # no-py24)

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

22

import re, glob, os, sys

22

import re, glob, os, sys

23

import keyword

23

import keyword

24

import optparse

24

import optparse

25

try:

25

try:

26

import re2

26

import re2

27

except ImportError:

27

except ImportError:

28

re2 = None

28

re2 = None

29

30

def compilere(pat, multiline=False):

30

def compilere(pat, multiline=False):

31

if multiline:

31

if multiline:

32

pat = '(?m)' + pat

32

pat = '(?m)' + pat

33

if re2:

33

if re2:

34

try:

34

try:

35

return re2.compile(pat)

35

return re2.compile(pat)

36

except re2.error:

36

except re2.error:

37

pass

37

pass

38

return re.compile(pat)

38

return re.compile(pat)

39

40

def repquote(m):

40

def repquote(m):

41

fromc = '.:'

41

fromc = '.:'

42

tochr = 'pq'

42

tochr = 'pq'

43

def encodechr(i):

43

def encodechr(i):

44

if i > 255:

44

if i > 255:

45

return 'u'

45

return 'u'

46

c = chr(i)

46

c = chr(i)

47

if c in ' \n':

47

if c in ' \n':

48

return c

48

return c

49

if c.isalpha():

49

if c.isalpha():

50

return 'x'

50

return 'x'

51

if c.isdigit():

51

if c.isdigit():

52

return 'n'

52

return 'n'

53

try:

53

try:

54

return tochr[fromc.find(c)]

54

return tochr[fromc.find(c)]

55

except (ValueError, IndexError):

55

except (ValueError, IndexError):

56

return 'o'

56

return 'o'

57

t = m.group('text')

57

t = m.group('text')

58

tt = ''.join(encodechr(i) for i in xrange(256))

58

tt = ''.join(encodechr(i) for i in xrange(256))

59

t = t.translate(tt)

59

t = t.translate(tt)

60

return m.group('quote') + t + m.group('quote')

60

return m.group('quote') + t + m.group('quote')

61

62

def reppython(m):

62

def reppython(m):

63

comment = m.group('comment')

63

comment = m.group('comment')

64

if comment:

64

if comment:

65

l = len(comment.rstrip())

65

l = len(comment.rstrip())

66

return "#" * l + comment[l:]

66

return "#" * l + comment[l:]

67

return repquote(m)

67

return repquote(m)

68

69

def repcomment(m):

69

def repcomment(m):

70

return m.group(1) + "#" * len(m.group(2))

70

return m.group(1) + "#" * len(m.group(2))

71

72

def repccomment(m):

72

def repccomment(m):

73

t = re.sub(r"((?<=\n) )|\S", "x", m.group(2))

73

t = re.sub(r"((?<=\n) )|\S", "x", m.group(2))

74

return m.group(1) + t + "*/"

74

return m.group(1) + t + "*/"

75

76

def repcallspaces(m):

76

def repcallspaces(m):

77

t = re.sub(r"\n\s+", "\n", m.group(2))

77

t = re.sub(r"\n\s+", "\n", m.group(2))

78

return m.group(1) + t

78

return m.group(1) + t

79

80

def repinclude(m):

80

def repinclude(m):

81

return m.group(1) + "<foo>"

81

return m.group(1) + "<foo>"

82

83

def rephere(m):

83

def rephere(m):

84

t = re.sub(r"\S", "x", m.group(2))

84

t = re.sub(r"\S", "x", m.group(2))

85

return m.group(1) + t

85

return m.group(1) + t

86

87

88

testpats = [

88

testpats = [

89

[

89

[

90

(r'pushd|popd', "don't use 'pushd' or 'popd', use 'cd'"),

90

(r'pushd|popd', "don't use 'pushd' or 'popd', use 'cd'"),

91

(r'\W\$?$\([^$\n]*\)\)', "don't use (()) or $(()), use 'expr'"),

91

(r'\W\$?$\([^$\n]*\)\)', "don't use (()) or $(()), use 'expr'"),

92

(r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"),

92

(r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"),

93

(r'(?<!hg )grep.*-a', "don't use 'grep -a', use in-line python"),

93

(r'(?<!hg )grep.*-a', "don't use 'grep -a', use in-line python"),

94

(r'sed.*-i', "don't use 'sed -i', use a temporary file"),

94

(r'sed.*-i', "don't use 'sed -i', use a temporary file"),

95

(r'\becho\b.*\\n', "don't use 'echo \\n', use printf"),

95

(r'\becho\b.*\\n', "don't use 'echo \\n', use printf"),

96

(r'echo -n', "don't use 'echo -n', use printf"),

96

(r'echo -n', "don't use 'echo -n', use printf"),

97

(r'(^|\|\s*)\bwc\b[^|]*$\n(?!.*$re$)', "filter wc output"),

97

(r'(^|\|\s*)\bwc\b[^|]*$\n(?!.*$re$)', "filter wc output"),

98

(r'head -c', "don't use 'head -c', use 'dd'"),

98

(r'head -c', "don't use 'head -c', use 'dd'"),

99

(r'tail -n', "don't use the '-n' option to tail, just use '-<num>'"),

99

(r'tail -n', "don't use the '-n' option to tail, just use '-<num>'"),

100

(r'sha1sum', "don't use sha1sum, use $TESTDIR/md5sum.py"),

100

(r'sha1sum', "don't use sha1sum, use $TESTDIR/md5sum.py"),

101

(r'ls.*-\w*R', "don't use 'ls -R', use 'find'"),

101

(r'ls.*-\w*R', "don't use 'ls -R', use 'find'"),

102

(r'printf.*[^\\]\\([1-9]|0\d)', "don't use 'printf \NNN', use Python"),

102

(r'printf.*[^\\]\\([1-9]|0\d)', "don't use 'printf \NNN', use Python"),

103

(r'printf.*[^\\]\\x', "don't use printf \\x, use Python"),

103

(r'printf.*[^\\]\\x', "don't use printf \\x, use Python"),

104

(r'\$$.*$', "don't use $(expr), use `expr`"),

104

(r'\$$.*$', "don't use $(expr), use `expr`"),

105

(r'rm -rf \*', "don't use naked rm -rf, target a directory"),

105

(r'rm -rf \*', "don't use naked rm -rf, target a directory"),

106

(r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w',

106

(r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w',

107

"use egrep for extended grep syntax"),

107

"use egrep for extended grep syntax"),

108

(r'/bin/', "don't use explicit paths for tools"),

108

(r'/bin/', "don't use explicit paths for tools"),

109

(r'[^\n]\Z', "no trailing newline"),

109

(r'[^\n]\Z', "no trailing newline"),

110

(r'export.*=', "don't export and assign at once"),

110

(r'export.*=', "don't export and assign at once"),

111

(r'^source\b', "don't use 'source', use '.'"),

111

(r'^source\b', "don't use 'source', use '.'"),

112

(r'touch -d', "don't use 'touch -d', use 'touch -t' instead"),

112

(r'touch -d', "don't use 'touch -d', use 'touch -t' instead"),

113

(r'ls +[^|\n-]+ +-', "options to 'ls' must come before filenames"),

113

(r'ls +[^|\n-]+ +-', "options to 'ls' must come before filenames"),

114

(r'[^>\n]>\s*\$HGRCPATH', "don't overwrite $HGRCPATH, append to it"),

114

(r'[^>\n]>\s*\$HGRCPATH', "don't overwrite $HGRCPATH, append to it"),

115

(r'^stop', "don't use 'stop' as a shell function name"),

115

(r'^stop', "don't use 'stop' as a shell function name"),

116

(r'(\[|\btest\b).*-e ', "don't use 'test -e', use 'test -f'"),

116

(r'(\[|\btest\b).*-e ', "don't use 'test -e', use 'test -f'"),

117

(r'^alias\b.*=', "don't use alias, use a function"),

117

(r'^alias\b.*=', "don't use alias, use a function"),

118

(r'if\s*!', "don't use '!' to negate exit status"),

118

(r'if\s*!', "don't use '!' to negate exit status"),

119

(r'/dev/u?random', "don't use entropy, use /dev/zero"),

119

(r'/dev/u?random', "don't use entropy, use /dev/zero"),

120

(r'do\s*true;\s*done', "don't use true as loop body, use sleep 0"),

120

(r'do\s*true;\s*done', "don't use true as loop body, use sleep 0"),

121

(r'^( *)\t', "don't use tabs to indent"),

121

(r'^( *)\t', "don't use tabs to indent"),

122

(r'sed (-e )?\'(\d+|/[^/]*/)i(?!\\\n)',

122

(r'sed (-e )?\'(\d+|/[^/]*/)i(?!\\\n)',

123

"put a backslash-escaped newline after sed 'i' command"),

123

"put a backslash-escaped newline after sed 'i' command"),

124

(r'^diff *-\w*u.*$\n(^ \$ |^$)', "prefix diff -u with cmp"),

124

(r'^diff *-\w*u.*$\n(^ \$ |^$)', "prefix diff -u with cmp"),

125

(r'seq ', "don't use 'seq', use $TESTDIR/seq.py")

125

(r'seq ', "don't use 'seq', use $TESTDIR/seq.py")

126

],

126

],

127

# warnings

127

# warnings

128

[

128

[

129

(r'^function', "don't use 'function', use old style"),

129

(r'^function', "don't use 'function', use old style"),

130

(r'^diff.*-\w*N', "don't use 'diff -N'"),

130

(r'^diff.*-\w*N', "don't use 'diff -N'"),

131

(r'\$PWD|\${PWD}', "don't use $PWD, use `pwd`"),

131

(r'\$PWD|\${PWD}', "don't use $PWD, use `pwd`"),

132

(r'^([^"\'\n]|("[^"\n]*")|(\'[^\'\n]*\'))*\^', "^ must be quoted"),

132

(r'^([^"\'\n]|("[^"\n]*")|(\'[^\'\n]*\'))*\^', "^ must be quoted"),

133

(r'kill (`|\$\()', "don't use kill, use killdaemons.py")

133

(r'kill (`|\$\()', "don't use kill, use killdaemons.py")

134

]

134

]

135

]

135

]

136

137

testfilters = [

137

testfilters = [

138

(r"( *)(#([^\n]*\S)?)", repcomment),

138

(r"( *)(#([^\n]*\S)?)", repcomment),

139

(r"<<(\S+)((.|\n)*?\n\1)", rephere),

139

(r"<<(\S+)((.|\n)*?\n\1)", rephere),

140

]

140

]

141

142

winglobmsg = "use (glob) to match Windows paths too"

142

winglobmsg = "use (glob) to match Windows paths too"

143

uprefix = r"^ \$ "

143

uprefix = r"^ \$ "

144

utestpats = [

144

utestpats = [

145

[

145

[

146

(r'^(\S.*|| [$>] .*)[ \t]\n', "trailing whitespace on non-output"),

146

(r'^(\S.*|| [$>] .*)[ \t]\n', "trailing whitespace on non-output"),

147

(uprefix + r'.*\|\s*sed[^|>\n]*\n',

147

(uprefix + r'.*\|\s*sed[^|>\n]*\n',

148

"use regex test output patterns instead of sed"),

148

"use regex test output patterns instead of sed"),

149

(uprefix + r'(true|exit 0)', "explicit zero exit unnecessary"),

149

(uprefix + r'(true|exit 0)', "explicit zero exit unnecessary"),

150

(uprefix + r'.*(?<!\[)\$\?', "explicit exit code checks unnecessary"),

150

(uprefix + r'.*(?<!\[)\$\?', "explicit exit code checks unnecessary"),

151

(uprefix + r'.*\|\| echo.*(fail|error)',

151

(uprefix + r'.*\|\| echo.*(fail|error)',

152

"explicit exit code checks unnecessary"),

152

"explicit exit code checks unnecessary"),

153

(uprefix + r'set -e', "don't use set -e"),

153

(uprefix + r'set -e', "don't use set -e"),

154

(uprefix + r'(\s|fi\b|done\b)', "use > for continued lines"),

154

(uprefix + r'(\s|fi\b|done\b)', "use > for continued lines"),

155

(uprefix + r'.*:\.\S*/', "x:.y in a path does not work on msys, rewrite "

155

(uprefix + r'.*:\.\S*/', "x:.y in a path does not work on msys, rewrite "

156

"as x://.y, or see `hg log -k msys` for alternatives", r'-\S+:\.|' #-Rxxx

156

"as x://.y, or see `hg log -k msys` for alternatives", r'-\S+:\.|' #-Rxxx

157

'# no-msys'), # in test-pull.t which is skipped on windows

157

'# no-msys'), # in test-pull.t which is skipped on windows

158

(r'^ saved backup bundle to \$TESTTMP.*\.hg$', winglobmsg),

158

(r'^ saved backup bundle to \$TESTTMP.*\.hg$', winglobmsg),

159

(r'^ changeset .* references (corrupted|missing) \$TESTTMP/.*[^)]$',

159

(r'^ changeset .* references (corrupted|missing) \$TESTTMP/.*[^)]$',

160

winglobmsg),

160

winglobmsg),

161

(r'^ pulling from \$TESTTMP/.*[^)]$', winglobmsg,

161

(r'^ pulling from \$TESTTMP/.*[^)]$', winglobmsg,

162

'\$TESTTMP/unix-repo$'), # in test-issue1802.t which skipped on windows

162

'\$TESTTMP/unix-repo$'), # in test-issue1802.t which skipped on windows

163

(r'^ reverting (?!subrepo ).*/.*[^)]$', winglobmsg),

163

(r'^ reverting (?!subrepo ).*/.*[^)]$', winglobmsg),

164

(r'^ cloning subrepo \S+/.*[^)]$', winglobmsg),

164

(r'^ cloning subrepo \S+/.*[^)]$', winglobmsg),

165

(r'^ pushing to \$TESTTMP/.*[^)]$', winglobmsg),

165

(r'^ pushing to \$TESTTMP/.*[^)]$', winglobmsg),

166

(r'^ pushing subrepo \S+/\S+ to.*[^)]$', winglobmsg),

166

(r'^ pushing subrepo \S+/\S+ to.*[^)]$', winglobmsg),

167

(r'^ moving \S+/.*[^)]$', winglobmsg),

167

(r'^ moving \S+/.*[^)]$', winglobmsg),

168

(r'^ no changes made to subrepo since.*/.*[^)]$', winglobmsg),

168

(r'^ no changes made to subrepo since.*/.*[^)]$', winglobmsg),

169

(r'^ .*: largefile \S+ not available from file:.*/.*[^)]$', winglobmsg),

169

(r'^ .*: largefile \S+ not available from file:.*/.*[^)]$', winglobmsg),

170

(r'^ .*file://\$TESTTMP',

170

(r'^ .*file://\$TESTTMP',

171

'write "file:/*/$TESTTMP" + (glob) to match on windows too'),

171

'write "file:/*/$TESTTMP" + (glob) to match on windows too'),

172

(r'^ (cat|find): .*: No such file or directory',

172

(r'^ (cat|find): .*: No such file or directory',

173

'use test -f to test for file existence'),

173

'use test -f to test for file existence'),

174

],

174

],

175

# warnings

175

# warnings

176

[

176

[

177

(r'^ [^*?/\n]* $glob$$',

177

(r'^ [^*?/\n]* $glob$$',

178

"glob match with no glob character (?*/)"),

178

"glob match with no glob character (?*/)"),

179

]

179

]

180

]

180

]

181

182

for i in [0, 1]:

182

for i in [0, 1]:

183

for tp in testpats[i]:

183

for tp in testpats[i]:

184

p = tp[0]

184

p = tp[0]

185

m = tp[1]

185

m = tp[1]

186

if p.startswith(r'^'):

186

if p.startswith(r'^'):

187

p = r"^ [$>] (%s)" % p[1:]

187

p = r"^ [$>] (%s)" % p[1:]

188

else:

188

else:

189

p = r"^ [$>] .*(%s)" % p

189

p = r"^ [$>] .*(%s)" % p

190

utestpats[i].append((p, m) + tp[2:])

190

utestpats[i].append((p, m) + tp[2:])

191

192

utestfilters = [

192

utestfilters = [

193

(r"<<(\S+)((.|\n)*?\n > \1)", rephere),

193

(r"<<(\S+)((.|\n)*?\n > \1)", rephere),

194

(r"( *)(#([^\n]*\S)?)", repcomment),

194

(r"( *)(#([^\n]*\S)?)", repcomment),

195

]

195

]

196

197

pypats = [

197

pypats = [

198

[

198

[

199

(r'\([^)]*\*\w[^()]+\w+=', "can't pass varargs with keyword in Py2.5"),

199

(r'\([^)]*\*\w[^()]+\w+=', "can't pass varargs with keyword in Py2.5"),

200

(r'^\s*def\s*\w+\s*\(.*,\s*\(',

200

(r'^\s*def\s*\w+\s*\(.*,\s*\(',

201

"tuple parameter unpacking not available in Python 3+"),

201

"tuple parameter unpacking not available in Python 3+"),

202

(r'lambda\s*$.*,.*$',

202

(r'lambda\s*$.*,.*$',

203

"tuple parameter unpacking not available in Python 3+"),

203

"tuple parameter unpacking not available in Python 3+"),

204

(r'import (.+,[^.]+\.[^.]+|[^.]+\.[^.]+,)',

204

(r'import (.+,[^.]+\.[^.]+|[^.]+\.[^.]+,)',

205

'2to3 can\'t always rewrite "import qux, foo.bar", '

205

'2to3 can\'t always rewrite "import qux, foo.bar", '

206

'use "import foo.bar" on its own line instead.'),

206

'use "import foo.bar" on its own line instead.'),

207

(r'(?<!def)\s+(cmp)\(', "cmp is not available in Python 3+"),

207

(r'(?<!def)\s+(cmp)\(', "cmp is not available in Python 3+"),

208

(r'\breduce\s*\(.*', "reduce is not available in Python 3+"),

208

(r'\breduce\s*\(.*', "reduce is not available in Python 3+"),

209

(r'dict\(.*=', 'dict() is different in Py2 and 3 and is slower than {}',

209

(r'dict\(.*=', 'dict() is different in Py2 and 3 and is slower than {}',

210

'dict-from-generator'),

210

'dict-from-generator'),

211

(r'\.has_key\b', "dict.has_key is not available in Python 3+"),

211

(r'\.has_key\b', "dict.has_key is not available in Python 3+"),

212

(r'\s<>\s', '<> operator is not available in Python 3+, use !='),

212

(r'\s<>\s', '<> operator is not available in Python 3+, use !='),

213

(r'^\s*\t', "don't use tabs"),

213

(r'^\s*\t', "don't use tabs"),

214

(r'\S;\s*\n', "semicolon"),

214

(r'\S;\s*\n', "semicolon"),

215

(r'[^_]_\([ \t\n]*(?:"[^"]+"[ \t\n+]*)+%', "don't use % inside _()"),

215

(r'[^_]_\([ \t\n]*(?:"[^"]+"[ \t\n+]*)+%', "don't use % inside _()"),

216

(r"[^_]_\([ \t\n]*(?:'[^']+'[ \t\n+]*)+%", "don't use % inside _()"),

216

(r"[^_]_\([ \t\n]*(?:'[^']+'[ \t\n+]*)+%", "don't use % inside _()"),

217

(r'(\w|\)),\w', "missing whitespace after ,"),

217

(r'(\w|\)),\w', "missing whitespace after ,"),

218

(r'(\w|\))[+/*\-<>]\w', "missing whitespace in expression"),

218

(r'(\w|\))[+/*\-<>]\w', "missing whitespace in expression"),

219

(r'^\s+(\w|\.)+=\w[^,()\n]*$', "missing whitespace in assignment"),

219

(r'^\s+(\w|\.)+=\w[^,()\n]*$', "missing whitespace in assignment"),

220

(r'(?<!def)(\s+|^|$)next\(.+$',

220

(r'(?<!def)(\s+|^|$)next\(.+$',

221

'no next(foo) in Python 2.4 and 2.5, use foo.next() instead'),

221

'no next(foo) in Python 2.4 and 2.5, use foo.next() instead'),

222

(r'(\s+)try:\n((?:\n|\1\s.*\n)*?)\1\s*yield\b.*?'

222

(r'(\s+)try:\n((?:\n|\1\s.*\n)*?)\1\s*yield\b.*?'

223

r'((?:\n|\1\s.*\n)+?)\1finally:',

223

r'((?:\n|\1\s.*\n)+?)\1finally:',

224

'no yield inside try/finally in Python 2.4'),

224

'no yield inside try/finally in Python 2.4'),

225

(r'.{81}', "line too long"),

225

(r'.{81}', "line too long"),

226

(r' x+[xo][\'"]\n\s+[\'"]x', 'string join across lines with no space'),

226

(r' x+[xo][\'"]\n\s+[\'"]x', 'string join across lines with no space'),

227

(r'[^\n]\Z', "no trailing newline"),

227

(r'[^\n]\Z', "no trailing newline"),

228

(r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),

228

(r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),

229

# (r'^\s+[^_ \n][^_. \n]+_[^_\n]+\s*=',

229

# (r'^\s+[^_ \n][^_. \n]+_[^_\n]+\s*=',

230

# "don't use underbars in identifiers"),

230

# "don't use underbars in identifiers"),

231

(r'^\s+(self\.)?[A-za-z][a-z0-9]+[A-Z]\w* = ',

231

(r'^\s+(self\.)?[A-za-z][a-z0-9]+[A-Z]\w* = ',

232

"don't use camelcase in identifiers"),

232

"don't use camelcase in identifiers"),

233

233

234

"linebreak after :"),

234

"linebreak after :"),

235

(r'class\s[^( \n]+:', "old-style class, use class foo(object)"),

235

(r'class\s[^( \n]+:', "old-style class, use class foo(object)"),

236

(r'class\s[^( \n]+:',

236

(r'class\s[^( \n]+:',

237

"class foo() ~~not available in Python 2.4~~, use class foo(object)"),

237

"class foo() creates old style object, use class foo(object)"),

238

(r'\b(%s)\(' % '|'.join(k for k in keyword.kwlist

238

(r'\b(%s)\(' % '|'.join(k for k in keyword.kwlist

239

if k not in ('print', 'exec')),

239

if k not in ('print', 'exec')),

240

"Python keyword is not a function"),

240

"Python keyword is not a function"),

241

(r',]', "unneeded trailing ',' in list"),

241

(r',]', "unneeded trailing ',' in list"),

242

# (r'class\s[A-Z][^\(]*\((?!Exception)',

242

# (r'class\s[A-Z][^\(]*\((?!Exception)',

243

# "don't capitalize non-exception classes"),

243

# "don't capitalize non-exception classes"),

244

# (r'in range\(', "use xrange"),

244

# (r'in range\(', "use xrange"),

245

# (r'^\s*print\s+', "avoid using print in core and extensions"),

245

# (r'^\s*print\s+', "avoid using print in core and extensions"),

246

(r'[\x80-\xff]', "non-ASCII character literal"),

246

(r'[\x80-\xff]', "non-ASCII character literal"),

247

(r'("\')\.format\(', "str.format() not available in Python 2.4"),

247

(r'("\')\.format\(', "str.format() not available in Python 2.4"),

248

(r'\.isdisjoint\(', "set.isdisjoint not available in Python 2.4"),

248

(r'\.isdisjoint\(', "set.isdisjoint not available in Python 2.4"),

249

(r'(?<!def)\s+(any|all|format)\(',

249

(r'(?<!def)\s+(any|all|format)\(',

250

"any/all/format not available in Python 2.4", 'no-py24'),

250

"any/all/format not available in Python 2.4", 'no-py24'),

251

(r'if\s.*\selse', "if ... else form not available in Python 2.4"),

251

(r'if\s.*\selse', "if ... else form not available in Python 2.4"),

252

(r'^\s*(%s)\s\s' % '|'.join(keyword.kwlist),

252

(r'^\s*(%s)\s\s' % '|'.join(keyword.kwlist),

253

"gratuitous whitespace after Python keyword"),

253

"gratuitous whitespace after Python keyword"),

254

(r'([$\[][ \t]\S)|(\S[ \t][$\]])', "gratuitous whitespace in () or []"),

254

(r'([$\[][ \t]\S)|(\S[ \t][$\]])', "gratuitous whitespace in () or []"),

255

# (r'\s\s=', "gratuitous whitespace before ="),

255

# (r'\s\s=', "gratuitous whitespace before ="),

256

(r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',

256

(r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',

257

"missing whitespace around operator"),

257

"missing whitespace around operator"),

258

(r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\s',

258

(r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\s',

259

"missing whitespace around operator"),

259

"missing whitespace around operator"),

260

(r'\s(\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',

260

(r'\s(\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',

261

"missing whitespace around operator"),

261

"missing whitespace around operator"),

262

(r'[^^+=*/!<>&| %-](\s=|=\s)[^= ]',

262

(r'[^^+=*/!<>&| %-](\s=|=\s)[^= ]',

263

"wrong whitespace around ="),

263

"wrong whitespace around ="),

264

(r'\([^()]*( =[^=]|[^<>!=]= )',

264

(r'\([^()]*( =[^=]|[^<>!=]= )',

265

"no whitespace around = for named parameters"),

265

"no whitespace around = for named parameters"),

266

(r'raise Exception', "don't raise generic exceptions"),

266

(r'raise Exception', "don't raise generic exceptions"),

267

(r'raise [^,(]+, ($[^$]+\)|[^,]+)$',

267

(r'raise [^,(]+, ($[^$]+\)|[^,]+)$',

268

"don't use old-style two-argument raise, use Exception(message)"),

268

"don't use old-style two-argument raise, use Exception(message)"),

269

(r' is\s+(not\s+)?["\'0-9-]', "object comparison with literal"),

269

(r' is\s+(not\s+)?["\'0-9-]', "object comparison with literal"),

270

(r' [=!]=\s+(True|False|None)',

270

(r' [=!]=\s+(True|False|None)',

271

"comparison with singleton, use 'is' or 'is not' instead"),

271

"comparison with singleton, use 'is' or 'is not' instead"),

272

(r'^\s*(while|if) [01]:',

272

(r'^\s*(while|if) [01]:',

273

"use True/False for constant Boolean expression"),

273

"use True/False for constant Boolean expression"),

274

(r'(?:(?<!def)\s+|\()hasattr',

274

(r'(?:(?<!def)\s+|\()hasattr',

275

'hasattr(foo, bar) is broken, use util.safehasattr(foo, bar) instead'),

275

'hasattr(foo, bar) is broken, use util.safehasattr(foo, bar) instead'),

276

(r'opener$[^)]*$.read\(',

276

(r'opener$[^)]*$.read\(',

277

"use opener.read() instead"),

277

"use opener.read() instead"),

278

(r'BaseException', 'not in Python 2.4, use Exception'),

278

(r'BaseException', 'not in Python 2.4, use Exception'),

279

(r'opener$[^)]*$.write\(',

279

(r'opener$[^)]*$.write\(',

280

"use opener.write() instead"),

280

"use opener.write() instead"),

281

(r'[\s$](open|file)\([^)]*$\.read\(',

281

(r'[\s$](open|file)\([^)]*$\.read\(',

282

"use util.readfile() instead"),

282

"use util.readfile() instead"),

283

(r'[\s$](open|file)\([^)]*$\.write\(',

283

(r'[\s$](open|file)\([^)]*$\.write\(',

284

"use util.writefile() instead"),

284

"use util.writefile() instead"),

285

(r'^[\s$]*(open(er)?|file)\([^)]*$',

285

(r'^[\s$]*(open(er)?|file)\([^)]*$',

286

"always assign an opened file to a variable, and close it afterwards"),

286

"always assign an opened file to a variable, and close it afterwards"),

287

(r'[\s$](open|file)\([^)]*$\.',

287

(r'[\s$](open|file)\([^)]*$\.',

288

"always assign an opened file to a variable, and close it afterwards"),

288

"always assign an opened file to a variable, and close it afterwards"),

289

(r'(?i)descend[e]nt', "the proper spelling is descendAnt"),

289

(r'(?i)descend[e]nt', "the proper spelling is descendAnt"),

290

(r'\.debug\(\_', "don't mark debug messages for translation"),

290

(r'\.debug\(\_', "don't mark debug messages for translation"),

291

(r'\.strip\.split', "no need to strip before splitting"),

291

(r'\.strip\.split', "no need to strip before splitting"),

292

(r'^\s*except\s*:', "naked except clause", r'#.*re-raises'),

292

(r'^\s*except\s*:', "naked except clause", r'#.*re-raises'),

293

(r':\n( )*( ){1,3}[^ ]', "must indent 4 spaces"),

293

(r':\n( )*( ){1,3}[^ ]', "must indent 4 spaces"),

294

(r'ui\.(status|progress|write|note|warn)\([\'\"]x',

294

(r'ui\.(status|progress|write|note|warn)\([\'\"]x',

295

"missing _() in ui message (use () to hide false-positives)"),

295

"missing _() in ui message (use () to hide false-positives)"),

296

(r'release$.*wlock, .*lock$', "wrong lock release order"),

296

(r'release$.*wlock, .*lock$', "wrong lock release order"),

297

(r'\b__bool__\b', "__bool__ should be __nonzero__ in Python 2"),

297

(r'\b__bool__\b', "__bool__ should be __nonzero__ in Python 2"),

298

(r'os\.path\.join$.*, *(""|\'\')$',

298

(r'os\.path\.join$.*, *(""|\'\')$',

299

"use pathutil.normasprefix(path) instead of os.path.join(path, '')"),

299

"use pathutil.normasprefix(path) instead of os.path.join(path, '')"),

300

],

300

],

301

# warnings

301

# warnings

302

[

302

[

303

(r'(^| )pp +xxxxqq[ \n][^\n]', "add two newlines after '.. note::'"),

303

(r'(^| )pp +xxxxqq[ \n][^\n]', "add two newlines after '.. note::'"),

304

]

304

]

305

]

305

]

306

307

pyfilters = [

307

pyfilters = [

308

(r"""(?msx)(?P<comment>\#.*?$)|

308

(r"""(?msx)(?P<comment>\#.*?$)|

309

((?P<quote>('''|\"\"\"|(?<!')'(?!')|(?<!")"(?!")))

309

((?P<quote>('''|\"\"\"|(?<!')'(?!')|(?<!")"(?!")))

310

(?P<text>(([^\\]|\\.)*?))

310

(?P<text>(([^\\]|\\.)*?))

311

(?P=quote))""", reppython),

311

(?P=quote))""", reppython),

312

]

312

]

313

314

txtfilters = []

314

txtfilters = []

315

316

txtpats = [

316

txtpats = [

317

[

317

[

318

('\s$', 'trailing whitespace'),

318

('\s$', 'trailing whitespace'),

319

('.. note::[ \n][^\n]', 'add two newlines after note::')

319

('.. note::[ \n][^\n]', 'add two newlines after note::')

320

],

320

],

321

[]

321

[]

322

]

322

]

323

324

cpats = [

324

cpats = [

325

[

325

[

326

(r'//', "don't use //-style comments"),

326

(r'//', "don't use //-style comments"),

327

(r'^ ', "don't use spaces to indent"),

327

(r'^ ', "don't use spaces to indent"),

328

(r'\S\t', "don't use tabs except for indent"),

328

(r'\S\t', "don't use tabs except for indent"),

329

(r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),

329

(r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),

330

(r'.{81}', "line too long"),

330

(r'.{81}', "line too long"),

331

(r'(while|if|do|for)\(', "use space after while/if/do/for"),

331

(r'(while|if|do|for)\(', "use space after while/if/do/for"),

332

(r'return\(', "return is not a function"),

332

(r'return\(', "return is not a function"),

333

(r' ;', "no space before ;"),

333

(r' ;', "no space before ;"),

334

(r'[^;] \)', "no space before )"),

334

(r'[^;] \)', "no space before )"),

335

(r'[)][{]', "space between ) and {"),

335

(r'[)][{]', "space between ) and {"),

336

(r'\w+\* \w+', "use int *foo, not int* foo"),

336

(r'\w+\* \w+', "use int *foo, not int* foo"),

337

(r'\W$[^$]+\) \w+', "use (int)foo, not (int) foo"),

337

(r'\W$[^$]+\) \w+', "use (int)foo, not (int) foo"),

338

(r'\w+ (\+\+|--)', "use foo++, not foo ++"),

338

(r'\w+ (\+\+|--)', "use foo++, not foo ++"),

339

(r'\w,\w', "missing whitespace after ,"),

339

(r'\w,\w', "missing whitespace after ,"),

340

(r'^[^#]\w[+/*]\w', "missing whitespace in expression"),

340

(r'^[^#]\w[+/*]\w', "missing whitespace in expression"),

341

(r'^#\s+\w', "use #foo, not # foo"),

341

(r'^#\s+\w', "use #foo, not # foo"),

342

(r'[^\n]\Z', "no trailing newline"),

342

(r'[^\n]\Z', "no trailing newline"),

343

(r'^\s*#import\b', "use only #include in standard C code"),

343

(r'^\s*#import\b', "use only #include in standard C code"),

344

],

344

],

345

# warnings

345

# warnings

346

[]

346

[]

347

]

347

]

348

349

cfilters = [

349

cfilters = [

350

(r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment),

350

(r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment),

351

(r'''(?P<quote>(?<!")")(?P<text>([^"]|\\")+)"(?!")''', repquote),

351

(r'''(?P<quote>(?<!")")(?P<text>([^"]|\\")+)"(?!")''', repquote),

352

(r'''(#\s*include\s+<)([^>]+)>''', repinclude),

352

(r'''(#\s*include\s+<)([^>]+)>''', repinclude),

353

(r'($)([^)]+$)', repcallspaces),

353

(r'($)([^)]+$)', repcallspaces),

354

]

354

]

355

356

inutilpats = [

356

inutilpats = [

357

[

357

[

358

(r'\bui\.', "don't use ui in util"),

358

(r'\bui\.', "don't use ui in util"),

359

],

359

],

360

# warnings

360

# warnings

361

[]

361

[]

362

]

362

]

363

364

inrevlogpats = [

364

inrevlogpats = [

365

[

365

[

366

(r'\brepo\.', "don't use repo in revlog"),

366

(r'\brepo\.', "don't use repo in revlog"),

367

],

367

],

368

# warnings

368

# warnings

369

[]

369

[]

370

]

370

]

371

372

webtemplatefilters = []

372

webtemplatefilters = []

373

374

webtemplatepats = [

374

webtemplatepats = [

375

[],

375

[],

376

[

376

[

377

(r'{desc(\|(?!websub|firstline)[^\|]*)+}',

377

(r'{desc(\|(?!websub|firstline)[^\|]*)+}',

378

'follow desc keyword with either firstline or websub'),

378

'follow desc keyword with either firstline or websub'),

379

]

379

]

380

]

380

]

381

382

checks = [

382

checks = [

383

('python', r'.*\.(py|cgi)$', r'^#!.*python', pyfilters, pypats),

383

('python', r'.*\.(py|cgi)$', r'^#!.*python', pyfilters, pypats),

384

('test script', r'(.*/)?test-[^.~]*$', '', testfilters, testpats),

384

('test script', r'(.*/)?test-[^.~]*$', '', testfilters, testpats),

385

('c', r'.*\.[ch]$', '', cfilters, cpats),

385

('c', r'.*\.[ch]$', '', cfilters, cpats),

386

('unified test', r'.*\.t$', '', utestfilters, utestpats),

386

('unified test', r'.*\.t$', '', utestfilters, utestpats),

387

('layering violation repo in revlog', r'mercurial/revlog\.py', '',

387

('layering violation repo in revlog', r'mercurial/revlog\.py', '',

388

pyfilters, inrevlogpats),

388

pyfilters, inrevlogpats),

389

('layering violation ui in util', r'mercurial/util\.py', '', pyfilters,

389

('layering violation ui in util', r'mercurial/util\.py', '', pyfilters,

390

inutilpats),

390

inutilpats),

391

('txt', r'.*\.txt$', '', txtfilters, txtpats),

391

('txt', r'.*\.txt$', '', txtfilters, txtpats),

392

('web template', r'mercurial/templates/.*\.tmpl', '',

392

('web template', r'mercurial/templates/.*\.tmpl', '',

393

webtemplatefilters, webtemplatepats),

393

webtemplatefilters, webtemplatepats),

394

]

394

]

395

396

def _preparepats():

396

def _preparepats():

397

for c in checks:

397

for c in checks:

398

failandwarn = c[-1]

398

failandwarn = c[-1]

399

for pats in failandwarn:

399

for pats in failandwarn:

400

for i, pseq in enumerate(pats):

400

for i, pseq in enumerate(pats):

401

# fix-up regexes for multi-line searches

401

# fix-up regexes for multi-line searches

402

p = pseq[0]

402

p = pseq[0]

403

# \s doesn't match \n

403

# \s doesn't match \n

404

p = re.sub(r'(?<!\\)\\s', r'[ \\t]', p)

404

p = re.sub(r'(?<!\\)\\s', r'[ \\t]', p)

405

# [^...] doesn't match newline

405

# [^...] doesn't match newline

406

p = re.sub(r'(?<!\\)\[\^', r'[^\\n', p)

406

p = re.sub(r'(?<!\\)\[\^', r'[^\\n', p)

407

408

pats[i] = (re.compile(p, re.MULTILINE),) + pseq[1:]

408

pats[i] = (re.compile(p, re.MULTILINE),) + pseq[1:]

409

filters = c[3]

409

filters = c[3]

410

for i, flt in enumerate(filters):

410

for i, flt in enumerate(filters):

411

filters[i] = re.compile(flt[0]), flt[1]

411

filters[i] = re.compile(flt[0]), flt[1]

412

_preparepats()

412

_preparepats()

413

414

class norepeatlogger(object):

414

class norepeatlogger(object):

415

def __init__(self):

415

def __init__(self):

416

self._lastseen = None

416

self._lastseen = None

417

418

def log(self, fname, lineno, line, msg, blame):

418

def log(self, fname, lineno, line, msg, blame):

419

"""print error related a to given line of a given file.

419

"""print error related a to given line of a given file.

420

421

The faulty line will also be printed but only once in the case

421

The faulty line will also be printed but only once in the case

422

of multiple errors.

422

of multiple errors.

423

424

:fname: filename

424

:fname: filename

425

:lineno: line number

425

:lineno: line number

426

:line: actual content of the line

426

:line: actual content of the line

427

:msg: error message

427

:msg: error message

428

"""

428

"""

429

msgid = fname, lineno, line

429

msgid = fname, lineno, line

430

if msgid != self._lastseen:

430

if msgid != self._lastseen:

431

if blame:

431

if blame:

432

print "%s:%d (%s):" % (fname, lineno, blame)

432

print "%s:%d (%s):" % (fname, lineno, blame)

433

else:

433

else:

434

print "%s:%d:" % (fname, lineno)

434

print "%s:%d:" % (fname, lineno)

435

print " > %s" % line

435

print " > %s" % line

436

self._lastseen = msgid

436

self._lastseen = msgid

437

print " " + msg

437

print " " + msg

438

439

_defaultlogger = norepeatlogger()

439

_defaultlogger = norepeatlogger()

440

441

def getblame(f):

441

def getblame(f):

442

lines = []

442

lines = []

443

for l in os.popen('hg annotate -un %s' % f):

443

for l in os.popen('hg annotate -un %s' % f):

444

start, line = l.split(':', 1)

444

start, line = l.split(':', 1)

445

user, rev = start.split()

445

user, rev = start.split()

446

lines.append((line[1:-1], user, rev))

446

lines.append((line[1:-1], user, rev))

447

return lines

447

return lines

448

449

def checkfile(f, logfunc=_defaultlogger.log, maxerr=None, warnings=False,

449

def checkfile(f, logfunc=_defaultlogger.log, maxerr=None, warnings=False,

450

blame=False, debug=False, lineno=True):

450

blame=False, debug=False, lineno=True):

451

"""checks style and portability of a given file

451

"""checks style and portability of a given file

452

453

:f: filepath

453

:f: filepath

454

:logfunc: function used to report error

454

:logfunc: function used to report error

455

logfunc(filename, linenumber, linecontent, errormessage)

455

logfunc(filename, linenumber, linecontent, errormessage)

456

:maxerr: number of error to display before aborting.

456

:maxerr: number of error to display before aborting.

457

Set to false (default) to report all errors

457

Set to false (default) to report all errors

458

459

return True if no error is found, False otherwise.

459

return True if no error is found, False otherwise.

460

"""

460

"""

461

blamecache = None

461

blamecache = None

462

result = True

462

result = True

463

464

try:

464

try:

465

fp = open(f)

465

fp = open(f)

466

except IOError, e:

466

except IOError, e:

467

print "Skipping %s, %s" % (f, str(e).split(':', 1)[0])

467

print "Skipping %s, %s" % (f, str(e).split(':', 1)[0])

468

return result

468

return result

469

pre = post = fp.read()

469

pre = post = fp.read()

470

fp.close()

470

fp.close()

471

472

for name, match, magic, filters, pats in checks:

472

for name, match, magic, filters, pats in checks:

473

if debug:

473

if debug:

474

print name, f

474

print name, f

475

fc = 0

475

fc = 0

476

if not (re.match(match, f) or (magic and re.search(magic, f))):

476

if not (re.match(match, f) or (magic and re.search(magic, f))):

477

if debug:

477

if debug:

478

print "Skipping %s for %s it doesn't match %s" % (

478

print "Skipping %s for %s it doesn't match %s" % (

479

name, match, f)

479

name, match, f)

480

continue

480

continue

481

if "no-" "check-code" in pre:

481

if "no-" "check-code" in pre:

482

print "Skipping %s it has no-" "check-code" % f

482

print "Skipping %s it has no-" "check-code" % f

483

return "Skip" # skip checking this file

483

return "Skip" # skip checking this file

484

for p, r in filters:

484

for p, r in filters:

485

post = re.sub(p, r, post)

485

post = re.sub(p, r, post)

486

nerrs = len(pats[0]) # nerr elements are errors

486

nerrs = len(pats[0]) # nerr elements are errors

487

if warnings:

487

if warnings:

488

pats = pats[0] + pats[1]

488

pats = pats[0] + pats[1]

489

else:

489

else:

490

pats = pats[0]

490

pats = pats[0]

491

# print post # uncomment to show filtered version

491

# print post # uncomment to show filtered version

492

493

if debug:

493

if debug:

494

print "Checking %s for %s" % (name, f)

494

print "Checking %s for %s" % (name, f)

495

496

prelines = None

496

prelines = None

497

errors = []

497

errors = []

498

for i, pat in enumerate(pats):

498

for i, pat in enumerate(pats):

499

if len(pat) == 3:

499

if len(pat) == 3:

500

p, msg, ignore = pat

500

p, msg, ignore = pat

501

else:

501

else:

502

p, msg = pat

502

p, msg = pat

503

ignore = None

503

ignore = None

504

if i >= nerrs:

504

if i >= nerrs:

505

msg = "warning: " + msg

505

msg = "warning: " + msg

506

507

pos = 0

507

pos = 0

508

n = 0

508

n = 0

509

for m in p.finditer(post):

509

for m in p.finditer(post):

510

if prelines is None:

510

if prelines is None:

511

prelines = pre.splitlines()

511

prelines = pre.splitlines()

512

postlines = post.splitlines(True)

512

postlines = post.splitlines(True)

513

514

start = m.start()

514

start = m.start()

515

while n < len(postlines):

515

while n < len(postlines):

516

step = len(postlines[n])

516

step = len(postlines[n])

517

if pos + step > start:

517

if pos + step > start:

518

break

518

break

519

pos += step

519

pos += step

520

n += 1

520

n += 1

521

l = prelines[n]

521

l = prelines[n]

522

523

if ignore and re.search(ignore, l, re.MULTILINE):

523

if ignore and re.search(ignore, l, re.MULTILINE):

524

if debug:

524

if debug:

525

print "Skipping %s for %s:%s (ignore pattern)" % (

525

print "Skipping %s for %s:%s (ignore pattern)" % (

526

name, f, n)

526

name, f, n)

527

continue

527

continue

528

bd = ""

528

bd = ""

529

if blame:

529

if blame:

530

bd = 'working directory'

530

bd = 'working directory'

531

if not blamecache:

531

if not blamecache:

532

blamecache = getblame(f)

532

blamecache = getblame(f)

533

if n < len(blamecache):

533

if n < len(blamecache):

534

bl, bu, br = blamecache[n]

534

bl, bu, br = blamecache[n]

535

if bl == l:

535

if bl == l:

536

bd = '%s@%s' % (bu, br)

536

bd = '%s@%s' % (bu, br)

537

538

errors.append((f, lineno and n + 1, l, msg, bd))

538

errors.append((f, lineno and n + 1, l, msg, bd))

539

result = False

539

result = False

540

541

errors.sort()

541

errors.sort()

542

for e in errors:

542

for e in errors:

543

logfunc(*e)

543

logfunc(*e)

544

fc += 1

544

fc += 1

545

if maxerr and fc >= maxerr:

545

if maxerr and fc >= maxerr:

546

print " (too many errors, giving up)"

546

print " (too many errors, giving up)"

547

break

547

break

548

549

return result

549

return result

550

551

if __name__ == "__main__":

551

if __name__ == "__main__":

552

parser = optparse.OptionParser("%prog [options] [files]")

552

parser = optparse.OptionParser("%prog [options] [files]")

553

parser.add_option("-w", "--warnings", action="store_true",

553

parser.add_option("-w", "--warnings", action="store_true",

554

help="include warning-level checks")

554

help="include warning-level checks")

555

parser.add_option("-p", "--per-file", type="int",

555

parser.add_option("-p", "--per-file", type="int",

556

help="max warnings per file")

556

help="max warnings per file")

557

parser.add_option("-b", "--blame", action="store_true",

557

parser.add_option("-b", "--blame", action="store_true",

558

help="use annotate to generate blame info")

558

help="use annotate to generate blame info")

559

parser.add_option("", "--debug", action="store_true",

559

parser.add_option("", "--debug", action="store_true",

560

help="show debug information")

560

help="show debug information")

561

parser.add_option("", "--nolineno", action="store_false",

561

parser.add_option("", "--nolineno", action="store_false",

562

dest='lineno', help="don't show line numbers")

562

dest='lineno', help="don't show line numbers")

563

564

parser.set_defaults(per_file=15, warnings=False, blame=False, debug=False,

564

parser.set_defaults(per_file=15, warnings=False, blame=False, debug=False,

565

lineno=True)

565

lineno=True)

566

(options, args) = parser.parse_args()

566

(options, args) = parser.parse_args()

567

568

if len(args) == 0:

568

if len(args) == 0:

569

check = glob.glob("*")

569

check = glob.glob("*")

570

else:

570

else:

571

check = args

571

check = args

572

573

ret = 0

573

ret = 0

574

for f in check:

574

for f in check:

575

if not checkfile(f, maxerr=options.per_file, warnings=options.warnings,

575

if not checkfile(f, maxerr=options.per_file, warnings=options.warnings,

576

blame=options.blame, debug=options.debug,

576

blame=options.blame, debug=options.debug,

577

lineno=options.lineno):

577

lineno=options.lineno):

578

ret = 1

578

ret = 1

579

sys.exit(ret)

579

sys.exit(ret)

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages

             #!/usr/bin/env python
             #
             # check-code - a style and portability checker for Mercurial
             #
             # Copyright 2010 Matt Mackall <mpm@selenic.com>
             #
             # This software may be used and distributed according to the terms of the
             # GNU General Public License version 2 or any later version.
             """style and portability checker for Mercurial
             when a rule triggers wrong, do one of the following (prefer one from top):
              * do the work-around the rule suggests
              * doublecheck that it is a false match
              * improve the rule pattern
              * add an ignore pattern to the rule (3rd arg) which matches your good line
                (you can append a short comment and match this, like: #re-raises, # no-py24)
              * change the pattern to a warning and list the exception in test-check-code-hg
              * ONLY use no--check-code for skipping entire files from external sources
             """
             import re, glob, os, sys
             import keyword
             import optparse
             try:
                 import re2
             except ImportError:
                 re2 = None
             def compilere(pat, multiline=False):
                 if multiline:
                     pat = '(?m)' + pat
                 if re2:
                     try:
                         return re2.compile(pat)
                     except re2.error:
                         pass
                 return re.compile(pat)
             def repquote(m):
                 fromc = '.:'
                 tochr = 'pq'
                 def encodechr(i):
                     if i > 255:
                         return 'u'
                     c = chr(i)
                     if c in ' \n':
                         return c
                     if c.isalpha():
                         return 'x'
                     if c.isdigit():
                         return 'n'
                     try:
                         return tochr[fromc.find(c)]
                     except (ValueError, IndexError):
                         return 'o'
                 t = m.group('text')
                 tt = ''.join(encodechr(i) for i in xrange(256))
                 t = t.translate(tt)
                 return m.group('quote') + t + m.group('quote')
             def reppython(m):
                 comment = m.group('comment')
                 if comment:
                     l = len(comment.rstrip())
                     return "#" * l + comment[l:]
                 return repquote(m)
             def repcomment(m):
                 return m.group(1) + "#" * len(m.group(2))
             def repccomment(m):
                 t = re.sub(r"((?<=\n) )|\S", "x", m.group(2))
                 return m.group(1) + t + "*/"
             def repcallspaces(m):
                 t = re.sub(r"\n\s+", "\n", m.group(2))
                 return m.group(1) + t
             def repinclude(m):
                 return m.group(1) + "<foo>"
             def rephere(m):
                 t = re.sub(r"\S", "x", m.group(2))
                 return m.group(1) + t
             testpats = [
               [
                 (r'pushd|popd', "don't use 'pushd' or 'popd', use 'cd'"),
                 (r'\W\$?\(\([^\)\n]*\)\)', "don't use (()) or $(()), use 'expr'"),
                 (r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"),
                 (r'(?<!hg )grep.*-a', "don't use 'grep -a', use in-line python"),
                 (r'sed.*-i', "don't use 'sed -i', use a temporary file"),
                 (r'\becho\b.*\\n', "don't use 'echo \\n', use printf"),
                 (r'echo -n', "don't use 'echo -n', use printf"),
                 (r'(^|\|\s*)\bwc\b[^|]*$\n(?!.*\(re\))', "filter wc output"),
                 (r'head -c', "don't use 'head -c', use 'dd'"),
                 (r'tail -n', "don't use the '-n' option to tail, just use '-<num>'"),
                 (r'sha1sum', "don't use sha1sum, use $TESTDIR/md5sum.py"),
                 (r'ls.*-\w*R', "don't use 'ls -R', use 'find'"),
                 (r'printf.*[^\\]\\([1-9]|0\d)', "don't use 'printf \NNN', use Python"),
                 (r'printf.*[^\\]\\x', "don't use printf \\x, use Python"),
                 (r'\$\(.*\)', "don't use $(expr), use `expr`"),
                 (r'rm -rf \*', "don't use naked rm -rf, target a directory"),
                 (r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w',
                  "use egrep for extended grep syntax"),
                 (r'/bin/', "don't use explicit paths for tools"),
                 (r'[^\n]\Z', "no trailing newline"),
                 (r'export.*=', "don't export and assign at once"),
                 (r'^source\b', "don't use 'source', use '.'"),
                 (r'touch -d', "don't use 'touch -d', use 'touch -t' instead"),
                 (r'ls +[^|\n-]+ +-', "options to 'ls' must come before filenames"),
                 (r'[^>\n]>\s*\$HGRCPATH', "don't overwrite $HGRCPATH, append to it"),
                 (r'^stop\(\)', "don't use 'stop' as a shell function name"),
                 (r'(\[|\btest\b).*-e ', "don't use 'test -e', use 'test -f'"),
                 (r'^alias\b.*=', "don't use alias, use a function"),
                 (r'if\s*!', "don't use '!' to negate exit status"),
                 (r'/dev/u?random', "don't use entropy, use /dev/zero"),
                 (r'do\s*true;\s*done', "don't use true as loop body, use sleep 0"),
                 (r'^( *)\t', "don't use tabs to indent"),
                 (r'sed (-e )?\'(\d+|/[^/]*/)i(?!\\\n)',
                  "put a backslash-escaped newline after sed 'i' command"),
                 (r'^diff *-\w*u.*$\n(^  \$ |^$)', "prefix diff -u with cmp"),
                 (r'seq ', "don't use 'seq', use $TESTDIR/seq.py")
               ],
               # warnings
               [
                 (r'^function', "don't use 'function', use old style"),
                 (r'^diff.*-\w*N', "don't use 'diff -N'"),
                 (r'\$PWD|\${PWD}', "don't use $PWD, use `pwd`"),
                 (r'^([^"\'\n]|("[^"\n]*")|(\'[^\'\n]*\'))*\^', "^ must be quoted"),
                 (r'kill (`|\$\()', "don't use kill, use killdaemons.py")
               ]
             ]
             testfilters = [
                 (r"( *)(#([^\n]*\S)?)", repcomment),
                 (r"<<(\S+)((.|\n)*?\n\1)", rephere),
             ]
             winglobmsg = "use (glob) to match Windows paths too"
             uprefix = r"^  \$ "
             utestpats = [
               [
                 (r'^(\S.*||  [$>] .*)[ \t]\n', "trailing whitespace on non-output"),
                 (uprefix + r'.*\|\s*sed[^|>\n]*\n',
                  "use regex test output patterns instead of sed"),
                 (uprefix + r'(true|exit 0)', "explicit zero exit unnecessary"),
                 (uprefix + r'.*(?<!\[)\$\?', "explicit exit code checks unnecessary"),
                 (uprefix + r'.*\|\| echo.*(fail|error)',
                  "explicit exit code checks unnecessary"),
                 (uprefix + r'set -e', "don't use set -e"),
                 (uprefix + r'(\s|fi\b|done\b)', "use > for continued lines"),
                 (uprefix + r'.*:\.\S*/', "x:.y in a path does not work on msys, rewrite "
                  "as x://.y, or see `hg log -k msys` for alternatives", r'-\S+:\.|' #-Rxxx
                  '# no-msys'), # in test-pull.t which is skipped on windows
                 (r'^  saved backup bundle to \$TESTTMP.*\.hg$', winglobmsg),
                 (r'^  changeset .* references (corrupted|missing) \$TESTTMP/.*[^)]$',
                  winglobmsg),
                 (r'^  pulling from \$TESTTMP/.*[^)]$', winglobmsg,
                  '\$TESTTMP/unix-repo$'), # in test-issue1802.t which skipped on windows
                 (r'^  reverting (?!subrepo ).*/.*[^)]$', winglobmsg),
                 (r'^  cloning subrepo \S+/.*[^)]$', winglobmsg),
                 (r'^  pushing to \$TESTTMP/.*[^)]$', winglobmsg),
                 (r'^  pushing subrepo \S+/\S+ to.*[^)]$', winglobmsg),
                 (r'^  moving \S+/.*[^)]$', winglobmsg),
                 (r'^  no changes made to subrepo since.*/.*[^)]$', winglobmsg),
                 (r'^  .*: largefile \S+ not available from file:.*/.*[^)]$', winglobmsg),
                 (r'^  .*file://\$TESTTMP',
                  'write "file:/*/$TESTTMP" + (glob) to match on windows too'),
                 (r'^  (cat|find): .*: No such file or directory',
                  'use test -f to test for file existence'),
               ],
               # warnings
               [
                 (r'^  [^*?/\n]* \(glob\)$',
                  "glob match with no glob character (?*/)"),
               ]
             ]
             for i in [0, 1]:
                 for tp in testpats[i]:
                     p = tp[0]
                     m = tp[1]
                     if p.startswith(r'^'):
                         p = r"^  [$>] (%s)" % p[1:]
                     else:
                         p = r"^  [$>] .*(%s)" % p
                     utestpats[i].append((p, m) + tp[2:])
             utestfilters = [
                 (r"<<(\S+)((.|\n)*?\n  > \1)", rephere),
                 (r"( *)(#([^\n]*\S)?)", repcomment),
             ]
             pypats = [
               [
                 (r'\([^)]*\*\w[^()]+\w+=', "can't pass varargs with keyword in Py2.5"),
                 (r'^\s*def\s*\w+\s*\(.*,\s*\(',
                  "tuple parameter unpacking not available in Python 3+"),
                 (r'lambda\s*\(.*,.*\)',
                  "tuple parameter unpacking not available in Python 3+"),
                 (r'import (.+,[^.]+\.[^.]+|[^.]+\.[^.]+,)',
                  '2to3 can\'t always rewrite "import qux, foo.bar", '
                  'use "import foo.bar" on its own line instead.'),
                 (r'(?<!def)\s+(cmp)\(', "cmp is not available in Python 3+"),
                 (r'\breduce\s*\(.*', "reduce is not available in Python 3+"),
                 (r'dict\(.*=', 'dict() is different in Py2 and 3 and is slower than {}',
                  'dict-from-generator'),
                 (r'\.has_key\b', "dict.has_key is not available in Python 3+"),
                 (r'\s<>\s', '<> operator is not available in Python 3+, use !='),
                 (r'^\s*\t', "don't use tabs"),
                 (r'\S;\s*\n', "semicolon"),
                 (r'[^_]_\([ \t\n]*(?:"[^"]+"[ \t\n+]*)+%', "don't use % inside _()"),
                 (r"[^_]_\([ \t\n]*(?:'[^']+'[ \t\n+]*)+%", "don't use % inside _()"),
                 (r'(\w|\)),\w', "missing whitespace after ,"),
                 (r'(\w|\))[+/*\-<>]\w', "missing whitespace in expression"),
                 (r'^\s+(\w|\.)+=\w[^,()\n]*$', "missing whitespace in assignment"),
                 (r'(?<!def)(\s+|^|\()next\(.+\)',
                  'no next(foo) in Python 2.4 and 2.5, use foo.next() instead'),
                 (r'(\s+)try:\n((?:\n|\1\s.*\n)*?)\1\s*yield\b.*?'
                  r'((?:\n|\1\s.*\n)+?)\1finally:',
                  'no yield inside try/finally in Python 2.4'),
                 (r'.{81}', "line too long"),
                 (r' x+[xo][\'"]\n\s+[\'"]x', 'string join across lines with no space'),
                 (r'[^\n]\Z', "no trailing newline"),
                 (r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),
             #    (r'^\s+[^_ \n][^_. \n]+_[^_\n]+\s*=',
             #     "don't use underbars in identifiers"),
                 (r'^\s+(self\.)?[A-za-z][a-z0-9]+[A-Z]\w* = ',
                  "don't use camelcase in identifiers"),
                 (r'^\s*(if|while|def|class|except|try)\s[^[\n]*:\s*[^\\n]#\s]+',
                  "linebreak after :"),
                 (r'class\s[^( \n]+:', "old-style class, use class foo(object)"),
                 (r'class\s[^( \n]+\(\):',
-                 "class foo() not available in Python 2.4, use class foo(object)"),
+                 "class foo() creates old style object, use class foo(object)"),
                 (r'\b(%s)\(' % '|'.join(k for k in keyword.kwlist
                                         if k not in ('print', 'exec')),
                  "Python keyword is not a function"),
                 (r',]', "unneeded trailing ',' in list"),
             #    (r'class\s[A-Z][^\(]*\((?!Exception)',
             #     "don't capitalize non-exception classes"),
             #    (r'in range\(', "use xrange"),
             #    (r'^\s*print\s+', "avoid using print in core and extensions"),
                 (r'[\x80-\xff]', "non-ASCII character literal"),
                 (r'("\')\.format\(', "str.format() not available in Python 2.4"),
                 (r'\.isdisjoint\(', "set.isdisjoint not available in Python 2.4"),
                 (r'(?<!def)\s+(any|all|format)\(',
                  "any/all/format not available in Python 2.4", 'no-py24'),
                 (r'if\s.*\selse', "if ... else form not available in Python 2.4"),
                 (r'^\s*(%s)\s\s' % '|'.join(keyword.kwlist),
                  "gratuitous whitespace after Python keyword"),
                 (r'([\(\[][ \t]\S)|(\S[ \t][\)\]])', "gratuitous whitespace in () or []"),
             #    (r'\s\s=', "gratuitous whitespace before ="),
                 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',
                  "missing whitespace around operator"),
                 (r'[^>< ](\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\s',
                  "missing whitespace around operator"),
                 (r'\s(\+=|-=|!=|<>|<=|>=|<<=|>>=|%=)\S',
                  "missing whitespace around operator"),
                 (r'[^^+=*/!<>&| %-](\s=|=\s)[^= ]',
                  "wrong whitespace around ="),
                 (r'\([^()]*( =[^=]|[^<>!=]= )',
                  "no whitespace around = for named parameters"),
                 (r'raise Exception', "don't raise generic exceptions"),
                 (r'raise [^,(]+, (\([^\)]+\)|[^,\(\)]+)$',
                  "don't use old-style two-argument raise, use Exception(message)"),
                 (r' is\s+(not\s+)?["\'0-9-]', "object comparison with literal"),
                 (r' [=!]=\s+(True|False|None)',
                  "comparison with singleton, use 'is' or 'is not' instead"),
                 (r'^\s*(while|if) [01]:',
                  "use True/False for constant Boolean expression"),
                 (r'(?:(?<!def)\s+|\()hasattr',
                  'hasattr(foo, bar) is broken, use util.safehasattr(foo, bar) instead'),
                 (r'opener\([^)]*\).read\(',
                  "use opener.read() instead"),
                 (r'BaseException', 'not in Python 2.4, use Exception'),
                 (r'opener\([^)]*\).write\(',
                  "use opener.write() instead"),
                 (r'[\s\(](open|file)\([^)]*\)\.read\(',
                  "use util.readfile() instead"),
                 (r'[\s\(](open|file)\([^)]*\)\.write\(',
                  "use util.writefile() instead"),
                 (r'^[\s\(]*(open(er)?|file)\([^)]*\)',
                  "always assign an opened file to a variable, and close it afterwards"),
                 (r'[\s\(](open|file)\([^)]*\)\.',
                  "always assign an opened file to a variable, and close it afterwards"),
                 (r'(?i)descend[e]nt', "the proper spelling is descendAnt"),
                 (r'\.debug\(\_', "don't mark debug messages for translation"),
                 (r'\.strip\(\)\.split\(\)', "no need to strip before splitting"),
                 (r'^\s*except\s*:', "naked except clause", r'#.*re-raises'),
                 (r':\n(    )*( ){1,3}[^ ]', "must indent 4 spaces"),
                 (r'ui\.(status|progress|write|note|warn)\([\'\"]x',
                  "missing _() in ui message (use () to hide false-positives)"),
                 (r'release\(.*wlock, .*lock\)', "wrong lock release order"),
                 (r'\b__bool__\b', "__bool__ should be __nonzero__ in Python 2"),
                 (r'os\.path\.join\(.*, *(""|\'\')\)',
                  "use pathutil.normasprefix(path) instead of os.path.join(path, '')"),
               ],
               # warnings
               [
                 (r'(^| )pp +xxxxqq[ \n][^\n]', "add two newlines after '.. note::'"),
               ]
             ]
             pyfilters = [
                 (r"""(?msx)(?P<comment>\#.*?$)|
                      ((?P<quote>('''|\"\"\"|(?<!')'(?!')|(?<!")"(?!")))
                       (?P<text>(([^\\]|\\.)*?))
                       (?P=quote))""", reppython),
             ]
             txtfilters = []
             txtpats = [
               [
                 ('\s$', 'trailing whitespace'),
                 ('.. note::[ \n][^\n]', 'add two newlines after note::')
               ],
               []
             ]
             cpats = [
               [
                 (r'//', "don't use //-style comments"),
                 (r'^  ', "don't use spaces to indent"),
                 (r'\S\t', "don't use tabs except for indent"),
                 (r'(\S[ \t]+|^[ \t]+)\n', "trailing whitespace"),
                 (r'.{81}', "line too long"),
                 (r'(while|if|do|for)\(', "use space after while/if/do/for"),
                 (r'return\(', "return is not a function"),
                 (r' ;', "no space before ;"),
                 (r'[^;] \)', "no space before )"),
                 (r'[)][{]', "space between ) and {"),
                 (r'\w+\* \w+', "use int *foo, not int* foo"),
                 (r'\W\([^\)]+\) \w+', "use (int)foo, not (int) foo"),
                 (r'\w+ (\+\+|--)', "use foo++, not foo ++"),
                 (r'\w,\w', "missing whitespace after ,"),
                 (r'^[^#]\w[+/*]\w', "missing whitespace in expression"),
                 (r'^#\s+\w', "use #foo, not # foo"),
                 (r'[^\n]\Z', "no trailing newline"),
                 (r'^\s*#import\b', "use only #include in standard C code"),
               ],
               # warnings
               []
             ]
             cfilters = [
                 (r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment),
                 (r'''(?P<quote>(?<!")")(?P<text>([^"]|\\")+)"(?!")''', repquote),
                 (r'''(#\s*include\s+<)([^>]+)>''', repinclude),
                 (r'(\()([^)]+\))', repcallspaces),
             ]
             inutilpats = [
               [
                 (r'\bui\.', "don't use ui in util"),
               ],
               # warnings
               []
             ]
             inrevlogpats = [
               [
                 (r'\brepo\.', "don't use repo in revlog"),
               ],
               # warnings
               []
             ]
             webtemplatefilters = []
             webtemplatepats = [
               [],
               [
                 (r'{desc(\|(?!websub|firstline)[^\|]*)+}',
                  'follow desc keyword with either firstline or websub'),
               ]
             ]
             checks = [
                 ('python', r'.*\.(py|cgi)$', r'^#!.*python', pyfilters, pypats),
                 ('test script', r'(.*/)?test-[^.~]*$', '', testfilters, testpats),
                 ('c', r'.*\.[ch]$', '', cfilters, cpats),
                 ('unified test', r'.*\.t$', '', utestfilters, utestpats),
                 ('layering violation repo in revlog', r'mercurial/revlog\.py', '',
                  pyfilters, inrevlogpats),
                 ('layering violation ui in util', r'mercurial/util\.py', '', pyfilters,
                  inutilpats),
                 ('txt', r'.*\.txt$', '', txtfilters, txtpats),
                 ('web template', r'mercurial/templates/.*\.tmpl', '',
                  webtemplatefilters, webtemplatepats),
             ]
             def _preparepats():
                 for c in checks:
                     failandwarn = c[-1]
                     for pats in failandwarn:
                         for i, pseq in enumerate(pats):
                             # fix-up regexes for multi-line searches
                             p = pseq[0]
                             # \s doesn't match \n
                             p = re.sub(r'(?<!\\)\\s', r'[ \\t]', p)
                             # [^...] doesn't match newline
                             p = re.sub(r'(?<!\\)\[\^', r'[^\\n', p)
                             pats[i] = (re.compile(p, re.MULTILINE),) + pseq[1:]
                     filters = c[3]
                     for i, flt in enumerate(filters):
                         filters[i] = re.compile(flt[0]), flt[1]
             _preparepats()
             class norepeatlogger(object):
                 def __init__(self):
                     self._lastseen = None
                 def log(self, fname, lineno, line, msg, blame):
                     """print error related a to given line of a given file.
                     The faulty line will also be printed but only once in the case
                     of multiple errors.
                     :fname: filename
                     :lineno: line number
                     :line: actual content of the line
                     :msg: error message
                     """
                     msgid = fname, lineno, line
                     if msgid != self._lastseen:
                         if blame:
                             print "%s:%d (%s):" % (fname, lineno, blame)
                         else:
                             print "%s:%d:" % (fname, lineno)
                         print " > %s" % line
                         self._lastseen = msgid
                     print " " + msg
             _defaultlogger = norepeatlogger()
             def getblame(f):
                 lines = []
                 for l in os.popen('hg annotate -un %s' % f):
                     start, line = l.split(':', 1)
                     user, rev = start.split()
                     lines.append((line[1:-1], user, rev))
                 return lines
             def checkfile(f, logfunc=_defaultlogger.log, maxerr=None, warnings=False,
                           blame=False, debug=False, lineno=True):
                 """checks style and portability of a given file
                 :f: filepath
                 :logfunc: function used to report error
                           logfunc(filename, linenumber, linecontent, errormessage)
                 :maxerr: number of error to display before aborting.
                          Set to false (default) to report all errors
                 return True if no error is found, False otherwise.
                 """
                 blamecache = None
                 result = True
                 try:
                     fp = open(f)
                 except IOError, e:
                     print "Skipping %s, %s" % (f, str(e).split(':', 1)[0])
                     return result
                 pre = post = fp.read()
                 fp.close()
                 for name, match, magic, filters, pats in checks:
                     if debug:
                         print name, f
                     fc = 0
                     if not (re.match(match, f) or (magic and re.search(magic, f))):
                         if debug:
                             print "Skipping %s for %s it doesn't match %s" % (
                                    name, match, f)
                         continue
                     if "no-" "check-code" in pre:
                         print "Skipping %s it has no-" "check-code" % f
                         return "Skip" # skip checking this file
                     for p, r in filters:
                         post = re.sub(p, r, post)
                     nerrs = len(pats[0]) # nerr elements are errors
                     if warnings:
                         pats = pats[0] + pats[1]
                     else:
                         pats = pats[0]
                     # print post # uncomment to show filtered version
                     if debug:
                         print "Checking %s for %s" % (name, f)
                     prelines = None
                     errors = []
                     for i, pat in enumerate(pats):
                         if len(pat) == 3:
                             p, msg, ignore = pat
                         else:
                             p, msg = pat
                             ignore = None
                         if i >= nerrs:
                             msg = "warning: " + msg
                         pos = 0
                         n = 0
                         for m in p.finditer(post):
                             if prelines is None:
                                 prelines = pre.splitlines()
                                 postlines = post.splitlines(True)
                             start = m.start()
                             while n < len(postlines):
                                 step = len(postlines[n])
                                 if pos + step > start:
                                     break
                                 pos += step
                                 n += 1
                             l = prelines[n]
                             if ignore and re.search(ignore, l, re.MULTILINE):
                                 if debug:
                                     print "Skipping %s for %s:%s (ignore pattern)" % (
                                         name, f, n)
                                 continue
                             bd = ""
                             if blame:
                                 bd = 'working directory'
                                 if not blamecache:
                                     blamecache = getblame(f)
                                 if n < len(blamecache):
                                     bl, bu, br = blamecache[n]
                                     if bl == l:
                                         bd = '%s@%s' % (bu, br)
                             errors.append((f, lineno and n + 1, l, msg, bd))
                             result = False
                     errors.sort()
                     for e in errors:
                         logfunc(*e)
                         fc += 1
                         if maxerr and fc >= maxerr:
                             print " (too many errors, giving up)"
                             break
                 return result
             if __name__ == "__main__":
                 parser = optparse.OptionParser("%prog [options] [files]")
                 parser.add_option("-w", "--warnings", action="store_true",
                                   help="include warning-level checks")
                 parser.add_option("-p", "--per-file", type="int",
                                   help="max warnings per file")
                 parser.add_option("-b", "--blame", action="store_true",
                                   help="use annotate to generate blame info")
                 parser.add_option("", "--debug", action="store_true",
                                   help="show debug information")
                 parser.add_option("", "--nolineno", action="store_false",
                                   dest='lineno', help="don't show line numbers")
                 parser.set_defaults(per_file=15, warnings=False, blame=False, debug=False,
                                     lineno=True)
                 (options, args) = parser.parse_args()
                 if len(args) == 0:
                     check = glob.glob("*")
                 else:
                     check = args
                 ret = 0
                 for f in check:
                     if not checkfile(f, maxerr=options.per_file, warnings=options.warnings,
                                      blame=options.blame, debug=options.debug,
                                      lineno=options.lineno):
                         ret = 1
                 sys.exit(ret)

               $ cat > correct.py <<EOF
               > def toto(arg1, arg2):
               >     del arg2
               >     return (5 + 6, 9)
               > EOF
               $ cat > wrong.py <<EOF
               > def toto( arg1, arg2):
               >     del(arg2)
               >     return ( 5+6, 9)
               > EOF
               $ cat > quote.py <<EOF
               > # let's use quote in comments
               > (''' ( 4x5 )
               > but """\\''' and finally''',
               > """let's fool checkpatch""", '1+2',
               > '"""', 42+1, """and
               > ( 4-1 ) """, "( 1+1 )\" and ")
               > a, '\\\\\\\\', "\\\\\\" x-2", "c-1"
               > EOF
               $ cat > non-py24.py <<EOF
               > # Using builtins that does not exist in Python 2.4
               > if any():
               >     x = all()
               >     y = format(x)
               >     # next(generator) is new in 2.6
               >     z = next(x)
               >     # but generator.next() is okay
               >     x.next()
               >     # and we can make our own next
               >     def next(stuff):
               >         pass
               >
               > # Do not complain about our own definition
               > def any(x):
               >     pass
               >
               > # try/except/finally block does not exist in Python 2.4
               >     try:
               >         pass
               >     except StandardError, inst:
               >         pass
               >     finally:
               >         pass
               >
               > # nested try/finally+try/except is allowed
               >     try:
               >         try:
               >             pass
               >         except StandardError, inst:
               >             pass
               >     finally:
               >         pass
               >
               > # yield inside a try/finally block is not allowed in Python 2.4
               >     try:
               >         pass
               >         yield 1
               >     finally:
               >         pass
               >     try:
               >         yield
               >         pass
               >     finally:
               >         pass
               >
               > EOF
               $ cat > classstyle.py <<EOF
               > class newstyle_class(object):
               >     pass
               >
               > class oldstyle_class:
               >     pass
               >
               > class empty():
               >     pass
               >
               > no_class = 1:
               >     pass
               > EOF
               $ check_code="$TESTDIR"/../contrib/check-code.py
               $ "$check_code" ./wrong.py ./correct.py ./quote.py ./non-py24.py ./classstyle.py
               ./wrong.py:1:
                > def toto( arg1, arg2):
                gratuitous whitespace in () or []
               ./wrong.py:2:
                >     del(arg2)
                Python keyword is not a function
               ./wrong.py:3:
                >     return ( 5+6, 9)
                gratuitous whitespace in () or []
                missing whitespace in expression
               ./quote.py:5:
                > '"""', 42+1, """and
                missing whitespace in expression
               ./non-py24.py:2:
                > if any():
                any/all/format not available in Python 2.4
               ./non-py24.py:3:
                >     x = all()
                any/all/format not available in Python 2.4
               ./non-py24.py:4:
                >     y = format(x)
                any/all/format not available in Python 2.4
               ./non-py24.py:6:
                >     z = next(x)
                no next(foo) in Python 2.4 and 2.5, use foo.next() instead
               ./non-py24.py:35:
                >     try:
                no yield inside try/finally in Python 2.4
               ./non-py24.py:40:
                >     try:
                no yield inside try/finally in Python 2.4
               ./classstyle.py:4:
                > class oldstyle_class:
                old-style class, use class foo(object)
               ./classstyle.py:7:
                > class empty():
-               class foo() not available in Python 2.4, use class foo(object)
+               class foo() creates old style object, use class foo(object)
               [1]
               $ cat > python3-compat.py << EOF
               > foo <> bar
               > reduce(lambda a, b: a + b, [1, 2, 3, 4])
               > dict(key=value)
               > EOF
               $ "$check_code" python3-compat.py
               python3-compat.py:1:
                > foo <> bar
                <> operator is not available in Python 3+, use !=
               python3-compat.py:2:
                > reduce(lambda a, b: a + b, [1, 2, 3, 4])
                reduce is not available in Python 3+
               python3-compat.py:3:
                > dict(key=value)
                dict() is different in Py2 and 3 and is slower than {}
               [1]
               $ cat > is-op.py <<EOF
               > # is-operator comparing number or string literal
               > x = None
               > y = x is 'foo'
               > y = x is "foo"
               > y = x is 5346
               > y = x is -6
               > y = x is not 'foo'
               > y = x is not "foo"
               > y = x is not 5346
               > y = x is not -6
               > EOF
               $ "$check_code" ./is-op.py
               ./is-op.py:3:
                > y = x is 'foo'
                object comparison with literal
               ./is-op.py:4:
                > y = x is "foo"
                object comparison with literal
               ./is-op.py:5:
                > y = x is 5346
                object comparison with literal
               ./is-op.py:6:
                > y = x is -6
                object comparison with literal
               ./is-op.py:7:
                > y = x is not 'foo'
                object comparison with literal
               ./is-op.py:8:
                > y = x is not "foo"
                object comparison with literal
               ./is-op.py:9:
                > y = x is not 5346
                object comparison with literal
               ./is-op.py:10:
                > y = x is not -6
                object comparison with literal
               [1]
               $ cat > for-nolineno.py <<EOF
               > except:
               > EOF
               $ "$check_code" for-nolineno.py --nolineno
               for-nolineno.py:0:
                > except:
                naked except clause
               [1]
               $ cat > warning.t <<EOF
               >   $ function warnonly {
               >   > }
               >   $ diff -N aaa
               >   $ function onwarn {}
               > EOF
               $ "$check_code" warning.t
               $ "$check_code" --warn warning.t
               warning.t:1:
                >   $ function warnonly {
                warning: don't use 'function', use old style
               warning.t:3:
                >   $ diff -N aaa
                warning: don't use 'diff -N'
               warning.t:4:
                >   $ function onwarn {}
                warning: don't use 'function', use old style
               [1]
               $ cat > raise-format.py <<EOF
               > raise SomeException, message
               > # this next line is okay
               > raise SomeException(arg1, arg2)
               > EOF
               $ "$check_code" not-existing.py raise-format.py
               Skipping*not-existing.py* (glob)
               raise-format.py:1:
                > raise SomeException, message
                don't use old-style two-argument raise, use Exception(message)
               [1]
               $ cat > rst.py <<EOF
               > """problematic rst text
               >
               > .. note::
               >     wrong
               > """
               >
               > '''
               >
               > .. note::
               >
               >     valid
               >
               > new text
               >
               >     .. note::
               >
               >         also valid
               > '''
               >
               > """mixed
               >
               > .. note::
               >
               >   good
               >
               >     .. note::
               >         plus bad
               > """
               > EOF
               $ $check_code -w rst.py
               rst.py:3:
                > .. note::
                warning: add two newlines after '.. note::'
               rst.py:26:
                >     .. note::
                warning: add two newlines after '.. note::'
               [1]
               $ cat > ./map-inside-gettext.py <<EOF
               > print _("map inside gettext %s" % v)
               >
               > print _("concatenating " " by " " space %s" % v)
               > print _("concatenating " + " by " + " '+' %s" % v)
               >
               > print _("mapping operation in different line %s"
               >         % v)
               >
               > print _(
               >         "leading spaces inside of '(' %s" % v)
               > EOF
               $ "$check_code" ./map-inside-gettext.py
               ./map-inside-gettext.py:1:
                > print _("map inside gettext %s" % v)
                don't use % inside _()
               ./map-inside-gettext.py:3:
                > print _("concatenating " " by " " space %s" % v)
                don't use % inside _()
               ./map-inside-gettext.py:4:
                > print _("concatenating " + " by " + " '+' %s" % v)
                don't use % inside _()
               ./map-inside-gettext.py:6:
                > print _("mapping operation in different line %s"
                don't use % inside _()
               ./map-inside-gettext.py:9:
                > print _(
                don't use % inside _()
               [1]
             web templates
               $ mkdir -p mercurial/templates
               $ cat > mercurial/templates/example.tmpl <<EOF
               > {desc}
               > {desc|escape}
               > {desc|firstline}
               > {desc|websub}
               > EOF
               $ "$check_code" --warnings mercurial/templates/example.tmpl
               mercurial/templates/example.tmpl:2:
                > {desc|escape}
                warning: follow desc keyword with either firstline or websub
               [1]