在文档代码片段上运行black
项目描述
blackdoc 是一个将 black 应用于文档中代码的工具。
最初是gist 的重写，名为 black-doctest。2020年4月，它被重命名为 blackdoc。
安装
依赖项
使用以下命令安装它
python -m pip install blackdoc用法
命令行界面支持两种模式：检查和就地重排。
python -m blackdoc --help在就地重排模式下，它将重排doctest行并将它们写回磁盘
# on explicitly mentioned files
python -m blackdoc file1.py file2.py
# on the whole directory
python -m blackdoc .在检查模式下，它将报告已更改的文件但不会将它们写入磁盘
python -m blackdoc --check .还可以使用入口脚本
blackdoc --helppre-commit
此存储库定义了一个 pre-commit 钩子
hooks:
...
- repo: https://github.com/keewis/blackdoc
rev: 3.8.0
hooks:
- id: blackdoc建议将 black 锁定，以避免每个贡献者都有不同版本。要自动将此锁定与 black 钩子的版本同步，请使用 blackdoc-autoupdate-black 钩子
hooks:
...
- repo: https://github.com/psf/black
rev: 23.10.1
hooks:
- id: black
...
- repo: https://github.com/keewis/blackdoc
rev: 3.8.0
hooks:
- id: blackdoc
additional_dependencies: ["black==23.10.1"]
- id: blackdoc-autoupdate-black请注意，此钩子不会在 pre-commit autoupdate 上运行。
下载文件
下载您平台对应的文件。如果您不确定选择哪个，请了解更多关于安装包的信息。
源分布
blackdoc-0.3.9.tar.gz (39.0 kB 查看哈希值)
构建分布
blackdoc-0.3.9-py3-none-any.whl (35.9 kB 查看哈希值)
关闭
blackdoc-0.3.9.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | b1da5ca93550081fc3f1b34bfdc731431ee74c378ea63abb31771a222ef5d053 |
|
| MD5 | 3cb247765e3b86fc871ceb4d72143d0c |
|
| BLAKE2b-256 | 2e3c7d47d200211adc793789ae9363096ed693a7ec1e7fd9afad49e0684070cc |
关闭
blackdoc-0.3.9-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 2de4ad14993705e6b1fd89b0aa117566ac0c6980f218d6012f22d7cf6f5b2f34 |
|
| MD5 | 8f4cc09bdd93e443ab701f3ea9c06fae |
|
| BLAKE2b-256 | aac2d9e0cbc72dbf90d23514954d69db12b3b4e547038fbcdcf7a4e50799f530 |