StyleCheck/StyleCheck.py at master · mytchj/StyleCheck · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
import argparse
import os

def main(args):
    style_check = find_style_errors(args)
    print(os.getcwd(), '\n')
    print_all_errors(style_check)


# void --> cmd line args
# returns formatted command line args
def cmd_io():

    parser = argparse.ArgumentParser(description="Style checks a file")

    # required args
    parser.add_argument('inFile', help = "input file to style check")

    # optional args
    parser.add_argument('-maxlen', type = int, default = 80,\
            help = "'length': line length check (default=80)")
    parser.add_argument('-indspace', type = int, default = 4,\
            help = "'indent space': number of spaces per indent (default=4)")
    parser.add_argument('-ws', action = 'store_false',\
            help = "'whitespace': turn off whitespace check")
    parser.add_argument('-ind', action = 'store_false',\
            help = "'indentation': turn off indentation check")

    return parser.parse_args()


# String int --> Bool
# returns True when length of string is less than threshold
def check_len(in_str, threshold):
    return len(in_str.rstrip('\n')) > threshold


# String --> Bool
# returns True when string has no whitespace at right end
def check_ws(in_str):
    in_str = in_str.rstrip('\n').lstrip(' ')
    return not (in_str == in_str.rstrip(' '))

# String int --> Bool
# returns True when left whitespace is devisable by tabspacing int
def check_ind(in_str, tabspacing):
    return (len(in_str) - len(in_str.lstrip(' '))) % tabspacing


# Namespace --> Dict
# returns a dict with the line numbers for each style check error
def find_style_errors(args):
    all_breaks = {}

    if args.inFile in ['.', '--all', '-A']:
        files = get_all_py_files(os.getcwd())
    else:
        files = [args.inFile]

    for py_file in files:
        with open(py_file) as file_in:
            line_num = 1
            style_breaks = {'length': [], 'whitespace': [], 'indentation': []}
            for line in file_in.readlines():
                if args.maxlen:
                    if check_len(line, args.maxlen):
                        style_breaks['length'].append(line_num)

                if args.ws:
                    if check_ws(line):
                        style_breaks['whitespace'].append(line_num)

                if args.ind:
                    if check_ind(line, args.indspace):
                        style_breaks['indentation'].append(line_num)

                line_num += 1

            all_breaks[file_in.name] = style_breaks

    return all_breaks


# string --> List
# returns all .py files in the directory given by string
def get_all_py_files(directory, extention = ".py"):
    py_files = []
    for dir_file in os.listdir(directory):
        if dir_file.endswith(extention):
            py_files.append(dir_file)
        else:
            pass

    return py_files


# List --> None
# prints all the errors in each file from the given dict
def print_all_errors(style_check):
    for key in style_check.keys():
        print("--- " + key + " ---")
        print("Line Length: " + str(style_check[key]['length']))
        print("White Space: " + str(style_check[key]['whitespace']))
        print("Indentation: " + str(style_check[key]['indentation']))
        print('')


def fix_style_errors(args, style_breaks, file_in):
    pass


if __name__ == '__main__':
    main(cmd_io())