Python编码规范(小白必须了解的编码规范)

Python编码规范(小白必须了解的编码规范)

​ 为什么不直接进入Python的语法和数据类型阶段，而是介绍Python编码规范？因为这很重要！作为一个开发的老鸟，给新人的第一个建议就是Python编码规范，这种规范很多时候不仅仅是Python,祝大家养成良好的代码习惯！~~~~

一.忽略代码规范的规则

以下情况可以忽略代码规范，其余情况请尽量遵守

1.遵循代码规范将导致代码可读性变差；

2.与周围代码保持一致，或者兼容周围代码；

3.没有充足的理由去修改不规范的代码；

二.代码布局

1.缩进：使用四个空格进行缩进，避免使用制表符（Tab）。

2.行长度：建议每行不超过 79 个字符。

3.空行：模块、类和函数之间用空行分隔。类内方法之间用一个空行分隔。

在Python中空格是首选的缩进方式，且Python3中不允许 同时使用 空格和制表符进行缩进。

注：使用vscode编辑器开发python时，可以放心用tab键，因为vscode会自动将制表符转换为四个空格进行缩进

三.命名规范

1.变量/包/函数命名规范

1.由数字、字母、下划线组成，不能以数字开头

2.严格区分大小写

3.不能使用Python关键字

4.小驼峰命名规则：myWife

5.下划线分割: my_wife

2.类名命名规范

1.基于变量命名规范 采用首字母大写驼峰命名：MyWife

3.全局变量

1.全部大写字母 如：PI=3.14

4.实例变量

1.以"_"开头 其余跟变量一样

class MyCar:
    __slots__ = ('name','color')
    def __init__(self,name,color):
        self.name = name
        self.color = color
    def run(self):
        print(f'{self.name}:在跑')

_bm = MyCar('宝马','金色')
_bm.run()

5.私有变量

什么是私有变量，即外部不可访问

1.私有变量以"__"开头

__private_name

6.专有变量

1.以"__"开头和结尾

四.注释

1.块注释：用 # 开头，尽量写完整句子。注释应与代码相关，并说明为什么这样做。

2.文档字符串：使用三重引号（"""）来描述模块、类和函数的功能。

#这是一个类的命名规范
class MyCar:
    '''
        用来介绍类的
        命名规范！
    '''
    __slots__ = ('name','color')
    def __init__(self,name,color):
        self.name = name
        self.color = color
    def run(self):
        print(f'{self.name}:在跑')

_bm = MyCar('宝马','金色')
_bm.run()

五.空格的使用

1.在逗号、分号和冒号后面加一个空格

2.在运算符两侧加空格，例：a = b + c

六.引号

1.在字符串中，使用单引号或双引号保持一致。选择一种风格并在整个项目中保持一致

七.模块的导入

1.将导入语句放在文件顶部，并按字母顺序排列，分为标准库、第三方库和本地库