Pycharm IDE设置系列教程(二十二):代码质量协助技巧和窍门(下)
PyCharm是一种Python IDE,其带有一整套可以帮助用户在使用Python语言开发时提高其效率的工具。此外,该IDE提供了一些高级功能,以用于Django框架下的专业Web开发。
PyCharm最新版本2019.3现已发布,增加用于Jupyter笔记本的交互式小部件,MongoDB支持以及所有Python 3.8功能的代码帮助,还有其他功能改进提高Python语言开发效率!感兴趣的朋友欢迎下载体验~
生成源代码
PyCharm提供了许多自动生成代码的可能性。您可以在产品文档中探索自动生成功能。让我们探索主要的代码生成过程。为此,只需删除文件Solver.py的所有内容,然后从头开始。
首先,创建一个类的实例:
接下来,按Alt+Enter并选择意图动作 创建类'Solver':
PyCharm设置了一个类:
接下来,让我们向类实例添加一个方法。为此,请在类实例之后键入一个点,然后键入方法名称。该方法尚不存在,PyCharm建议创建一个方法:
让我们做一些手工工作-输入源代码。在计算判别式时,我们必须提取平方根。有一个专门的函数sqrt库 math,但没有进口。好的,无论如何都要键入它,然后看看PyCharm如何处理它。按,Alt+Enter然后选择导入'math':
因此,我们来到了这样的源代码:
import mathclass Solver(object): def demo(self,a,b,c): d = b ** 2 - 4 * a * c disc = math.sqrt(d) root1 = (- b + disc) / (2 * a) root2 = (- b - disc) / (2 * a) print (root1, root2) return root1, root2
但是,它缺乏一些重要的分析。我们想分析radicand d。如果为零或正,则将计算判别式和方程根。当radicand为负数时,让我们提出一个例外。PyCharm如何帮助完成这项任务?
让我们用ifConstruct 包围一段代码。选择要完成的语句(如果d为非负数),然后按Ctrl+Alt+T (或在主菜单上选择“代码” |“环绕”):
if从建议列表中选择选项。如您所见,PyCharm自动添加if True:并缩进选定的行:
我们对布尔表达式完全不感兴趣,因此让我们将selected更改 True为d >= 0。接下来,将插入号放在最后一行的末尾,然后按Enter。插入符位于下一行,其缩进与if语句相同;输入else: clause here,然后查看有关预期缩进的PyCharm报告:
Enter再次按下时,插入标记将停在缩进位置。在这里,您可以使用PyCharm强大的自动代码完成功能键入异常表达式:
重新格式化代码
让我们再次看看我们的Solver.py文件。其右装订线显示黄色条纹。当您将鼠标指针悬停在条纹上时,PyCharm将在代码中显示相应问题的描述:
好消息是它们只是警告,不会影响结果。坏消息是它们太多了,无法一一修复。是否可以使源代码漂亮又漂亮,而不必大惊小怪?
PyCharm说-是的。这是代码重新格式化的功能。因此,让我们尝试更改整个文件的格式。为此,请按Ctrl+Alt+L(或在主菜单上选择“代码” |“重新格式化代码”):
现在看一下代码-与PEP8相关的弊端都消失了。
请注意,您可以自己定义格式设置规则。为此,请打开代码样式设置,选择语言(在本例中为Python),然后进行必要的更改:
添加文档注释
好的,格式化现在已修复,但仍有一些条纹。不可避免的黄色灯泡显示了添加文档字符串注释的可能性:
选择此建议,并查看文档字符串注释中添加的某些参数:
请注意,您必须在编辑器设置的文档注释存根页面的插入类型占位符中选中 文档注释字符串中的插入类型占位符复选框:
有多种docstring格式,并且文档注释以您在Python Integrated Tools页面中选择的格式创建。如果愿意,可以将文档字符串格式更改为Epytext或纯文本。
类型提示
文档注释可用于定义参数,返回值或局部变量的预期类型。我们为什么需要这一切?例如,我们希望控制传递给该demo()方法的参数的类型。为此,我们将相应的信息添加到文档注释中(顺便说一下,请注意文档注释中的代码完成!):
接下来,当您查看方法调用时,您会看到PyCharm的检查类型检查器突出显示了错误的参数:
=====================================================
有关详细信息,请继续关注我们接下来的教程“Pycharm IDE设置系列教程”。我们很快就会发布其他文章。
想要了解或购买PyCharm正版授权的朋友可以。