Pycharm IDE设置系列教程(二十二):代码质量协助技巧和窍门(上)
PyCharm是一种Python IDE,其带有一整套可以帮助用户在使用Python语言开发时提高其效率的工具。此外,该IDE提供了一些高级功能,以用于Django框架下的专业Web开发。
PyCharm最新版本2019.3现已发布,增加用于Jupyter笔记本的交互式小部件,MongoDB支持以及所有Python 3.8功能的代码帮助,还有其他功能改进提高Python语言开发效率!感兴趣的朋友欢迎下载体验~
本教程的内容?
本教程旨在通过使用PyCharm的代码智能功能,逐步引导您在Python项目中创建源代码。您将看到PyCharm如何通过适当的缩进,空格,导入等方式帮助您使源代码保持完美的形状-实际上,您会看到PyCharm本身就是代码质量工具。
在你开始前?
确保:
您正在使用PyCharm 5.0或更高版本。如果您仍然没有PyCharm,请从此页面下载 。要安装PyCharm,请根据您的平台按照说明进行操作。有关详细信息,请参阅产品文档。
您已经创建了一个Python项目(File | New Project ...)。
您已经创建了两个目录src和test_dir (File | New或Alt+Insert)。
您已将Python文件添加到项目的src和 test_dir目录(File | New或 Alt+Insert)。
高亮代码
创建一个新的Python文件src / Solver.py Alt+Insert。创建的文件将立即打开以进行编辑。默认情况下,该文件没有内容-这是因为Solver.py文件是由文件模板创建的(对于Python文件而言)仅包含任何内容。
接下来,开始输入关键字class。当您刚开始输入内容时,PyCharm会立即显示建议列表以完成您的代码:
红色曲线标记了下一个预期的条目-在这种情况下,这是预期的标识符。输入班级名称Solver。红色曲线在班级名称之后移动。如果将鼠标指针悬停在此曲线上,则会看到错误说明(“预期冒号”)。另外,请注意右侧装订线中的红色错误条-它也标记了相同的错误:
确定,键入冒号,然后按Enter。根据Python代码样式,下一条语句缩进。如果偶然在之后按空格Enter,则将违反代码样式设置。
调整PEP8检查?
但是,默认情况下,这些违规行为只是微弱的警告,因此不可见。因此,首先让我们提高它们的重要性。在主工具栏上单击,在“ 设置/首选项”对话框的“ 检查”页面上,键入PEP8以查找所有与PEP8相关的检查,然后从“严重性”下拉列表中选择“ 警告”:
应用更改并关闭对话框。现在让我们回到源代码。
跟踪PEP8规则?
现在,PyCharm发挥出了自己的最大优势!它可以保护您的代码样式的完整性。您立即注意到缩进的空间被突出显示,并且,当您键入下def demo(self,a,b,c):一条语句时,例如 ,PyCharm将显示来自PEP8检查的消息:
因此,如您所见,PyCharm支持PEP8作为官方Python样式指南。如果你探索的检查列表(Ctrl+Alt+S- 检查),你会看到PyCharm启动 pep8.py您的代码工具,精确定位代码风格的侵犯。
代码检查及其设置?
顺便说一句,更专心地检查检查。如果您刚刚打开此页面,则将看到具有默认设置的默认检查配置文件:这意味着检查适用于当前项目的所有源。
让我们尝试针对两个不同的范围自定义此配置文件:
在测试范围中,拼写错误应标记为错别字(绿色)
在生产范围中,拼写错误应标记为错误(红色)-我们是否可以实际产生带有错别字的代码?
创建范围?
首先,让我们定义两个范围。为此,请单击主工具栏上的,在“ 设置/首选项”对话框中,展开节点“ 外观和行为”,然后打开“ 范围 ”页面。然后单击并选择范围类型Local。
在“ 添加新作用域”对话框中,键入作用域名称(Test),然后在项目树中,选择要包含在“测试作用域”中的目录test_dir。请注意,当您包含目录时,“ 模式”字段会自动填写:
重复此过程以创建生产范围。
使用这些范围创建检验配置文件?
接下来,让我们创建默认配置文件的副本(尽管此配置文件是可编辑的……为了安全起见):
并为其重新命名,例如MyProjectProfile。此新配置文件是默认配置文件的副本,并且具有相同的检查集。
选择此新配置文件后,让我们找到并检查拼写检查。要查找拼写检查(我们之前已经做过),只需spel在搜索区域中键入即可。
下一步是什么?单击“所有作用域”按钮,然后从列表中选择“测试”作用域;对生产范围重复相同的操作
在“测试”范围内,检查严重性保持不变(错别字);但是,在“生产”范围内,我们将从严重性列表中选择“错误”:
注意检查的颜色代码。如果未更改,则显示为黑色。如果它们是蓝色,则表示它们已被更改。
应用更改并关闭对话框...
因此,修改后的检查配置文件已准备就绪。它的名称是Project Default(副本),并且在Test和Production范围中具有不同的拼写检查设置。接下来,让我们根据此配置文件检查代码。为此,请在主菜单上选择“代码” |“检查代码”,然后在对话框中选择所需的配置文件和范围:
进行两次-对于“测试”和“生产”范围(如果要保留检查结果以供进一步检查和共享,则可以将其导出)。探索结果:
突出显示错误?
除了违反编码风格外,PyCharm还会根据所选配置文件突出显示其他错误。
例如,如果您的检查配置文件包含Python检验 未解决的引用,并且您使用了尚未导入的符号,则PyCharm会在未解决的引用下划线并建议添加import语句:
=====================================================
有关详细信息,请继续关注我们接下来的教程“Pycharm IDE设置系列教程”。我们很快就会发布其他文章。
想要了解或购买PyCharm正版授权的朋友可以。