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