Mercurial > public > mercurial-scm > hg-stable
annotate contrib/check-code.py @ 10374:3aa35db5e38c
check-code.py: make help strings consistent
| author | Martin Geisler <mg@lazybytes.net> |
|---|---|
| date | Sun, 07 Feb 2010 10:58:51 +0100 |
| parents | e4c7972002e4 |
| children | 5326800d6937 |
| rev | line source |
|---|---|
| 10281 | 1 #!/usr/bin/env python |
| 2 # | |
| 3 # check-code - a style and portability checker for Mercurial | |
| 4 # | |
|
10290
7cc60de189d7
check-code: fix copyright date
Matt Mackall <mpm@selenic.com>
parents:
10287
diff
changeset
|
5 # Copyright 2010 Matt Mackall <mpm@selenic.com> |
| 10281 | 6 # |
| 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. | |
| 9 | |
| 10 import sys, re, glob | |
| 11 | |
| 12 def repquote(m): | |
| 13 t = re.sub(r"\S", "x", m.group(2)) | |
| 14 return m.group(1) + t + m.group(1) | |
| 15 | |
| 16 def repcomment(m): | |
| 17 return m.group(1) + "#" * len(m.group(2)) | |
| 18 | |
| 19 def repccomment(m): | |
| 20 t = re.sub(r"((?<=\n) )|\S", "x", m.group(2)) | |
| 21 return m.group(1) + t + "*/" | |
| 22 | |
| 23 def repcallspaces(m): | |
| 24 t = re.sub(r"\n\s+", "\n", m.group(2)) | |
| 25 return m.group(1) + t | |
| 26 | |
| 27 def repinclude(m): | |
| 28 return m.group(1) + "<foo>" | |
| 29 | |
| 30 def rephere(m): | |
| 31 t = re.sub(r"\S", "x", m.group(2)) | |
| 32 return m.group(1) + t | |
| 33 | |
| 34 | |
| 35 testpats = [ | |
|
10374
3aa35db5e38c
check-code.py: make help strings consistent
Martin Geisler <mg@lazybytes.net>
parents:
10373
diff
changeset
|
36 (r'(pushd|popd)', "don't use 'pushd' or 'popd', use 'cd'"), |
|
3aa35db5e38c
check-code.py: make help strings consistent
Martin Geisler <mg@lazybytes.net>
parents:
10373
diff
changeset
|
37 (r'\W\$?\(\([^\)]*\)\)', "don't use (()) or $(()), use 'expr'"), |
| 10281 | 38 (r'^function', "don't use 'function', use old style"), |
|
10374
3aa35db5e38c
check-code.py: make help strings consistent
Martin Geisler <mg@lazybytes.net>
parents:
10373
diff
changeset
|
39 (r'grep.*-q', "don't use 'grep -q', redirect to /dev/null"), |
|
10373
e4c7972002e4
check-code.py: escape backslash
Mads Kiilerich <mads@kiilerich.com>
parents:
10291
diff
changeset
|
40 (r'echo.*\\n', "don't use 'echo \\n', use printf"), |
|
10374
3aa35db5e38c
check-code.py: make help strings consistent
Martin Geisler <mg@lazybytes.net>
parents:
10373
diff
changeset
|
41 (r'^diff.*-\w*N', "don't use 'diff -N'"), |
| 10281 | 42 (r'(^| )wc[^|]*$', "filter wc output"), |
|
10374
3aa35db5e38c
check-code.py: make help strings consistent
Martin Geisler <mg@lazybytes.net>
parents:
10373
diff
changeset
|
43 (r'head -c', "don't use 'head -c', use 'dd'"), |
|
3aa35db5e38c
check-code.py: make help strings consistent
Martin Geisler <mg@lazybytes.net>
parents:
10373
diff
changeset
|
44 (r'ls.*-\w*R', "don't use 'ls -R', use 'find'"), |
|
3aa35db5e38c
check-code.py: make help strings consistent
Martin Geisler <mg@lazybytes.net>
parents:
10373
diff
changeset
|
45 (r'printf.*\\\d\d\d', "don't use 'printf \NNN', use Python"), |
|
3aa35db5e38c
check-code.py: make help strings consistent
Martin Geisler <mg@lazybytes.net>
parents:
10373
diff
changeset
|
46 (r'printf.*\\x', "don't use printf \\x, use Python"), |
| 10281 | 47 (r'\$\(.*\)', "don't use $(expr), use `expr`"), |
| 48 (r'rm -rf \*', "don't use naked rm -rf, target a directory"), | |
| 49 (r'(^|\|\s*)grep (-\w\s+)*[^|]*[(|]\w', | |
| 50 "use egrep for extended grep syntax"), | |
| 51 (r'/bin/', "don't use explicit paths for tools"), | |
| 52 (r'\$PWD', "don't use $PWD, use `pwd`"), | |
| 53 (r'[^\n]\Z', "no trailing newline"), | |
| 54 ] | |
| 55 | |
| 56 testfilters = [ | |
| 57 (r"( *)(#([^\n]*\S)?)", repcomment), | |
| 58 (r"<<(\S+)((.|\n)*?\n\1)", rephere), | |
| 59 ] | |
| 60 | |
| 61 pypats = [ | |
| 62 (r'^\s*\t', "don't use tabs"), | |
| 63 (r'(\S\s+|^\s+)\n', "trailing whitespace"), | |
| 64 (r'\w,\w', "missing whitespace after ,"), | |
| 65 (r'\w[+/*\-<>]\w', "missing whitespace in expression"), | |
| 66 (r'^\s+\w+=\w+[^,)]$', "missing whitespace in assignment"), | |
| 67 (r'.{85}', "line too long"), | |
| 68 (r'[^\n]\Z', "no trailing newline"), | |
| 69 # (r'^\s+[^_ ][^_. ]+_[^_]+\s*=', "don't use underbars in identifiers"), | |
| 70 # (r'\w*[a-z][A-Z]\w*\s*=', "don't use camelcase in identifiers"), | |
| 10286 | 71 (r'^\s*(if|while|def|class|except|try)\s[^[]*:\s*[^\]#\s]+', |
| 72 "linebreak after :"), | |
| 10281 | 73 (r'class\s[^(]:', "old-style class, use class foo(object)"), |
|
10291
61c93743fae0
check-code: del isn't a function
Matt Mackall <mpm@selenic.com>
parents:
10290
diff
changeset
|
74 (r'^\s+del\(', "del isn't a function"), |
| 10281 | 75 (r'^\s+except\(', "except isn't a function"), |
| 76 # (r'class\s[A-Z][^\(]*\((?!Exception)', | |
| 77 # "don't capitalize non-exception classes"), | |
| 78 # (r'in range\(', "use xrange"), | |
| 79 # (r'^\s*print\s+', "avoid using print in core and extensions"), | |
| 80 (r'[\x80-\xff]', "non-ASCII character literal"), | |
| 81 (r'("\')\.format\(', "str.format() not available in Python 2.4"), | |
| 82 (r'^\s*with\s+', "with not available in Python 2.4"), | |
| 83 (r'if\s.*\selse', "if ... else form not available in Python 2.4"), | |
| 84 (r'([\(\[]\s\S)|(\S\s[\)\]])', "gratuitous whitespace in () or []"), | |
| 85 # (r'\s\s=', "gratuitous whitespace before ="), | |
| 86 (r'\S(\+=|-=|!=|<>|<=|>=|<<=|>>=)\S', "missing whitespace around operator") | |
| 87 ] | |
| 88 | |
| 89 pyfilters = [ | |
| 90 (r"""(''')(([^']|\\'|'{1,2}(?!'))*)'''""", repquote), | |
| 91 (r'''(""")(([^"]|\\"|"{1,2}(?!"))*)"""''', repquote), | |
| 92 (r'''(?<!")(")(([^"\n]|\\")+)"(?!")''', repquote), | |
| 93 (r"""(?<!')(')(([^'\n]|\\')+)'(?!')""", repquote), | |
| 94 (r"( *)(#([^\n]*\S)?)", repcomment), | |
| 95 ] | |
| 96 | |
| 97 cpats = [ | |
| 98 (r'//', "don't use //-style comments"), | |
| 99 (r'^ ', "don't use spaces to indent"), | |
| 100 (r'\S\t', "don't use tabs except for indent"), | |
| 101 (r'(\S\s+|^\s+)\n', "trailing whitespace"), | |
| 102 (r'.{85}', "line too long"), | |
| 103 (r'(while|if|do|for)\(', "use space after while/if/do/for"), | |
| 104 (r'return\(', "return is not a function"), | |
| 105 (r' ;', "no space before ;"), | |
| 106 (r'\w+\* \w+', "use int *foo, not int* foo"), | |
| 107 (r'\([^\)]+\) \w+', "use (int)foo, not (int) foo"), | |
| 108 (r'\S+ (\+\+|--)', "use foo++, not foo ++"), | |
| 109 (r'\w,\w', "missing whitespace after ,"), | |
| 110 (r'\w[+/*]\w', "missing whitespace in expression"), | |
| 111 (r'^#\s+\w', "use #foo, not # foo"), | |
| 112 (r'[^\n]\Z', "no trailing newline"), | |
| 113 ] | |
| 114 | |
| 115 cfilters = [ | |
| 116 (r'(/\*)(((\*(?!/))|[^*])*)\*/', repccomment), | |
| 117 (r'''(?<!")(")(([^"]|\\")+"(?!"))''', repquote), | |
| 118 (r'''(#\s*include\s+<)([^>]+)>''', repinclude), | |
| 119 (r'(\()([^)]+\))', repcallspaces), | |
| 120 ] | |
| 121 | |
| 122 checks = [ | |
| 123 ('python', r'.*\.(py|cgi)$', pyfilters, pypats), | |
| 124 ('test script', r'(.*/)?test-[^.~]*$', testfilters, testpats), | |
| 125 ('c', r'.*\.c$', cfilters, cpats), | |
| 126 ] | |
| 127 | |
| 128 if len(sys.argv) == 1: | |
| 129 check = glob.glob("*") | |
| 130 else: | |
| 131 check = sys.argv[1:] | |
| 132 | |
| 133 for f in check: | |
| 134 for name, match, filters, pats in checks: | |
| 135 fc = 0 | |
| 136 if not re.match(match, f): | |
| 137 continue | |
| 138 pre = post = open(f).read() | |
|
10287
5da892be3497
check-code: add some ignore hints
Matt Mackall <mpm@selenic.com>
parents:
10286
diff
changeset
|
139 if "no-" + "check-code" in pre: |
|
5da892be3497
check-code: add some ignore hints
Matt Mackall <mpm@selenic.com>
parents:
10286
diff
changeset
|
140 break |
| 10281 | 141 for p, r in filters: |
| 142 post = re.sub(p, r, post) | |
| 143 # print post # uncomment to show filtered version | |
| 144 z = enumerate(zip(pre.splitlines(), post.splitlines(True))) | |
| 145 for n, l in z: | |
|
10287
5da892be3497
check-code: add some ignore hints
Matt Mackall <mpm@selenic.com>
parents:
10286
diff
changeset
|
146 if "check-code" + "-ignore" in l[0]: |
|
5da892be3497
check-code: add some ignore hints
Matt Mackall <mpm@selenic.com>
parents:
10286
diff
changeset
|
147 continue |
| 10281 | 148 lc = 0 |
| 149 for p, msg in pats: | |
| 150 if re.search(p, l[1]): | |
| 151 if not lc: | |
| 152 print "%s:%d:" % (f, n + 1) | |
| 153 print " > %s" % l[0] | |
| 154 print " %s" % msg | |
| 155 lc += 1 | |
| 156 fc += 1 | |
| 157 if fc == 15: | |
| 158 print " (too many errors, giving up)" | |
| 159 break | |
| 160 break |