代码质量辅助提示与技巧，或如何让您的代码看起来更漂亮？

本教程的内容

本教程旨在通过使用 PyCharm 的代码智能功能，逐步引导您在 Python 项目中创建源代码。您将看到 PyCharm 如何帮助保持您的源代码完美无缺，包括正确的缩进、空格、导入等。 ——实际上，您会发现 PyCharm 本身就是一个代码质量工具。

Python 编程不在本教程的范围内。有关 Python 语言的更多信息，请参阅官方网站。

在开始之前

确保：

您使用的是 PyCharm 5.0 或更高版本。如果您尚未拥有 PyCharm，请从此页面下载。要安装 PyCharm，请根据您的平台遵循相关说明。
您已创建一个 Python 项目（文件|新建项目...）。有关更多信息，请参阅产品文档。
您已创建两个目录源代码和 test_dir （文件|新建或 Alt+Insert）。
您已将 Python 文件添加到项目的源代码和 test_dir 目录中（文件|新建或 Alt+Insert）。有关创建文件的更多信息，请参阅填充项目部分。

突出显示代码样式违规

创建一个新的 Python 文件 src/Solver.py Alt+Insert。创建的文件会立即打开以供编辑。默认情况下，该文件没有内容——这是因为文件 Solver.py 是由文件模板创建的（对于 Python 文件来说），其中没有任何内容。

接下来，开始键入关键字 class。当您刚开始键入时，PyCharm 会立即显示建议列表以完成您的代码：

红色曲线标记了下一个预期的条目——在这种情况下，这是预期的标识符。输入类名 Solver。红色曲线移动到类名之后。如果您将鼠标悬停在此曲线上，您会看到错误描述（“：”预期）。此外，请注意右侧边栏中的红色错误条纹——它也标记了相同的错误：

输入冒号，并按 Enter。根据 Python 代码样式，下一条语句是缩进的。如果您不小心在 Enter 后按下空格键，您将因此违反代码样式设置。

调整 PEP 8 检查

转到设置|编辑器，并在检查页面上，键入 PEP 8 以查找所有与 PEP 8 相关的检查。默认情况下，PEP 8 编码样式违规不会被突出显示，而 PEP 8 命名约定违规只是弱警告，因此不可见。

因此，首先，让我们提高它们的重要性。从严重性下拉列表中选择警告：

应用更改并关闭对话框。现在让我们返回到我们的源代码。

跟踪 PEP 8 规则

当您键入下一条语句时，例如 def demo(self,a,b,c): ，PyCharm 将显示来自 PEP 8 检查的消息：

因此，正如您所见，PyCharm 支持 PEP 8 作为官方的 Python 样式指南。如果您查看检查列表（Ctrl+Alt+S - 检查），您会看到 PyCharm 在您的代码上启动了 pep8.py 工具，并指出了代码样式违规。

代码检查及其设置

更仔细地查看检查页面。如果您刚打开此页面，您会参考默认检查配置文件及其默认设置：这意味着检查适用于当前项目的所有源文件。

让我们尝试为两个不同的范围自定义此配置文件：

在测试范围内，拼写错误应标记为拼写错误（绿色）。
在生产范围内，拼写错误应标记为错误（红色）。

创建范围

首先，让我们定义这两个范围。为此，请点击主工具栏上的，在设置对话框中展开节点外观与行为，打开页面作用域。然后点击并选择范围类型局部。

在添加新范围对话框中，输入范围名称（测试），然后在项目树中选择要包含在测试范围内的目录， test_dir 。当您包含目录时， Pattern 字段会自动填充：

重复此过程以创建生产范围。

使用这些范围创建检查配置文件

接下来，让我们创建默认配置文件的副本。为此，请转到设置|编辑器|检查，点击，并在下拉列表中选择复制到项目…。

为其指定一个新名称，例如 MyProjectProfile。此新配置文件是默认配置文件的副本，并具有相同的检查集。

选择此新配置文件后，让我们找到拼写检查并更改它。

点击在所有范围中按钮，并从列表中选择测试范围。对生产范围重复相同操作。

在测试范围内，检查严重性保持不变（拼写错误），然而，在生产范围内，我们将从严重性列表中选择错误：

注意检查的颜色代码。如果未更改，它们显示为黑色。如果是蓝色，则表示它们已被更改。

应用更改并关闭对话框。

因此，修改后的检查配置文件已准备就绪。接下来，让我们根据此配置文件检查代码。为此，请转到主菜单中的代码 | 检查代码，并在对话框中选择所需的配置文件和范围：

执行两次——针对测试和生产范围（如果您希望保留检查结果以供进一步检查和共享，可以导出它们）。查看结果：

突出显示错误

除了编码样式违规外，PyCharm 还会根据所选配置文件突出显示其他错误。

例如，如果您的检查配置文件包含 Python 检查未解析的引用，并且您使用了尚未导入的符号，PyCharm 会下划线未解析的引用并建议添加导入语句：

生成源代码

PyCharm 提供了许多自动生成代码的可能性。您可以在产品文档中探索自动生成功能。让我们探索主要的代码生成过程。为此，只需删除文件 Solver.py 的所有内容，然后从头开始。

首先，创建一个类的实例：

接下来，按 Alt+Enter 并选择意图操作创建类 'Solver'：

PyCharm 已经生成了一个类的框架：

接下来，让我们为类实例添加一个方法。为此，在类实例后输入一个点，然后输入方法名称。此方法尚不存在，PyCharm 建议创建一个：

让我们做一些手动工作——输入源代码。当涉及到计算判别式时，我们必须提取平方根。库 math 中有一个专用函数 sqrt ，但尚未导入。让我们无论如何输入它，看看 PyCharm 如何处理它。按 Alt+Enter 并选择导入 'math'：

因此，我们得到了如下的源代码：

import math
class Solver():
            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
        
  

然而，它缺乏一些重要的分析。我们希望分析被开方数 d。如果它是零或正数，则会计算判别式和方程的根；当被开方数为负数时，让我们抛出一个异常。

让我们用 if 构造包围一段代码块。选择要完成的语句，当 d 为非负时，按 Ctrl+Alt+T （或从主菜单中选择代码 | 包围）：