1. 程式人生 > 程式設計 >在 Pycharm 安裝使用black的方法詳解

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

PyCharm是一種Python IDE,帶有一整套可以幫助使用者在使用Python語言開發時提高其效率的工具,比如除錯、語法高亮、Project管理、程式碼跳轉、智慧提示、自動完 成、單元測試、版本控制。此外,該IDE提供了一些高階功能,以用於支援Django框架下的專業Web開發。

簡介

針對程式碼風格不一致問題,導致的維護成本過高,針對性的鎮定程式碼風格統一標準,是很有必要的。目前市面上用的比較多的python程式碼格式化工具有YAPF、Black。

Black,號稱不妥協的程式碼格式化工具,它檢測到不符合規範的程式碼風格直接就幫你全部格式化好,根本不需要你確定,直接替你做好決定。從而節省關注程式碼規範的時間和精力,關注程式設計。

安裝 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

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

新增一個新的擴充套件工具

配置資訊如下:

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$

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

如何使用 black 格式化程式碼

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

在程式碼區域按滑鼠右鍵,選擇 External Tools 中的 black

設定快捷鍵執行 black 格式化程式碼

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

在 Pycharm 安裝使用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"

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

特殊說明

兩個設定中的引數Program使用 which black 查詢出來的路徑資訊。

到此這篇關於在 Pycharm 安裝使用black的方法詳解的文章就介紹到這了,更多相關 Pycharm 安裝使用black內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!