diff options
Diffstat (limited to 'docs/api.rst')
| -rw-r--r-- | docs/api.rst | 90 |
1 files changed, 90 insertions, 0 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..09bedb9 --- /dev/null +++ b/docs/api.rst @@ -0,0 +1,90 @@ +======== +pep8 API +======== + +.. module:: pep8 + +The library provides classes which are usable by third party tools. + +.. contents:: + :local: + + +.. _main_classes: + +Checker Classes +--------------- + +The :class:`StyleGuide` class is used to configure a style guide checker +instance to check multiple files. + +The :class:`Checker` class can be used to check is a single file. + + +.. autoclass:: StyleGuide(*args, **kwargs) + + .. automethod:: init_report(reporter=None) + .. automethod:: check_files(paths=None) + .. automethod:: input_file(filename, lines=None, expected=None, line_offset=0) + .. automethod:: input_dir(dirname) + .. automethod:: excluded(filename) + .. automethod:: ignore_code(code) + .. automethod:: get_checks(argument_name) + +.. autoclass:: Checker(filename=None, lines=None, options=None, report=None, **kwargs) + + .. automethod:: readline + .. automethod:: readline_check_physical + .. automethod:: run_check(check, argument_names) + .. automethod:: check_physical(line) + .. automethod:: build_tokens_line + .. automethod:: check_logical + .. automethod:: generate_tokens + .. automethod:: check_all(expected=None, line_offset=1) + + +.. _report_classes: + +Report Classes +-------------- + +.. autoclass:: BaseReport(options) + + .. automethod:: start + .. automethod:: stop + .. automethod:: init_file(filename, lines, expected, line_offset) + .. automethod:: increment_logical_line + .. automethod:: error(line_number, offset, text, check) + .. automethod:: get_file_results + .. automethod:: get_count(prefix='') + .. automethod:: get_statistics(prefix='') + .. automethod:: print_statistics(prefix='') + .. automethod:: print_benchmark + +.. autoclass:: FileReport + +.. autoclass:: StandardReport + +.. autoclass:: DiffReport + +.. autoclass:: TestReport + + +Utilities +--------- + +.. autofunction:: expand_indent(line) +.. autofunction:: mute_string(text) +.. autofunction:: read_config(options, args, arglist, parser) +.. autofunction:: process_options(arglist=None, parse_argv=False, config_file=None) + +.. + These ones are used internally, but they don't need advertising + .. autofunction:: readlines(filename) + .. autofunction:: isidentifier(word) + .. autofunction:: stdin_get_value() + .. autofunction:: parse_udiff(diff, patterns=None, parent='.') + .. autofunction:: filename_match(filename, patterns, default=True) + .. autofunction:: find_checks(argument_name) + .. autofunction:: init_tests(pep8style) + .. autofunction:: selftest(options) |