Flake8包装器,使其易于使用和配置
项目描述
这是一个Flake8包装器,使其变得酷。
- 检查md、rst、ipynb等.
- 可分享和远程配置.
- 向后兼容:仅获取新错误报告的能力。
- 缓存以提高性能。
- 仅使用指定的插件,而不是安装的所有内容。
- 使输出美观.
- 支持pyproject.toml。
- 检查是否已安装所有必需的插件.
- 在消息和代码片段中进行语法高亮显示.
- PyLint集成。
- 强大的GitLab支持.
- 代码管理
- 按插件管理代码。
- 通过通配符启用和禁用插件和代码。
- 显示已安装插件的代码.
- 显示一个插件的全部信息和代码.
- 允许不同插件代码的交叉
兼容性
FlakeHell支持所有flake8插件、格式化和配置。然而,FlakeHell有它自己的独特方式来配置启用的插件和代码。因此,像--ignore
和--select
这样的选项不受支持。如果您想在一个项目中使用flake8和FlakeHell,可以这样做,但必须明确指定启用的插件。
安装
python3 -m pip install --user flakehell
用法
首先,让我们创建pyproject.toml
配置文件
[tool.flakehell]
# optionally inherit from remote config (or local if you want)
base = "https://raw.githubusercontent.com/life4/flakehell/master/pyproject.toml"
# specify any flake8 options. For example, exclude "example.py":
exclude = ["example.py"]
# make output nice
format = "grouped"
# 80 chars aren't enough in 21 century
max_line_length = 90
# show line of source code in output
show_source = true
# list of plugins and rules for them
[tool.flakehell.plugins]
# include everything in pyflakes except F401
pyflakes = ["+*", "-F401"]
# enable only codes from S100 to S199
flake8-bandit = ["-*", "+S1??"]
# enable everything that starts from `flake8-`
"flake8-*" = ["+*"]
# explicitly disable plugin
flake8-docstrings = ["-*"]
显示尚未安装的插件
flakehell missed
显示已安装的插件、使用的插件、指定的规则、代码前缀
flakehell plugins
显示特定插件的代码和消息
flakehell codes pyflakes
对代码运行flake8
flakehell lint
此命令接受与Flake8相同的所有参数。
阅读flakehell.readthedocs.io获取更多信息。
贡献
欢迎贡献!以下是一些您可以贡献的想法:
- 改进文档。
- 添加更多测试。
- 提高性能。
- 发现了一个bug?修复它!
- 写了一篇关于FlakeHell的文章?太好了!让我们将它添加到
README.md
中。 - 没有时间编码?没关系!只需告诉您的朋友和订阅者关于这个项目。用户越多 -> 贡献者越多 -> 更多酷功能。
使用DepHell运行测试是一种方便的方式
curl -L dephell.org/install | python3
dephell venv create --env=pytest
dephell deps install --env=pytest
dephell venv run --env=pytest
出于设计考虑,已禁用bug-tracker,以将贡献从言语转移到行动。请帮助我们使项目变得更好,不要在社交网络和街道上骚扰维护者。
谢谢 :heart
FlakeHell吉祥物(Flaky)由@illustrator.way创作,并受CC BY-SA 4.0许可。
项目详情
下载文件
下载适用于您平台的文件。如果您不确定选择哪一个,请了解更多关于安装包的信息。
源代码发行版
flakehell-0.9.0.tar.gz (36.6 kB 查看哈希值)
构建发行版
flakehell-0.9.0-py3-none-any.whl (43.0 kB 查看哈希值)