「小白学Python」Python编码规范（python编码规则）
off999 2024-11-01 12:48 21 浏览 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 作为编码规范。
相关推荐
- Linux 网络协议栈_linux网络协议栈
-
前言；更多学习资料（包含视频、技术学习路线图谱、文档等）后台私信《资料》免费领取技术点包含了C/C++，Linux，Nginx，ZeroMQ，MySQL，Redis，fastdfs，MongoDB，Z...
- 揭秘 BPF map 前生今世_bpfdm
-
1.前言众所周知，map可用于内核BPF程序和用户应用程序之间实现双向的数据交换，为BPF技术中的重要基础数据结构。在BPF程序中可以通过声明structbpf_map_def...
- 教你简单 提取fmpeg 视频，音频，字幕 方法
-
ffmpeg提取视频，音频，字幕方法（HowtoExtractVideo,Audio,SubtitlefromOriginalVideo？）1.提取视频（ExtractVi...
- Linux内核原理到代码详解《内核视频教程》
-
Linux内核原理-进程入门进程进程不仅仅是一段可执行程序的代码，通常进程还包括其他资源，比如打开的文件，挂起的信号，内核内部的数据结构，处理器状态，内存地址空间，或多个执行线程，存放全局变量的数据段...
- Linux C Socket UDP编程详解及实例分享
-
1、UDP网络编程主要流程UDP协议的程序设计框架，客户端和服务器之间的差别在于服务器必须使用bind()函数来绑定侦听的本地UDP端口，而客户端则可以不进行绑定，直接发送到服务器地址的某个端口地址。...
- libevent源码分析之bufferevent使用详解
-
libevent的bufferevent在event的基础上自己维护了一个buffer，这样的话，就不需要再自己管理一个buffer了。先看看structbufferevent这个结构体struct...
- 一次解决Linux内核内存泄漏实战全过程
-
什么是内存泄漏：程序向系统申请内存，使用完不需要之后,不释放内存还给系统回收，造成申请的内存被浪费.发现系统中内存使用量随着时间的流逝，消耗的越来越多，例如下图所示：接下来的排查思路是:1.监控系统中...
- 彻底搞清楚内存泄漏的原因，如何避免内存泄漏，如何定位内存泄漏
-
作为C/C++开发人员，内存泄漏是最容易遇到的问题之一，这是由C/C++语言的特性引起的。C/C++语言与其他语言不同，需要开发者去申请和释放内存，即需要开发者去管理内存，如果内存使用不当，就容易造成...
- linux网络编程常见API详解_linux网络编程视频教程
-
Linux网络编程API函数初步剖析今天我们来分析一下前几篇博文中提到的网络编程中几个核心的API，探究一下当我们调用每个API时，内核中具体做了哪些准备和初始化工作。1、socket(family...
- Linux下C++访问web—使用libcurl库调用http接口发送解析json数据
-
一、背景这两天由于一些原因研究了研究如何在客户端C++代码中调用web服务端接口，需要访问url，并传入json数据，拿到返回值，并解析。 现在的情形是远程服务端的接口参数和返回类型都是json的字符...
- 平衡感知调节:“系统如人” 视角下的架构设计与业务稳定之道
-
在今天这个到处都是数字化的时代，系统可不是一堆冷冰冰的代码。它就像一个活生生的“数字人”，没了它，业务根本转不起来。总说“技术要为业务服务”，但实际操作起来问题不少：系统怎么才能快速响应业务需求？...
- 谈谈分布式文件系统下的本地缓存_什么是分布式文件存储
-
在分布式文件系统中，为了提高系统的性能，常常会引入不同类型的缓存存储系统（算法优化所带来的的效果可能远远不如缓存带来的优化效果）。在软件中缓存存储系统一般可分为了两类：一、分布式缓存，例如：Memca...
- 进程间通信之信号量semaphore--linux内核剖析
-
什么是信号量信号量的使用主要是用来保护共享资源，使得资源在一个时刻只有一个进程（线程）所拥有。信号量的值为正的时候，说明它空闲。所测试的线程可以锁定而使用它。若为0，说明它被占用，测试的线程要进入睡眠...
- Qt编写推流程序/支持webrtc265/从此不用再转码/打开新世界的大门
-
一、前言在推流领域，尤其是监控行业，现在主流设备基本上都是265格式的视频流，想要在网页上直接显示监控流，之前的方案是，要么转成hls，要么魔改支持265格式的flv，要么265转成264，如果要追求...
- 30 分钟搞定 SpringBoot 视频推拉流!实战避坑指南
-
30分钟搞定SpringBoot视频推拉流！实战避坑指南在音视频开发领域，SpringBoot凭借其快速开发特性，成为很多开发者实现视频推拉流功能的首选框架。但实际开发中，从环境搭建到流处理优...
欢迎 你 发表评论:
- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (77)
- python封装 (57)
- python写入txt (66)
- python读取文件夹下所有文件 (59)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)