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