17611538698
webmaster@21cto.com

Python 开发者:如何养成良好编码习惯?

编程语言 0 549 2024-08-26 08:44:45

图片

当你已经是一名 Python 开发人员时,可能养成了一些习惯:有好的,也有坏的。

编码本质是一种艺术形式。我们鼓励灵活性与可定制性。我们可以在编程语言的上下文中按照自己想要的方式编码。

而现在需要面对的问题是,实际你正在公开与计算机通信,因此需要以一种其他人可以理解的方式编写代码。

另外,使用不正确的语法或没有有效编写代码也会导致编程错误。混乱的代码使得以后很难发现这些错误。而可读、整洁的编码才是王道,这意味着尽早养成良好的编码习惯,这样你就可以在后面整个职业生涯中遵循这些好习惯。

以下,为大家分享在学习 Python 时养成良好编码习惯的六个技巧。

1.遵循 PEP 8 风格指南


在媒体和出版行业,文案撰稿人通常使用一种称为“样式指南”的东西。


样式指南制定了有关文字格式和组织的规则。它可能会解释是否使用逗号、顿号或何时使用标题大写以及行高等结构化方法。


Python 有一个类似的代码样式指南,称为 PEP 8、PEP8 或者 PEP-8。几位熟练的 资深Python 开发人员于 2001 年发布了该指南,以分享如何编写完全可读且一致的代码。


一些原则包括如下:

  • 使用适当的“压痕”技术。

  • 保持在 79 个字符的最大行长度以下。

  • 使用换行符。

  • 对函数、类和方法定义使用双空行或单空行。

  • 对变量、类、函数等使用适当的命名约定。


如果还没有开,请通读 Python PEP 8 样式指南,并确保遵循这些技巧。

2.使用最新 Python版本


图片


像 Python 这样的语言在其生命周期中会经历多次迭代。旧版本通常会被新版本淘汰。通常,最新版本会修复错误,并进行安全性或性能改进。


请至少应使用 Python 3 而不是 Python 2,因为旧版本已于 2020 年 1 月达到停用状态。此外,在使用第三方模块、框架或存储库时,请始终参考最低要求 Python 版本。这是与相关组件兼容的最旧版本的 Python。


3. 始终注释掉特定代码


在编写代码的那一刻,你是知道自己想要实现什么的。当你稍后阅读该代码时,您可能会忘记或者更糟的是,如果其他人正在阅读该代码,他们可能会感到困惑——这就是注释的作用。


每种语言都有一种“注释掉”某些代码段的方法。其目的是使用描述性但简洁的注释来解释正在发生的事情。有些开发人员完全忘记了这一点,但如果你早点开始并始终遵循规则,你将能够编写易于理解的语法。


在 Python 中,你可以在代码开头使用“#”符号来注释掉一行。要编写多行注释,您可以在开头或结尾使用三重引号 ('''),或者每行使用多个主题标签。


#This is a regular comment.
‘’’This is a multi-line comment.To explain what the code is doing.‘’’


注释是编码过程的一个重要部分,因为它可以让你更好地记住和形象化编码过程中脑海中的想法。


据专家介绍,手写笔记,然后通过注释等方式将其数字化转录,可以将记忆力提高 75 %。这意味着,当你发现错误或想要稍后进行改进时,你可以更轻松地回忆起相关的代码片段。


行内注释也可以出现在代码点的同一行中。例如:

print (“Hello World. This is my first code.”)# This is how you create an inline commentbr


4. 使用 Linter

Python linter 会检查代码间距、行长和各种设计要求(如参数定位)。因此,你的代码会看起来干净、有条理,并且在项目中的多个文件中保持一致。

请记住,linter 与其它自动格式化程序或美化程序不同。尽管在现代级编码中,同一工具可以同时处理这两种支持功能。您可以将 linter 视为修复实际问题的工具,而自动格式化程序则修复更多的样式问题。

语法检查器可以分析和识别编码错误、潜在错误、拼写错误或语法问题,以及风格不一致,例如缩进和空格的使用方式。自动格式化程序专注于语法的书写或风格部分,如逗号、引号、适当的行长等。两者都很有用,但您很少会在没有语法检查器的情况下编写代码。

一些最好的 Python linter 包括 Pylint、Flake8、Ruff、Xenon 和 Radon 等。以下屏幕截图中使用的 linter 是通过 VSCode 安装的 Ruff。

图片

5. 依赖内置函数和库


Python 和类似语言的美妙之处在于永远不需要从头开始。您不必亲自编写每个函数或成就。相反的,您可以依赖内置函数、库、框架和存储库。


内置函数可以有效节省我们的时间,为您提供可用的功能,并且通常由一组开发人员管理。更重要的是,它们可以提高代码和软件的性能。您可以参考 Python 官方文档来查看内置语言函数。


一些示例包括:

  • append():获取单个项目并将其添加到列表中,通过添加项目和将列表增加一来修改现有列表

  • eval():评估任何指定的表达式,就像它是官方的 Python 语句一样

  • id():用于引用对象或整数的唯一标识

  • max():从多个给定值中返回可迭代对象的最大值

  • print():显示或返回文本变量到 Python 控制台

  • round():将数字或值四舍五入到指定的小数位


使用最常见的初学者教程,当您使用该print()函数时,它看起来像这样:

print(“Hello world I am coding.”)

无论您使用什么 IDE 或编码环境,该内置函数始终都会被识别,这适用于从 append() 到 round() 的所有内置函数。

另一方面,库数量众多且种类繁多——它们是预先编写的代码或函数的更大集合。要使用或引用库及其函数,只需将它们导入 Python 脚本即可。示例包括 Requests、FastAPI、Asyncio、aiohttp、Tkinter 等。

6.尽快修复代码问题


编写代码时,如果发现哪里不对劲,请立即修复,不要拖延或等到稍后测试。如果不这样做,可能会错过错误或错误的位置——想象一下如果您无法再次找到它,会消耗很多时间来查找。


开发人员 23%-42% 的时间因糟糕的代码而浪费,而这些宝贵的时间,我们本可以花在其他地方。


最重要的是,错误和Bug会随着时间的推移而累积,因此您拖延的时间越长,整个代码段出错或停止工作的可能性就越大。许多 IDE 和 linters 可以帮助完成此过程,特别是如果您使用日志记录模块而不是仅仅打印结果。


Python 的日志模块会在程序运行时跟踪事件。在本质上,这可让您在测试代码时识别问题或错误。它可能会标记与错误、调试或代码相关事件有关的警告,但它还可以帮助您了解项目的运行时行为,所有这些在编写过程中都可能被忽略。


例如,您可以查看和分析用户交互,尤其是当外部用户正在测试您的应用程序时。


最重要的是,日志记录模块是一种审计工具,一旦您开始测试或运行您编写的代码,它就非常有用。没有它就不要写代码。


熟能生巧


使用 Python 时需要考虑很多事情,无论您有多熟练或不熟练。遵循 Python 最佳实践始终是正确的选择。但最终,最好的学习方法始终是采取实践方法,这意味着最佳实践。


继续使用 Python,练习使用本文讨论的习惯并编写干净的代码,即使只是为了自己创建简单或小型项目。


还应该阅读其他开发人员的源代码,了解他们如何处理这一系统过程。


编码愉快~


作者:场长

评论