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