Python编码规范与代码优化

怼烎@ 2023-10-16 16:26 63阅读 0赞

> **博主：[命运之光][Link 1]**
> 
> **专栏：[Python程序设计][Python]**

#### Python编码规范 ####

Python的程序由包、模块（即一个Python文件）、函数、类和语句组成

![2d5d41a05307426b55142d731fb87f2b.png][]

(1) 命名规则

变量名、包名、模块名通常采用小写字母开头，如果名称中包含多个单词，一般采用第一个单词全部小写，后面每一个单词首字母大写的驼峰表示法，如myBook。也可以采用下划线\_分隔的全部小写形式，如student\_name。

常量建议使用全大写方式，如PI。

类名采用首字母大写，多个单词使用驼峰表示法，如BookInfo。

函数名一般采用小写字母，多个单词使用驼峰表示法。getName()；get\_name()

(2) 代码缩进

使用Tab键和空格来进行代码缩进，但是不要混用Tab和空格来缩进。Python中的缩进代表程序块的作用域， 如果采用了错误的代码缩进，会导致程序抛出异常。

(3) 空格/空行

函数或者语句块之间使用空格行来分隔，以分开两段不同功能的代码块， 增强可读性。运算符两侧建议使用空格进行分隔，函数参数赋值语句两侧不加空格。

(4) 注释---\#单行注释、 """ 多行注释"""

注释有助于对程序的理解和团队合作开发，对函数、类一定要添加功能性、使用性注释说明，对于复杂的算法也要适当注释。

(5) 每个import语句只导入一个模块，尽量避免一次导入多个模块。

(6) 如果一行语句太长，可以在行尾使用续行符“\\” ，在下一行继续写代码。

(7) 适当使用异常处理结构提高程序的容错性和健壮性。

import string
    class Stack():
    	def__init__(self,  size=10):
    		self.__content = []              #定义列表存放栈的元素
    		self.__size = size                #初始化栈的大小
    			self.__current = 0               #栈中元素个数初始化为0
    # 将堆栈清空
    	def empty(self):
    		self.__content = []
    		self.__current = 0
    # 判断堆栈是否为空
    	def isEmpty(self):
    		if not self.__content:
    			return True
    		else:
    			return False

[Link 1]: https://blog.csdn.net/VLOKL?type=blog
[Python]: https://blog.csdn.net/vlokl/category_12456620.html?spm=1001.2014.3001.5482
[2d5d41a05307426b55142d731fb87f2b.png]: https://img-blog.csdnimg.cn/img_convert/2d5d41a05307426b55142d731fb87f2b.png