PyCharm编辑器结合Black插件,轻松实现Python代码格式化

开发 前端
使用Black对Python代码进行格式化,可使代码看起来更美观。但是,随着项目规模不断变大,对每个文件运行Black变得很繁琐。能否在文件保存后立即运行Black呢?本文就来介绍在PyCharm中实现这一目标的方法。

1、简介

使用Black对Python代码进行格式化,可使代码看起来更美观。但是,随着项目规模不断变大,对每个文件运行Black变得很繁琐。能否在文件保存后立即运行Black呢?本文就来介绍在PyCharm中实现这一目标的方法。

2、安装Black

首先,在虚拟环境中安装Black。

$ pip install black

也可以从PyCharm首选项中安装该软件包。

  • PyCharm > Preferences。
  • 搜索“Python Interpreter”。
  • 点击“+”图标,并输入“Black”。
  • 点击安装软件包。

图片图片

安装完Black后,点击“Apply(应用)”和“OK(确定)”。

3、Black基本设置

需要再次打开首选项。这次搜索外部工具。

  • Preference > Tools > External Tools。
  • 点击“+”图标。
  • 在名称输入框中填写想要的名称,并添加一些描述。
  • 在工具设置中,按以下方式更新。
Programs: $PyInterpreterDirectory$/black
Arguments: $FilePath$
Working directory: $ProjectFileDir$

图片图片

  • 点击“OK(确定)”

现在,已经完成了Black的基本设置,这样就可以通过转到“Tools(工具)”>“External Tools(外部工具)”>“Black”来格式化任何文件。

图片图片

4、自动保存时运行Black

但是,如果必须对每个文件都这样做,那么它怎么解决自动保存时运行Black的问题呢。

现在需要再次进入首选项。

  • Preferences > 搜索“File Watchers(文件监视器)”。
  • 在Tools > File Watchers下,点击“+”图标。
  • 选择“custom(自定义)”。

图片图片

在弹出的对话框中,

  • 在“Name(名称)”中输入选择的名称。
  • 在文件类型中选择“Python”。
  • 在“tool to run on changes(更改时运行的工具)”中输入以下内容。
Program: $PyInterpreterDirectory$/black
Arguments: $FilePath$
Output paths to refresh: $FilePath$
Working directory: $ProjectFileDir$

图片图片

点击“OK(确定)”,然后就可以开始使用了。

现在,只需重新启动PyCharm实例,就可以见证“Black”的强大功能。

责任编辑:武晓燕 来源: Python学研大本营
相关推荐

2019-05-17 13:20:57

Black格式化工具Python

2010-08-03 10:46:41

Flex代码格式化

2022-03-28 13:24:52

Shell脚本代码

2010-08-02 16:25:03

ibmdwJDT

2010-08-10 13:35:26

Flex代码格式化

2020-07-15 15:12:17

Python代码编辑器编程语言

2009-08-03 14:25:59

C#日期格式化

2015-01-07 15:21:30

Android Stu代码格式化

2011-04-01 09:11:14

Python

2010-07-29 11:03:53

Flex代码格式化

2024-01-08 22:03:22

python代码开发

2009-06-11 10:03:57

NetBeans代码

2010-10-28 15:32:42

oracle日期格式化

2017-03-09 19:25:38

JavaScript代码编辑器

2020-09-27 08:43:33

MuPythonturtle 模块

2023-10-10 16:04:30

图形编辑器格式转换

2023-04-07 08:02:30

图形编辑器对齐功能

2023-10-19 10:12:34

图形编辑器开发缩放图形

2023-02-01 09:21:59

图形编辑器标尺

2022-03-10 10:24:45

Vim代码Linux
点赞
收藏

51CTO技术栈公众号