在文档文件中的python代码块上运行“black”

blacken-docs的Python项目详细描述


Build StatusCoverage Status

黑色文档

在文档文件中的python代码块上运行black

安装

pip install blacken-docs

用法

blacken-docs提供一个可执行文件(blacken-docs),它将修改 .rst/.md文件就位。

它当前支持以下^{} 选项:

  • -l/--line-length
  • -t/--target-version
  • -S/--skip-string-normalization

可以使用以下附加参数:

  • -E/--skip-errors

blacken-docs将格式化以下块类型的代码:

(降价)

    ```python
    def hello():
        print("hello world")
    ```

(重新设置)

    ..code-block::pythondefhello():print("hello world")

与预提交一起使用

有关说明,请参见pre-commit

样本.pre-commit-config.yaml

-repo:https://github.com/asottile/blacken-docsrev:v1.3.0hooks:-id:blacken-docsadditional_dependencies:[black==...]

由于black当前是一个移动目标,建议锁定black 使用additional_dependencies转到特定版本。

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java密钥安全如何确保密钥安全?   java Webelement屏幕截图错误   java Selenium:我正在使用Firefox版本46.01,并在显示的ECLIPSE错误消息中进行了测试   javascript Jquery自动完成不向java传递值   javajavax。坚持不懈persistenceexception eclipselink4002(eclipse持久性服务2.5.2.v 20140319   java检查大型HashMap是否包含键的最佳方法?   java如何解决连接mssql时的JNDI错误   modelandview内部重定向和重定向之间的java差异   swing如何处置未使用的JavaUI对象   java在数组中多次存储同一引用项,一次更改会影响所有引用项吗?   java项目Euler#14:为什么我的树形映射算法比暴力慢?   java如何使用不同的分隔符连接配置单元列   java在部署在不同服务器上的两个WAR之间共享pojo对象   Spring控制器中的java JSR303验证和获取@JsonProperty名称   java检查playstore是否安装了Android应用程序   java从一段字符串中选择一个单词?   当发生特定选择时显示组合框的java   大量调用后,构造函数中的JAVA数组复制速度异常缓慢   java无法使用KeyListner移动我的图像   使用Spring MVC和线程保存java实体