这个项目能做什么
Black 是一个由 Python 软件基金会维护的有偏见的 Python 代码格式化器。其既定目标是通过应用单一、一致的样式来终结关于手动格式化的争论:用户放弃对格式化细节的控制,以换取速度、确定性和免于样式检查器投诉的自由。
README 中描述的关键特性:
- 在原地重新格式化整个文件,忽略先前的格式化(有记录的务实例外)。
- 故意有限的配置选项;强调合理的默认值,项目设置可从 pyproject.toml 中读取(例如包含/排除模式)。
- 力求生成尽可能小的差异,项目称这使代码审查更快。
- 包含一项安全检查,确保重新格式化的代码仍产生与原始代码有效等价的 AST;--fast 标志可跳过此检查。
- 声称 PEP 8 合规,并有规范样式更改的稳定性策略。
安装和使用:
- 通过 pip install black 安装;需要 Python 3.10 或更高版本。
- 通过 black[jupyter] 扩展支持 Jupyter Notebook 格式化。
- GitHub releases 提供独立构建的 PyInstaller 可执行文件,供没有 Python 安装的用户使用。
- 运行方式:black {source_file_or_directory} 或 python -m black {source_file_or_directory}。
生态和采用情况:
README 列出了许多使用 Black 的开源项目,包括 pytest、tox、Pyramid、Django、Django Channels、Hypothesis、attrs、SQLAlchemy、Poetry、PyPA 应用程序、pandas、Pillow、Twisted、LocalStack、Home Assistant、Zulip 和 Kedro。还提到了 Dropbox、Lyft、Mozilla、Quora、Duolingo 和 Tesla 等组织作为用户。引用了 Mike Bayer、Hynek Schlawack、Kenneth Reitz 和 Carl Meyer 等开发者的证言。
该项目采用 MIT 许可证,在 ReadTheDocs 上提供文档,在单独的文件中维护变更日志和作者列表,并通过贡献文档和 Discord 频道邀请贡献。它还引用了 Python 社区行为准则。
评论
0 评分人数达到10人后显示
登录后参与讨论。