当前位置: 首页 > 科技观察

推荐一款小巧美观的Python代码格式化工具

时间:2023-03-20 18:20:21 科技观察

代码可读性是判断代码质量的标准之一。衡量代码质量的标准之一是Martin提出的“WFT”定律,即“WTF”每分钟爆发一次。在阅读别人的代码或做CodeReview时,你是否有一种“WTF”的冲动?为了帮助开发者统一代码风格,Python社区提出了PEP8代码编码风格。它并不强制要求每个人都必须遵守。Python官方还推出了一个工具来检查代码风格是否符合PEP8。名字也叫pep8,后来改名为pycodestyle。看下面的代码:这是一个不符合PEP8的代码段。使用pycodestyle检测不符合PEP8风格的地方。pycodestyle提示我们有两个地方不符合规范。第一个是一行里面有多个import,第二个是class和module之间有两个空行。这只是一个简单的代码示例,而真正的业务代码可能有以上几百行甚至上百行,如果我们要按照PEP8规范一一修改和建议,会非常耗时,并且在我们的开发过程中,如果时刻关注每一行代码是否完全符合PEP8,会影响开发效率。而有这么一款工具Black,号称是不折不扣的代码格式化工具,为什么叫不折不扣呢?因为它检测到不符合规范的代码风格,它会直接给你格式化,不需要你确认,直接给你做决定。它也是请求作者最喜欢的工具之一。这是非常容易使用。安装成功后,就可以像其他系统命令一样使用了。你只需要在black命令后指定要格式化的文件或目录即可。blacklink.py这是一个小而美的工具。它没有完全按照PEP8规范进行格式化。比如每行代码默认的字符数是88,当然你可以通过参数-l自定义长度,可以一行显示完成的代码会放在一行,比如a包含多个元素的列表。将多个元素放在一行上显然可读性更好,代码也更紧凑(如果你的工资是按照代码行数计算的,不建议这样做),Black是PEP8的严格子集。我的最佳做法是将PyCharm自己的格式化工具与Black一起使用。因为Black也支持集成到Pycharm中。如何集成Pycharm?1.安装black:pipinstallblack2。找到black$whichblack#linux/mac$whereblack#windows3的安装路径。添加扩展工具,打开Preferences->Tools->ExternalTools,添加一个新的扩展工具,Program填写黑色的安装路径,Arguments填写$FilePath$4,选择Tools->ExternalTools->Black格式化西瓜代码当前打开的文件,当然你也可以给它指定一个快捷键,让操作更方便。值得注意的是本工具只支持Python3.6环境