Python 命名规范

本文介绍了Python项目的组成部分,包括模块、包、类、异常、函数等,并详细阐述了命名规范。强调了特殊模块`__init__.py`在包组织中的作用以及绝对和相对导入的区别。此外,还提醒开发者遵循一致的命名风格,避免使用关键字作为变量名,确保命名清晰且有意义。
摘要由CSDN通过智能技术生成
一、项目组成

1.模块(module)
2.包(package)
2.类(class)
3.异常(Exception)
4.函数/方法(function)
5.全局/类常量(constant)
6.全局/类变量(variable)

二、命名规范:

1.项目:首字母大写+大写式驼峰, 如:ProjectName;
2.包:使用小写字母命名。多个单词之间用下划线分隔。
3.模块:使用小写字母命名。多个单词之间用下划线分隔。
4.类/异常(驼峰命名法):首字母大写+大写式驼峰。Python中一个模块可以包含多个类。私有类名称需要以下划线开头。如:HelloWorld 或 _HelloWorld;
5.函数:使用小写字母命名。多个单词之间用下划线分隔。私有函数名称需要以下划线开头。
6.变量:使用小写字母命名。多个单词之间用下划线分隔。私有变量名称需要以下划线开头。
7.常量/全局变量:使用大写字母命名。多个单词之间用下划线分隔。私有常量名称需要以下划线开头。

三、Python中的特殊模块_init_.py

1.包含此模块的文件夹才能成为包。(需要确保包的命名符合规范,才能被导入)
2.init.py当包被导入的时候会自动运行。

四、导包路径

1.绝对导入(from只能从根目录导入) :
from my_package import *
from my_package import my_test
import my_package.my_test as p
p.func
2.相对导入(“.”代表当前目录,“…”代表上一层目录):
from .my_package import my_test

五、总结

1.变量名区分大小写;
2.严禁使用关键字作为变量名;
3.确定自己的命名风格,不可随意变换;
4.命名应该科学严谨,切勿太长或者表达比较模糊;
5.命名中若使用特殊约定或缩写,则要有注释说明;
6.尽量不要使用中文字符和纯数学字符,避免编码错误;
7.名字由英文字母、数字、下划线组成,如abc,abc13和_abc等;
8.要清晰、明了,有明确含义,同时使用完整的单词或大家基本可以理解的缩写;
9.同一软件产品内,应规划好接口部分(变量、结构、函数及常量)的命名,防止编译、链接时产生冲突。

评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值