什么是PEP8？

什么是PEP8？

在本文中，我们将解释PEP8及其在python中的使用。此外，我们将在编码时看到它的优势。

什么是PEP8？

PEP是Python Enterprise Proposal的缩写。用良好的逻辑编写代码是编程的一个关键方面，但许多其他重要元素也会影响代码的质量。开发人员的编码风格使代码更加可靠，每个开发人员都应该记住，Python 严格遵循字符串的顺序和格式。

良好的编码风格使代码更具可读性。为最终用户简化了代码

PEP 8 是一个文档，其中包含编写可读 Python 代码的各种准则。PEP 8 讨论了如何作为开发人员构建漂亮的代码。它由Guido van Rossum，Barry Warsaw和Nick Coghlan于2001年正式编写。PEP 的主要目标是提高代码的可读性和一致性。

PEP 8 已经发展成为大多数 Python 项目遵循的风格指南;它支持非常易读且具有视觉吸引力的代码样式。每个 Python 程序员都应该在某个时候阅读它;

以下是为您提供的一些要点。

凹痕

在Python中，与其他编程语言不同，缩进用于定义代码块。代码行的级别由缩进决定，缩进是 Python 编程语言的一个重要特征。通常，我们将 4 个空格用于缩进。

四空格规则并不总是必需的，对于延续行可以忽略。

例

def functionName(first_variable, second_variable, third_variable, fourth_variable): # giving 4 spaces for indentation print(first_variable)

使用文档字符串

在 Python 中，你可以同时使用单行和多行文档字符串。另一方面，单行注释适合一行;两种情况都使用三引号。这些用于定义特定程序或特定功能。

例

def tutorialspoint(): """It is an example for single line docstring""" """It is an example for multiline comment"""

行应换行，使其不超过 79 个字符

Python 标准库是保守的，要求行限制为 79 个字符。圆括号、方括号和大括号可用于换行。应优先使用它们，而不是反斜杠。

例

with open('/path/from/where/you/want/to/read/file') as fileOne, \ open('/path/where/you/want/the/file/to/be/written', 'w') as fileTwo: file_two.write(file_one.read())

命名约定

为了使程序不那么困难且更具可读性，应遵守一些命名标准。同时，Python的命名约定有点混乱，但这里有一些可以很容易地遵循。

根据总体原则，作为 API 的公共元素对用户可见的名称应遵循表示用法而不是实现的约定。

注意

在 CapWords 中使用缩写时，请确保将缩写中的所有字母大写。因此，HTTPServerError 比 HttpServerError 更可取。

python中的命名约定

下表显示了 Python 中一些最常见的命名样式 -

空白行

通过使用空行可以提高 Python 代码的可读性。当多行代码组合在一起时，代码变得更加难以阅读。我们可以通过使用大量空白的垂直线来摆脱它，但读者可能需要滚动太多。要添加垂直空格，请按照以下步骤操作。

具有两行的顶级函数和类 - 在它们周围添加额外的垂直空间，使它们更具可读性。

class MyFirstClass: pass class MySecondClass: pass def main_function(): return None

类中的单个空行 − 类中定义的函数彼此相关。

class MyFirstClass: def first_method(self): return None def second_method(self): return None

在函数中使用空行 - 有时我们需要创建一个复杂的函数，在 return 语句之前包含许多步骤。因此，我们可以在每个步骤之间插入一个空行。

评论

注释是任何编程语言的重要元素。这些是描述代码的最有效方法。当我们用适当的注释记录我们的代码时，任何人都可以理解它。但请记住以下几点。

• 从大写字母开始，写下整个句子。
• 如果代码发生更改，请更新注释。
• 注释和文档字符串行长度限制为 72 个字符。

屏蔽评论

块注释是一小部分代码的绝佳解决方案。在编写多行代码以实现单个操作（如循环迭代）时，此类注释非常有用。它们帮助我们理解代码的目的。

• 阻止注释应在同一级别缩进。
• 每行以 # 和单个空格开头。
• 使用单个 # 分隔每行。

例

# Assigning the value of name (Block Line comment) name = "TutorialsPoint"

内联注释

内联注释在代码中用于描述代码部分中的单个语句。我们可以很容易地理解为什么我们开发了那一行特定的代码。PEP 8 中指定了内联注释的以下限制。

• 以 a 和单个空格开始您的评论。
• 谨慎使用内联注释
• 我们应该将内联注释与它们所引用的语句分开在同一行。

name = "TutorialsPoint" # Assigning the value of name (InLine comment)

结论

在本文中，我们了解了 Pep8 是什么以及如何使用各种方法编写高质量的代码。