Pycharm使用black作为Python代码格式化外部工具

Pycharm菜单Code->Reformat Code能对Python代码进行格式化,但是black能进一步规范格式,它是PEP8的严格子集。

本次操作的相关环境信息如下:Pycharm 2018版,Python3.6,(注意,写本文时的black只支持在Python3.6环境使用,以后应该会更新支持)

具体步骤如下:

第一步 安装black:

在Pycharm菜单File->Settings...->Project ***(此处的***是你自己的某个Python项目名)->Project Interpreter->在右侧的Project Interpreter下拉列表框中选中自己Python版本的解释器(例如Python 3.6)->在下拉列表中查看是否有black,如果没有则需要安装。

安装balck的方式有2种:

方式一、从命令行安装:例如Windows的cmd窗口,运行命令pip install black

方式二、从PyCharm中安装(推荐使用这种方式):接上一步操作,在打开的Settings的窗口中,单击列表区右侧靠上方的按钮“+”,弹出Available Packages窗口,在此窗口的搜索栏中,输入black,然后在列表中选中black,单击窗口底部的Install Package,稍等,提示安装成功。安装过程和结果也能在PyCharm主窗口底部的状态栏中指示。 如果按钮“+”号为灰色,不能单击的话,此时注意Setting窗口底部有红色的提示文本的超链接Python packing tools not found. Install packaging tool,单击此链接,先安装包工具,稍等片刻,等待PyCharm状态更新完毕后,在此打开Settings窗口,就能看到按钮“+”号为黑色,其可单击了。

第二步 配置black作为外部工具

在PyCharm菜单File->Settings...->Tools->External Tools->单击按钮“+”号->在弹出的“Create Tool”窗口中的name框中输入一个名字作为在以后的Pycharm菜单Tools->External Tools菜单中显示的名字,例如在此输入名字为BlackFormatter。在Programs中输入black安装后的black.exe文件所在目录。该目录在Windows的cmd窗口中通过命令where black查找到,在Linux中用命令which black查找。例如找到如下路径:C:\Anaconda3_5.2.0(64-bit)\Scripts\black.exe,将此包含balck.exe文件名的全路径填入到Programs框中。在Arguments中填入$FilePath$,在Working Directory中填入$ProjectFileDir$。然后单击OK即可。

至此,配置完成。下面使用black进行格式化。

选中需要格式化的Python代码文件,然后单击PyCharm菜单Tools->External Tools->BlackFormatter。即可看到格式化后的结果。

本文是在参考了https://blog.csdn.net/zV3e189oS5c0tSknrBCL/article/details/80429105文章“推荐一个小而美的Python代码格式化工具”,特此鸣谢! 但此文步骤过程不够细致且不是针对新版PyCharm的,经过本人摸索后,成功配置了black作为代码格式化外部工具,特此记录,希望对大家有所帮助。

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值