third_party/pep8/docs/api.rst

   1 ========
   2 pep8 API
   3 ========
   4
   5 .. module:: pep8
   6
   7 The library provides classes which are usable by third party tools.
   8
   9 .. contents::
  10    :local:
  11
  12
  13 .. _main_classes:
  14
  15 Checker Classes
  16 ---------------
  17
  18 The :class:`StyleGuide` class is used to configure a style guide checker
  19 instance to check multiple files.
  20
  21 The :class:`Checker` class can be used to check a single file.
  22
  23
  24 .. autoclass:: StyleGuide(parse_argv=False, config_file=None, parser=None, paths=None, report=None, **kwargs)
  25
  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, parent=None)
  31    .. automethod:: ignore_code(code)
  32    .. automethod:: get_checks(argument_name)
  33
  34 .. autoclass:: Checker(filename=None, lines=None, report=None, **kwargs)
  35
  36    .. automethod:: readline
  37    .. automethod:: run_check(check, argument_names)
  38    .. automethod:: check_physical(line)
  39    .. automethod:: build_tokens_line
  40    .. automethod:: check_logical
  41    .. automethod:: check_ast
  42    .. automethod:: generate_tokens
  43    .. automethod:: check_all(expected=None, line_offset=0)
  44
  45
  46 .. _report_classes:
  47
  48 Report Classes
  49 --------------
  50
  51 .. autoclass:: BaseReport(options)
  52
  53    .. automethod:: start
  54    .. automethod:: stop
  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
  63
  64 .. autoclass:: FileReport
  65
  66 .. autoclass:: StandardReport
  67
  68 .. autoclass:: DiffReport
  69
  70
  71 Utilities
  72 ---------
  73
  74 .. autofunction:: expand_indent(line)
  75 .. autofunction:: mute_string(text)
  76 .. autofunction:: read_config(options, args, arglist, parser)
  77 .. autofunction:: process_options(arglist=None, parse_argv=False, config_file=None)
  78 .. autofunction:: register_check(func_or_cls, codes=None)
  79
  80 ..
  81   These ones are used internally, but they don't need advertising
  82   .. autofunction:: readlines(filename)
  83   .. autofunction:: isidentifier(word)
  84   .. autofunction:: stdin_get_value()
  85   .. autofunction:: parse_udiff(diff, patterns=None, parent='.')
  86   .. autofunction:: filename_match(filename, patterns, default=True)
  87   .. autofunction:: get_parser(prog='pep8', version=pep8.__version__)
  88   .. autofunction:: init_checks_registry()