史上最严格、最固执己见的蟒蛇皮棉
wemake-python-styleguide的Python项目详细描述
wemake python样式指南
欢迎来到有史以来最严格、最固执己见的python linter。
wemake-python-styleguide
实际上是一个flake8
以some other plugins作为依赖项的插件。
快速启动
pip install wemake-python-styleguide
您还需要使用configuration创建一个setup.cfg
文件。
强烈建议同时使用:
运行
flake8 your_module.py
这个应用程序还是很好的旧版flake8
!
它不会改变你现有的工作流程。
见"Usage" section 在文档中提供示例和集成。
我们的目的
这个项目的最终目标是
使所有人都能写出完全相同的python
代码。
black | mypy | pylint | flake8 | wemake-python-styleguide | |
---|---|---|---|---|---|
Formats code? | ✅ | ❌ | ❌ | ❌ | ❌ |
Finds style issues? | ✅ | ❌ | ✅ | ✅ | ✅ |
Finds bugs? | ❌ | ✅ | ✅ | ? | ✅ |
Finds complex code? | ❌ | ❌ | ✅ | ? | ✅ |
Has a lot of strict rules? | ❌ | ❌ | ? | ❌ | ✅ |
Has a lot of plugins? | ❌ | ❌ | ❌ | ✅ | ✅ |
我们有几个主要目标:
- 强制使用
python3.6+
显著降低代码的复杂性,使其更易于维护 - 对编码和命名样式实施“应该有一种——最好只有一种——显而易见的方法”规则
- 保护开发人员不受可能出现的错误的影响,并实施最佳实践
您可以找到所有错误代码和插件in the docs。
我们不是什么
我们不打算做以下事情:
- 假设或检查类型,将
mypy
与我们的linter一起使用 - Reformat code,因为我们认为开发人员应该这样做
- 检查
SyntaxError
或逻辑错误,改为编写测试 - 吸引所有人。但是,你可以switch off任何你不喜欢的规则
支持我们
我们在wemake.services制造 默认情况下,我们所有的工具都是开源的,因此社区可以从中受益。 如果你使用我们的工具,让你的生活更轻松,带来商业价值, 你可以支持我们的工作来回报我们。
展示您的风格
如果你使用我们的linter-这意味着你的代码是可怕的。
你可以为此骄傲!
你应该和别人分享你的成就
通过在您的README
文件中包含徽章。看起来是这样的:
降价
[![wemake-python-styleguide](https://img.shields.io/badge/style-wemake-000000.svg)](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
贡献
我们热烈欢迎您的贡献!
如果您想参与,请参阅文档中的"Contributing"部分。
你可以从issues that need some help开始 马上。