最严格且最有争议的Python代码风格检查工具
项目描述
wemake-python-styleguide
欢迎使用最严格且最有争议的Python代码风格检查工具。
wemake-python-styleguide
实际上是一个flake8插件,它依赖于一些其他插件。
快速入门
pip install wemake-python-styleguide
您还需要创建一个setup.cfg
文件,并配置配置。
在线试用!
我们强烈建议使用
- flakeheaven以便轻松集成到旧版代码库中
- nitpick以便在多个项目中共享和验证配置
运行
flake8 your_module.py
这个应用仍然是老牌的 flake8
!而且它不会改变你现有的工作流程。
请在文档中的"使用"部分查看示例和集成。
我们还支持作为一等公民的GitHub Actions。 试试看!
严格是新的酷
严格的代码检查为开发者和公司提供了以下好处
- 确保一致性 - 无论谁参与其中,最终产品都将始终是可靠的相同代码
- 帮助避免潜在的错误 - 严格的规则确保你不犯常见的错误
- 高效的代码审查 - 每段代码都有相似且熟悉的风格和语法。如果所有检查都通过,就没什么可审查的了!
- 减少代码修订 - 严格的代码检查确保你不必反复重写代码库
- 减少代码冗余 - 有时候我们会以某种方式思考问题而编写复杂的代码。代码检查器提供的建议可以帮助简化代码并消除冗余语句
我们的目标是什么
本项目最终目标是让所有人都能编写完全相同的 Python
代码。
flake8 | pylint | black | mypy | wemake-python-styleguide | |
---|---|---|---|---|---|
格式化代码? | ❌ | ❌ | ✅ | ❌ | ❌ |
发现风格问题? | 🤔 | ✅ | 🤔 | ❌ | ✅ |
发现错误? | 🤔 | ✅ | ❌ | ✅ | ✅ |
发现复杂代码? | ❌ | 🤔 | ❌ | ❌ | ✅ |
有许多严格的规则? | ❌ | 🤔 | ❌ | ❌ | ✅ |
有许多插件? | ✅ | ❌ | ❌ | 🤔 | ✅ |
我们的主要目标有几个
- 显著降低代码复杂性,使其更具可维护性
- 强制执行“应该有一个 - 而且最好是唯一的一个 - 明显的方法来做这件事”的编码和命名风格规则
- 保护开发者免受可能的错误,并强制执行最佳实践
您可以在文档中找到所有错误代码和插件。
我们不是什么
我们不会做以下事情
支持我们:tada
我们在 wemake.services 默认将所有工具开源,以便社区从中受益。如果你使用我们的工具,它们使你的生活变得更轻松,并为你的业务带来价值,你可以通过支持我们所做的工作来回报我们。
展示你的风格:sunglasses
如果你使用我们的代码检查器 - 这意味着你的代码很棒。你可以为此感到自豪!你应该通过在 README
文件中包含徽章来与他人分享你的成就。它看起来像这样
Markdown
[](https://github.com/wemake-services/wemake-python-styleguide)
重新结构化文本
.. image:: https://img.shields.io/badge/style-wemake-000000.svg
:target: https://github.com/wemake-services/wemake-python-styleguide
贡献
我们 热烈欢迎 所有贡献!
如果你想要贡献,请参阅文档中的"贡献"部分。
你现在可以从需要一些帮助的问题开始。
项目详细信息
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源分发
wemake_python_styleguide-0.19.2.tar.gz (168.5 kB 查看哈希值)
构建分发
关闭
wemake_python_styleguide-0.19.2.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 850fe70e6d525fd37ac51778e552a121a489f1bd057184de96ffd74a09aef414 |
|
MD5 | e8e305fbd496bfed62bd3a5dc7d90051 |
|
BLAKE2b-256 | c2f42a76c59661fae8534b81e992a37d347de241b242aaf5bc651b10d24b7025 |
关闭
wemake_python_styleguide-0.19.2-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | d53205dbb629755026d853d15fb3ca03ebb2717c97de4198b5676b9bdc0663bd |
|
MD5 | fe63fb2a0f4dd2d24e8bc47ed554c0fa |
|
BLAKE2b-256 | fdc40e36d00c88e995f2a0e5de8c61bb130a4acdc1b458b6bf8c7a474b127890 |