7 The library provides classes which are usable by third party tools.
18 The :class:`StyleGuide` class is used to configure a style guide checker
19 instance to check multiple files.
21 The :class:`Checker` class can be used to check is a single file.
24 .. autoclass:: StyleGuide(*args, **kwargs)
26 .. automethod:: init_report(reporter=None)
27 .. automethod:: check_files(paths=None)
28 .. automethod:: input_file(filename, lines=None, expected=None, line_offset=0)
29 .. automethod:: input_dir(dirname)
30 .. automethod:: excluded(filename)
31 .. automethod:: ignore_code(code)
32 .. automethod:: get_checks(argument_name)
34 .. autoclass:: Checker(filename=None, lines=None, options=None, report=None, **kwargs)
36 .. automethod:: readline
37 .. automethod:: readline_check_physical
38 .. automethod:: run_check(check, argument_names)
39 .. automethod:: check_physical(line)
40 .. automethod:: build_tokens_line
41 .. automethod:: check_logical
42 .. automethod:: generate_tokens
43 .. automethod:: check_all(expected=None, line_offset=1)
51 .. autoclass:: BaseReport(options)
55 .. automethod:: init_file(filename, lines, expected, line_offset)
56 .. automethod:: increment_logical_line
57 .. automethod:: error(line_number, offset, text, check)
58 .. automethod:: get_file_results
59 .. automethod:: get_count(prefix='')
60 .. automethod:: get_statistics(prefix='')
61 .. automethod:: print_statistics(prefix='')
62 .. automethod:: print_benchmark
64 .. autoclass:: FileReport
66 .. autoclass:: StandardReport
68 .. autoclass:: DiffReport
70 .. autoclass:: TestReport
76 .. autofunction:: expand_indent(line)
77 .. autofunction:: mute_string(text)
78 .. autofunction:: read_config(options, args, arglist, parser)
79 .. autofunction:: process_options(arglist=None, parse_argv=False, config_file=None)
82 These ones are used internally, but they don't need advertising
83 .. autofunction:: readlines(filename)
84 .. autofunction:: isidentifier(word)
85 .. autofunction:: stdin_get_value()
86 .. autofunction:: parse_udiff(diff, patterns=None, parent='.')
87 .. autofunction:: filename_match(filename, patterns, default=True)
88 .. autofunction:: find_checks(argument_name)
89 .. autofunction:: init_tests(pep8style)
90 .. autofunction:: selftest(options)