xref: /xnu-8020.121.3/tools/lldbmacros/core/syntax_checker.py (revision fdd8201d7b966f0c3ea610489d29bd841d358941)
1*fdd8201dSApple OSS Distributions#!/usr/bin/env python
2*fdd8201dSApple OSS Distributionsfrom __future__ import absolute_import, print_function
3*fdd8201dSApple OSS Distributions
4*fdd8201dSApple OSS Distributions
5*fdd8201dSApple OSS Distributionshelpdoc = """
6*fdd8201dSApple OSS DistributionsA simple utility that verifies the syntax for python scripts.
7*fdd8201dSApple OSS DistributionsThe checks it does are :
8*fdd8201dSApple OSS Distributions  * Check for 'tab' characters in .py files
9*fdd8201dSApple OSS Distributions  * Compile errors in py sources
10*fdd8201dSApple OSS DistributionsUsage:
11*fdd8201dSApple OSS Distributions  python syntax_checker.py <python_source_file> [<python_source_file> ..]
12*fdd8201dSApple OSS Distributions"""
13*fdd8201dSApple OSS Distributionsimport sys
14*fdd8201dSApple OSS Distributionsimport os
15*fdd8201dSApple OSS Distributionsimport re
16*fdd8201dSApple OSS Distributions
17*fdd8201dSApple OSS Distributionstabs_search_rex = re.compile("^\s*\t+",re.MULTILINE|re.DOTALL)
18*fdd8201dSApple OSS Distributions
19*fdd8201dSApple OSS Distributionsdef find_non_ascii(s):
20*fdd8201dSApple OSS Distributions    for c in s:
21*fdd8201dSApple OSS Distributions        if ord(c) >= 0x80: return True
22*fdd8201dSApple OSS Distributions    return False
23*fdd8201dSApple OSS Distributions
24*fdd8201dSApple OSS Distributionsif __name__ == "__main__":
25*fdd8201dSApple OSS Distributions    if len(sys.argv) < 2:
26*fdd8201dSApple OSS Distributions        print("Error: Unknown arguments", file=sys.stderr)
27*fdd8201dSApple OSS Distributions        print(helpdoc)
28*fdd8201dSApple OSS Distributions        sys.exit(1)
29*fdd8201dSApple OSS Distributions    for fname in sys.argv[1:]:
30*fdd8201dSApple OSS Distributions        if not os.path.exists(fname):
31*fdd8201dSApple OSS Distributions            print("Error: Cannot recognize %s as a file" % fname, file=sys.stderr)
32*fdd8201dSApple OSS Distributions            sys.exit(1)
33*fdd8201dSApple OSS Distributions        if fname.split('.')[-1] != 'py':
34*fdd8201dSApple OSS Distributions            print("Note: %s is not a valid python file. Skipping." % fname)
35*fdd8201dSApple OSS Distributions            continue
36*fdd8201dSApple OSS Distributions        fh = open(fname)
37*fdd8201dSApple OSS Distributions        strdata = fh.readlines()
38*fdd8201dSApple OSS Distributions        lineno = 0
39*fdd8201dSApple OSS Distributions        syntax_fail = False
40*fdd8201dSApple OSS Distributions        for linedata in strdata:
41*fdd8201dSApple OSS Distributions            lineno += 1
42*fdd8201dSApple OSS Distributions            if len(tabs_search_rex.findall(linedata)) > 0 :
43*fdd8201dSApple OSS Distributions                print("Error: Found a TAB character at %s:%d" % (fname, lineno), file=sys.stderr)
44*fdd8201dSApple OSS Distributions                syntax_fail = True
45*fdd8201dSApple OSS Distributions        if find_non_ascii(linedata):
46*fdd8201dSApple OSS Distributions            print("Error: Found a non ascii character at %s:%d" % (fname, lineno), file=sys.stderr)
47*fdd8201dSApple OSS Distributions            syntax_fail = True
48*fdd8201dSApple OSS Distributions        if syntax_fail:
49*fdd8201dSApple OSS Distributions            print("Error: Syntax check failed. Please fix the errors and try again.", file=sys.stderr)
50*fdd8201dSApple OSS Distributions            sys.exit(1)
51*fdd8201dSApple OSS Distributions        #now check for error in compilation
52*fdd8201dSApple OSS Distributions        try:
53*fdd8201dSApple OSS Distributions            with open(fname, 'r') as file:
54*fdd8201dSApple OSS Distributions                source = file.read() + '\n'
55*fdd8201dSApple OSS Distributions                compile_result = compile(source, fname, 'exec')
56*fdd8201dSApple OSS Distributions        except Exception as exc:
57*fdd8201dSApple OSS Distributions            print(str(exc), file=sys.stderr)
58*fdd8201dSApple OSS Distributions            print("Error: Compilation failed. Please fix the errors and try again.", file=sys.stderr)
59*fdd8201dSApple OSS Distributions            sys.exit(1)
60*fdd8201dSApple OSS Distributions        print("Success: Checked %s. No syntax errors found." % fname)
61*fdd8201dSApple OSS Distributions    sys.exit(0)
62*fdd8201dSApple OSS Distributions
63