在Foundry代码仓库中使用Black自动格式化代码的方法咨询

• 完全可以在Foundry代码仓库里用Black实现代码自动格式化，而且开发阶段就能直接用上，不一定需要修改setup.py。
• 既然你已经导入了Black，直接在终端执行命令就能手动格式化：
  • 格式化当前目录及子目录下所有Python文件：black .
  • 格式化单个指定文件：black your_target_script.py
• 要在开发阶段自动触发格式化，推荐两种实用方式：
  • 用pre-commit钩子：在仓库根目录创建.pre-commit-config.yaml文件，写入以下配置：

    repos:
    -   repo: https://github.com/psf/black
        rev: 23.10.1  # 替换成你想用的Black版本
        hooks:
        -   id: black
    

    然后安装pre-commit工具，执行pre-commit install，之后每次提交代码前Black会自动格式化改动的文件。
  • 编辑器集成：比如在VS Code中安装Black插件，开启「保存时自动格式化」的设置，写代码时就能实时完成格式化。
• 关于setup.py的修改：只有当你需要把Black标记为项目的开发依赖（方便其他开发者一键安装），或者要绑定打包时的格式化逻辑时才需要改。如果要加开发依赖，可以在setup.py的extras_require中添加：

  extras_require={
      "dev": ["black>=23.10.1"]
  }
  

  不过更推荐用单独的requirements-dev.txt来管理开发依赖，会更清晰。

内容的提问来源于stack exchange，提问作者BasePlateN7