在 Pycharm 安裝使用black的方法詳解

更新時間：2020年04月02日 08:33:20 作者：studytime

這篇文章主要介紹了如何在 Pycharm 安裝使用black的相關知識，本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下

PyCharm是一種Python IDE，帶有一整套可以幫助用戶在使用Python語言開發(fā)時提高其效率的工具，比如調試、語法高亮、Project管理、代碼跳轉、智能提示、自動完成、單元測試、版本控制。此外，該IDE提供了一些高級功能，以用于支持Django框架下的專業(yè)Web開發(fā)。

簡介

針對代碼風格不一致問題，導致的維護成本過高，針對性的鎮(zhèn)定代碼風格統(tǒng)一標準，是很有必要的。目前市面上用的比較多的python代碼格式化工具有YAPF、Black。

Black，號稱不妥協(xié)的代碼格式化工具，它檢測到不符合規(guī)范的代碼風格直接就幫你全部格式化好，根本不需要你確定，直接替你做好決定。從而節(jié)省關注代碼規(guī)范的時間和精力，關注編程。

安裝 black 擴展

pip3 install black

安裝目錄

➜ servers which black
/Library/Frameworks/Python.framework/Versions/3.6/bin/black
➜ servers where black
/Library/Frameworks/Python.framework/Versions/3.6/bin/black

測試命令行使用

➜ mws git:(feature/datawarehouse-v3.0.0) ✗ python3 -m black celery_tasks/__init__.py
All done! :sparkles: :cake: :sparkles:
1 file left unchanged.

pycharm 中集成 black

在 PyCharm 中打開 External tools

# On macOS:
PyCharm -> Preferences -> Tools -> External Tools

# On Windows / Linux / BSD:
File -> Settings -> Tools -> External Tools

添加一個新的擴展工具

配置信息如下：

Name: Black
Description: Black is the uncompromising Python code formatter.
Program: /Library/Frameworks/Python.framework/Versions/3.6/bin/black
Arguments: "$FilePath$"
Working directory: $ProjectFileDir$

如何使用 black 格式化代碼

通過選擇 Tools -> External Tools -> black 來格式化代碼。

在代碼區(qū)域按鼠標右鍵，選擇 External Tools 中的 black

設置快捷鍵執(zhí)行 black 格式化代碼

打開 Preferences or Settings -> Keymap -> External Tools -> External Tools - Black

black + File Watchers 自動格式化

確保 File Watchers插件可用，一般而言安裝Pycharm應該會默認安裝。

選擇 Preferences or Settings -> Tools -> File Watchers 添加一個新的 watcher

Name: Black
File type: Python
Scope: Project Files
Program: /Library/Frameworks/Python.framework/Versions/3.6/bin/black
Arguments: $FilePath$
Output paths to refresh: $FilePath$
Working directory: $ProjectFileDir$
Uncheck "Auto-save edited files to trigger the watcher"