在 Pycharm 安装使用black的方法详解

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

这篇文章主要介绍了如何在 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

添加一个新的扩展工具

配置信息如下：

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 来格式化代码。

在代码区域按鼠标右键，选择 External Tools 中的 black

设置快捷键执行 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"

特殊说明

两个设置中的参数Program使用 which black 查询出来的路径信息。

到此这篇关于在 Pycharm 安装使用black的方法详解的文章就介绍到这了,更多相关 Pycharm 安装使用black内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

Python命令行参数argv和argparse该如何使用
这篇文章主要介绍了Python命令行参数argv和argparse该如何使用，帮助大家更好的理解和学习使用python，感兴趣的朋友可以了解下
2021-02-02
Pycharm远程连接服务器跑代码的实现
本文主要介绍了Pycharm远程连接服务器跑代码的实现，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2022-07-07
python算法测试结果自动保存到excel表格的实现步骤
我们在进行算法评估是通常会针对每个样本的算法处理结果进行统计,例如每个样本正确预测数量、漏检数量和误检数量、精度等,本文小编将给大家介绍python算法测试结果自动保存到excel表格的实现步骤,感兴趣的朋友可以参考下
2023-12-12
NCCL深度学习Bootstrap网络连接建立源码解析
这篇文章主要为大家介绍了NCCL深度学习Bootstrap网络连接建立源码解析，有需要的朋友可以借鉴参考下，希望能够有所帮助，祝大家多多进步，早日升职加薪
2023-04-04
Python DataFrame.groupby()聚合函数,分组级运算
python的pandas包提供的数据聚合与分组运算功能很强大，也很灵活，本文就带领大家一起来了解groupby技术，感兴趣的朋友跟随小编一起来看下
2018-09-09
神经网络训练采用gpu设置的方式
这篇文章主要介绍了神经网络训练采用gpu设置的方式，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-03-03
Python实现找出数组中第2大数字的方法示例
这篇文章主要介绍了Python实现找出数组中第2大数字的方法,涉及Python针对数组的排序、遍历等相关操作技巧,需要的朋友可以参考下
2018-03-03
Python项目跨域问题解决方案
这篇文章主要介绍了Python项目跨域问题解决方案,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-06-06
Python:通配符查找、拷贝文件的操作
这篇文章主要介绍了Python:通配符查找、拷贝文件的操作，具有很好的参考价值，希望对大家有所帮助。一起跟随小编过来看看吧
2021-04-04
python元组的可变与不可变问题
这篇文章主要介绍了python元组的可变与不可变问题，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-12-12