编写 Python 代码的最佳实践

作者 : 慕源网 本文共1559个字,预计阅读时间需要4分钟 发布时间: 2021-09-30 共332人阅读

编写 Python 代码的最佳实践

介绍

最近,Python 已成为软件工程各个领域中最常用的语言。我们可以将 Python 用于数据科学、数据工程、DevOps 自动化、测试等。考虑到 Python 的流行,我们还应该了解开发 Python 代码的最佳实践是什么。因此,在本文中,我们将探讨 PEP 8(Python 增强提案)。因此,在本文末尾,您将学习并理解以下主题。

  • PEP-8 简介
  • 如何编写一致且干净的 Python 代码
  • 一种符合 PEP-8 标准的自动化方式

PEP-8 简介

  • PEP 8 是由 Python 的创始人和他的一些同事创建的风格指南。
  • 创建 PEP-8 标准的主要目的是提高可读性,用 Python 编写一致且干净的代码。
  • 为了在 DevOps 世界中与多个开发人员协作,如果代码可读性不好,那么在后期理解代码真的很困难。PEP-8 标准通过遵循各种标准帮助 Python 开发人员克服这些挑战。

如何编写一致且干净的 Python 代码

缩进

在编写 Python 代码时,最好使用 4 个空格进行缩进。

例子

#Correct:
# Add 4 spaces to distinguish arguments from the rest.
def func(var_a, var_b, var_c): print(var_a)
# Wrong:
# Missing alignment
for arguments.
fa = function_name(var_a, var_b, var_c)

编写python语句时的间距

最好使用空格而不是制表符来编写 python 代码。

每个python语句的长度

每个python语句的最大长度不应超过79个字符。如果语句的长度超过 79 个字符,则最好拆分语句。

命名约定

编写代码python时,变量、函数、类等的名称应该是不言自明的。在编写 python 代码时避免使用随机名称。

例子

def m (a,b) :

  o=a*b
  return o

使用二元运算符换行

在python中使用二元运算符时,应在二元运算符之前添加换行符,以提高代码可读性。

例子

# Wrong: salary = (gross_salary +
          taxable_interest +
          pf_contribution)
# Correct:
# salary = (gross_salary
         + taxable_interest
         + pf_contribution)

带有类和函数的空行

建议在 python 代码中启动任何函数或类之前添加两个空行。

例子

# Two blank line before creating python function
def add(a,b):
  sum = a+b
  return sum

导入 Python 包

每个包的导入应该写在单独的一行中。避免在一行中导入多个包。

# Correct
import os
import json

# Wrong
import os, json

一种符合 PEP-8 标准的自动化方式

在上一节中,我们探索了用于编写 Python 代码的各种 PEP-8 标准。现在,在本节中,我们将探索如何在开发 Python 代码的同时有效地遵守那些 PEP8 标准,以使我们的 Python 代码更具可读性和更容易。

Linters

它分析源代码并根据 PEP-8 标准报告 Python 代码中的错误。pycodestyle 是一种根据 PEP-8 定义的标准检查 Python 代码的工具。

自动格式化程序

Automformatters 是按照 PEP-8 标准自动更正源代码的程序。

PyPI repo 中的 pep8 python 包

我们还可以使用 pep8 python 包,它会根据 pep8 标准扫描您的源代码。

结论

在本文中,我们探索了 Python 中的 pep8 标准,以编写可读、干净且一致的 Python 代码。我们还探索了在 Python 开发过程中可用于自动遵循 pep8 标准的各种外部程序/功能。希望这篇文章能帮助你完成 Python 的开发之旅。请随时在有关文章的评论和任何缺失的 pep8 标准中分享您的反馈


慕源网 » 编写 Python 代码的最佳实践

常见问题FAQ

程序仅供学习研究,请勿用于非法用途,不得违反国家法律,否则后果自负,一切法律责任与本站无关。
请仔细阅读以上条款再购买,拍下即代表同意条款并遵守约定,谢谢大家支持理解!

发表评论

开通VIP 享更多特权,建议使用QQ登录