PyoDeStayAPI

库提供可由第三方工具使用的类。

检查员班

这个 StyleGuide 类用于配置样式指南检查器实例以检查多个文件。

这个 Checker 类可用于检查单个文件。

class pycodestyle.StyleGuide(parse_argv=False, config_file=None, parser=None, paths=None, report=None, **kwargs)

用很少的选项初始化一个PEP-8实例。

init_report(reporter=None)

初始化报表实例。

check_files(paths=None)

对路径运行所有检查。

input_file(filename, lines=None, expected=None, line_offset=0)

对python源文件运行所有检查。

input_dir(dirname)

检查此目录和所有子目录中的所有文件。

excluded(filename, parent=None)

检查是否应排除该文件。

检查“options.exclude”是否包含与文件名匹配的模式。

ignore_code(code)

检查是否应忽略错误代码。

如果“options.select”包含错误代码的前缀，则返回false。否则，如果“options.ignore”包含错误代码的前缀，则返回true。

get_checks(argument_name)

获取此类别的所有支票。

查找所有全局可见的函数，其中第一个参数名称以参数名称开头，并且包含选定的测试。

class pycodestyle.Checker(filename=None, lines=None, report=None, **kwargs)

加载一个python源文件，标记它，检查编码样式。

readline()

从输入缓冲区获取下一行。

run_check(check, argument_names)

运行检查插件。

check_physical(line)

在原始输入行上运行所有物理检查。

build_tokens_line()

从令牌构建逻辑行。

check_logical()

从令牌构建一行并对其运行所有逻辑检查。

check_ast()

生成文件的ast并运行所有ast检查。

generate_tokens()

标记化文件，运行物理行检查并生成标记。

check_all(expected=None, line_offset=0)

对输入文件运行所有检查。

报表类

class pycodestyle.BaseReport(options)

收集检查结果。

start()

启动计时器。

stop()

停止计时器。

init_file(filename, lines, expected, line_offset)

发出新文件的信号。

increment_logical_line()

发出新逻辑线路的信号。

error(line_number, offset, text, check)

根据选项报告错误。

get_file_results()

返回此文件的错误和警告计数。

get_count(prefix='')

返回错误和警告的总数。

get_statistics(prefix='')

获取以前缀开头的消息代码的统计信息。

prefix='匹配所有错误，warnings prefix='e'匹配所有错误prefix='w'匹配所有警告prefix='e4'匹配与导入有关的所有错误

print_statistics(prefix='')

打印总体统计信息（错误和警告数）。

print_benchmark()

打印基准数字。

class pycodestyle.FileReport(options)

收集检查结果并打印文件名。

class pycodestyle.StandardReport(options)

收集并打印检查结果。

class pycodestyle.DiffReport(options)

仅收集并打印更改行的结果。

公用事业

pycodestyle.expand_indent(line)

返回缩进量。

选项卡扩展到8的下一个倍数。

pycodestyle.mute_string(text)

将内容替换为“xxx”，以防止语法匹配。

pycodestyle.read_config(options, args, arglist, parser)

读取和分析配置。

如果在命令行上使用“-config”选项指定了一个配置文件，那么只有它用于配置。

否则，将使用configparser的read方法将用户配置（~/.config/pycodestyle）和当前目录或以上目录中的任何本地配置合并在一起（按该顺序）。

pycodestyle.process_options(arglist=None, parse_argv=False, config_file=None)

通过arglist或命令行args传递的进程选项。

路过 config_file 参数允许其他工具（如flake8）指定要在pycodestyle中处理的自己的选项。

pycodestyle.register_check(func_or_cls, codes=None)

注册新的检查对象。