百度360必应搜狗淘宝本站头条
当前位置:网站首页 > 技术资源 > 正文

「小白学Python」Python编码规范(python编码规则)

off999 2024-11-01 12:48 17 浏览 0 评论

本文参考:嗨客网(www.haicoder.net)

Python编码规范

Python编码规范教程

Python 采用 PEP 8 作为编码规范,其中 PEP 是 Python Enhancement Proposal(Python 增强建议书)的缩写,8 代表的是 Python 代码的样式指南。

Python编码规范

代码缩进

在 Python 中,代码缩进推荐使用四个空格,而不是一个 tab 键。

最大行宽

限制所有行的最大行宽为 79 字符。文本长块,比如文档字符串或注释,行长度应限制为 72 个字符。

空行

使用空行分割顶层函数和类的定义。类中的方法的定义使用单个空行进行分割。

额外的空行可以必要的时候用于分割不同的函数组,但是要尽量节约使用。

额外的空行可以必要的时候在函数中用于分割不同的逻辑块,但是要尽量节约使用。

空格

各种右括号前不要加空格。

逗号、冒号、分号前不要加空格。

函数的左括号前不要加空格,如 Func(1)

序列的左括号前不要加空格,如 list[2]

操作符左右各加一个空格,不要为了对齐增加空格。

函数默认参数使用的赋值符左右省略空格。

import导入

import导入始终在文件的顶部,在模块注释和文档字符串之后,在模块全局变量和常量之前。

导入顺序如下:标准库进口,相关的第三方库,本地库。各组的导入之间要有空行。

不要在一行 import 多个库,每行只能 import 一个库。

注释

总体原则,错误的注释不如没有注释。所以当一段代码发生变化时,第一件事就是要修改注释。

注释必须使用英文,最好是完整的句子,首字母大写,句后要有结束符,结束符后跟两个空格,开始下一句。如果是短语,可以省略结束符。

块注释,在一段代码前增加的注释。行注释,在一句代码后加注释。但是这种方式尽量少使用。

命名规则

模块命名尽量短小,使用全部小写的方式,可以使用下划线。

包命名尽量短小,使用全部小写的方式,不可以使用下划线。

类的命名使用 CapWords 的方式,模块内部使用的类采用 _CapWords 的方式。

异常命名使用 CapWords+Error 后缀的方式。

全局变量尽量只在模块内有效,类似 C语言 中的 static。

函数命名使用全部小写的方式,可以使用下划线。

常量命名使用全部大写的方式,可以使用下划线。

类的属性(方法和变量)命名使用全部小写的方式,可以使用下划线。类的属性若与关键字名字冲突,后缀一下划线,尽量不要使用缩略等其他方式。

为避免与子类属性命名冲突,在类的一些属性前,前缀两条下划线。

类的方法第一个参数必须是self,而静态方法第一个参数必须是cls。

Python编码规范总结

Python 采用 PEP 8 作为编码规范。

相关推荐

Python四种常用的高阶函数,你会用了吗

每天进步一点点,关注我们哦,每天分享测试技术文章本文章出自【码同学软件测试】码同学公众号:自动化软件测试码同学抖音号:小码哥聊软件测试1、什么是高阶函数把函数作为参数传入,这样的函数称为高阶函数例如:...

Python之函数进阶-函数加强(上)(python函数的作用增强代码的可读性)

一.递归函数递归是一种编程技术,其中函数调用自身以解决问题。递归函数需要有一个或多个终止条件,以防止无限递归。递归可以用于解决许多问题,例如排序、搜索、解析语法等。递归的优点是代码简洁、易于理解,并...

数据分析-一元线性回归分析Python

前面几篇介绍了数据的相关性分析,通过相关性分析可以看出变量之间的相关性程度。如果我们已经发现变量之间存在明显的相关性了,接下来就可以通过回归分析,计算出具体的相关值,然后可以用于对其他数据的预测。本篇...

python基础函数(python函数总结)

Python函数是代码复用的核心工具,掌握基础函数的使用是编程的关键。以下是Python函数的系统总结,包含内置函数和自定义函数的详细用法,以及实际应用场景。一、Python内置函数(...

python进阶100集(9)int数据类型深入分析

一、基本概念int数据类型基本上来说这里指的都是整形,下一届我们会讲解整形和浮点型的转化,以及精度问题!a=100b=a这里a是变量名,100就是int数据对象,b指向的是a指向的对象,...

Python学不会来打我(73)python常用的高阶函数汇总

python最常用的高阶函数有counter(),sorted(),map(),reduce(),filter()。很多高阶函数都是将一个基础函数作为第一个参数,将另外一个容器集合作为第二个参数,然...

python中有哪些内置函数可用于编写数值表达式?

在Python中,用于编写数值表达式的内置函数很多,它们可以帮助你处理数学运算、类型转换、数值判断等。以下是常用的内置函数(不需要导入模块)按类别归类说明:一、基础数值处理函数函数作用示例ab...

如何在Python中获取数字的绝对值?

Python有两种获取数字绝对值的方法:内置abs()函数返回绝对值。math.fabs()函数还返回浮点绝对值。abs()函数获取绝对值内置abs()函数返回绝对值,要使用该函数,只需直接调用:a...

【Python大语言模型系列】使用dify云版本开发一个智能客服机器人

这是我的第359篇原创文章。一、引言上篇文章我们介绍了如何使用dify云版本开发一个简单的工作流:【Python大语言模型系列】一文教你使用dify云版本开发一个AI工作流(完整教程)这篇文章我们将引...

Python3.11版本使用thriftpy2的问题

Python3.11于2022年10月24日发布,但目前thriftpy2在Python3.11版本下无法安装,如果有使用thriftpy2的童鞋,建议晚点再升级到最新版本。...

uwsgi的python2+3多版本共存(python多版本兼容)

一、第一种方式(virtualenv)1、首先,机器需要有python2和python3的可执行环境。确保pip和pip3命令可用。原理就是在哪个环境下安装uwsgi。uwsgi启动的时候,就用的哪个...

解释一下Python脚本中版本号声明的作用

在Python脚本中声明版本号(如__version__变量)是一种常见的元数据管理实践,在IronPython的兼容性验证机制中具有重要作用。以下是版本号声明的核心作用及实现原理:一、版本号...

除了版本号声明,还有哪些元数据可以用于Python脚本的兼容性管理

在Python脚本的兼容性管理中,除了版本号声明外,还有多种元数据可以用于增强脚本与宿主环境的交互和验证。以下是一些关键的元数据类型及其应用场景:一、环境依赖声明1.Python版本要求pyth...

今年回家没票了?不,我有高科技抢票

零基础使用抢票开源软件Py12306一年一度的抢票季就要到了,今天给大家科普一下一款软件的使用方法。软件目前是开源的,禁止用于商用。首先需要在电脑上安装python3.7,首先从官网下载对应的安装包,...

生猛!春运抢票神器成GitHub热榜第一,过年回家全靠它了

作者:车栗子发自:凹非寺量子位报道春节抢票正在如火如荼的进行,过年回家那肯定需要抢票,每年的抢票大战,都是一场硬战,没有一个好工具,怎么能上战场死锁呢。今天小编推荐一个Python抢票工具,送到...

取消回复欢迎 发表评论: