Black 在 PyCharm 中的集成方式内置、BlackConnect、外部工具、文件监视器怎么选【免费下载链接】blackThe uncompromising Python code formatter项目地址: https://gitcode.com/GitHub_Trending/bl/black如果你已经在用 PyCharm希望不离开 IDE 就能用 Black 格式化 Python 文件需要先解决一个选择问题官方文档 docs/integrations/editors.md 中 PyCharm/IntelliJ IDEA 一节列出了四种接入方式它们的安装成本、触发方式各不相同。本文按文档逐条给出每种方式的完整配置步骤并基于文档给出的定位说明帮你确定该走哪一条。四种方式都要求先安装 Blackpip install black或其带dextra 的变体差异在于 PyCharm 侧的接入配置。四种方式怎么选先按文档给出的定位和触发模型缩小范围方式安装前提如何触发格式化文档给出的定位内置集成pip install blackPyCharm 2023.2 及以后版本在Tools - Black入口中配置simplest to set up最简单BlackConnect 本地服务器pip install black[d] BlackConnect 插件Code - Reformat Code或快捷键可选在保存时触发formats the fastest格式化最快通过本地blackdHTTP 服务器避免每次格式化都启动新进程外部工具External Toolpip install black菜单Tools - External Tools - black可选配快捷键按文档配置手动对当前打开的文件执行文件监视器File Watcherpip install black File Watchers 插件监视的文件变化时自动运行black文档以 PyCharm File Watchers 为例说明如何用 stdio 模式接入选择逻辑可以归纳为PyCharm 版本在 2023.2 及以上、只想最少配置走内置集成格式化频繁、在意每次启动 Black 进程的开销走 BlackConnect 本地服务器想手动对当前文件执行格式化命令走外部工具希望文件变化时自动格式化走文件监视器。下面按推荐程度依次给出每种方式的操作步骤。方式一内置集成PyCharm 2023.2 及以后这是文档标注最简单的路径前提是 PyCharm 版本为 2023.2 或更高。安装 Black$ pip install black打开Preferences or Settings - Tools - Black按文档说法在此按你的喜好完成 Black 的配置configure Black to your liking。文档对该方式的说明仅到此为止它依赖 PyCharm 自带的 Black 集成不需要额外插件也没有需要手工填写路径的步骤。如果你的 PyCharm 满足版本要求可以先走这条路。方式二BlackConnect 本地服务器blackd文档定位这是四种方式中格式化最快的一种插件会拉起blackdBlack 的 HTTP 服务器to avoid the startup cost on subsequent formats即避免后续每次格式化都承担进程启动成本。blackd的详细协议见 docs/usage_and_configuration/black_as_a_server.md。安装带dextra 的 Blackblackd默认不随 Black 一起打包有额外依赖必须这样安装$ pip install black[d]安装 BlackConnect IntelliJ IDEs 插件在 IDE 的插件市场安装即可。打开插件配置macOSPyCharm - Preferences - Tools - BlackConnectWindows / Linux / BSDFile - Settings - Tools - BlackConnect在Local Instance (shared between projects)区域勾选Start local blackd instance when plugin loads点击Path输入框旁边的Detect按钮。文档预期the plugin should detect theblackdexecutable——如果 Detect 能识别到blackd可执行文件说明第 1 步安装可用识别不到时回头检查pip install black[d]是否装进了当前 IDE 使用的解释器环境。在Trigger Settings区域勾选Trigger on code reformat启用用 Black 做代码重格式化。格式化当前打开的文件选择Code - Reformat Code或用它对应的快捷键。可选希望每次保存都运行 Black则在Trigger Settings中再勾选Trigger when saving changed files。另外需要知道一条限制blackd没有针对滥用的安全防护文档明确警告它只应作为本地服务运行It is intended for local use only不要把它暴露为可公网访问的服务器。如果想脱离插件单独确认blackd本身工作正常可以按服务器文档给出的命令手动验证以下代码块照抄自文档blackd --bind-port 9090 # or let blackd choose a port curl -s -XPOST localhost:9090 -d print(valid)blackd对格式化请求的响应码含义来自服务器文档的协议一节HTTP 204表示输入已符合格式响应体为空HTTP 200表示需要格式化响应体是格式化后的代码HTTP 400表示输入有语法错误HTTP 500表示其他格式化错误。方式三外部工具External Tool这条路径把black配置成 PyCharm 的一个外部工具通过菜单项手动对当前打开的文件执行格式化。安装 Black$ pip install black找到black的安装位置。macOS / Linux / BSD$ which black /usr/local/bin/black # possible locationWindows$ where black C:\Program Files\Python313\Scripts\black.exe # possible location上面两行输出是文档给出的可能的安装位置示例你的实际输出会因安装环境不同而变化以你本机命令的真实输出为准。文档特别说明如果 PyCharm 已经识别了你使用的虚拟环境这一步可以省略此时black的路径直接写$PyInterpreterDirectory$/black$PyInterpreterDirectory$是 PyCharm 的配置变量指代当前项目解释器的安装目录。打开外部工具设置macOSPyCharm - Preferences - Tools - External ToolsWindows / Linux / BSDFile - Settings - Tools - External Tools点击图标新增一个外部工具字段值如下Name:BlackDescription:Black is the uncompromising Python code formatter.Program: 第 2 步得到的black路径虚拟环境场景下为$PyInterpreterDirectory$/blackArguments:$FilePath$其中$FilePath$是文档原样给出的参数格式化时将展开为当前文件的完整路径。格式化当前打开的文件选择Tools - External Tools - black。可选在Preferences or Settings - Keymap - External Tools - External Tools - Black下设置键盘快捷键之后直接按键触发。方式四文件监视器File Watcher这条路径让 Black 在 Python 文件变化时自动运行无需手动触发。安装 Black$ pip install black找到black的安装位置命令与虚拟环境场景下的处理方式同方式三第 2 步which black/where black或使用$PyInterpreterDirectory$/black此处不再重复。确认已安装 File Watchers 插件文档要求 Make sure you have the File Watchers plugin installed。打开Preferences or Settings - Tools - File Watchers点击添加一个新的监视器字段值如下Name:BlackFile type:PythonScope:Project FilesProgram: 第 2 步得到的black路径Arguments:$FilePath$Output paths to refresh:$FilePath$Working directory:$ProjectFileDir$这里出现的$FilePath$、$ProjectFileDir$都是文档原样给出的 PyCharm 监视器配置变量分别表示被监视文件的路径和项目文件目录保持原样填入即可。在 Advanced Options 中做两项取消勾选取消Auto-save edited files to trigger the watcher取消Trigger the watcher on external changes配置完成后项目内的 Python 文件发生变化时监视器会按上面的 Program 和 Arguments 调用black处理该文件并刷新对应的输出路径。限制与注意事项内置集成仅适用于 PyCharm 2023.2 及以后的版本文档给出的版本边界就是这个低版本 PyCharm 只能选择后三种方式之一。BlackConnect 方式依赖blackd必须用pip install black[d]安装且blackd仅限本地使用不要暴露到公网。外部工具和文件监视器两种方式都需要手工提供black的可执行路径除非 PyCharm 识别到了你的虚拟环境此时统一使用$PyInterpreterDirectory$/black。文档标题为 PyCharm/IntelliJ IDEA上述四种方式的设置路径Preferences与Settings菜单差异除外同样适用于 IntelliJ IDEA。各方式的完整字段与命令以 docs/integrations/editors.md 的 PyCharm/IntelliJ IDEA 一节为准blackd的请求头、协议细节见 docs/usage_and_configuration/black_as_a_server.md。【免费下载链接】blackThe uncompromising Python code formatter项目地址: https://gitcode.com/GitHub_Trending/bl/black创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考