python模块详解 || python命名规范(python中模块的讲解)

网友投稿 342 2022-08-28


python模块详解 || python命名规范(python中模块的讲解)

python模块详解

1、模块是什么:

Python 模块(Module),是一个 Python 文件,以 .py 结尾,包含了 Python 对象定义和Python语句。

模块让你能够有逻辑地组织你的 Python 代码段。

把相关的代码分配到一个模块里能让你的代码更好用,更易懂。

模块能定义函数,类和变量,模块里也能包含可执行的代码。

它可以被其他程序引用,从而使用该模块里的函数等功能,使用Python中的标准库也是采用这种方法。

2、模块的分类:

在Python中,模块分为以下几种:

系统内置模块:例如:sys、time、json模块等等,安装好python之后通过导入模块的形式就可以直接使用;

自定义模块:自定义模块是自己写的模块,对某段逻辑或某些函数进行封装后供其他函数调用。(注意:自定义模块的命名一定不能和系统内置的模块重名了,否则将不能再导入系统的内置模块)。例如:自定义了一个os.py模块后,就不能再使用python中内置的模块;

第三方的开源模块:这部分模块可以通过 pip install 模块名 进行安装,有开源的代码;

python命名规范

模块名:

小写字母,单词之间用_分割。common_method.py

包名:

小写字母,单词之间用_分割。

类名:

单词首字母大写。StudentManager

类变量:

大写字母,单词之间用_分割。CALC_PARAMS

常量:

大写字母,单词之间用_分割。SCORE_BASE

普通变量:

小写字母,单词之间用_分割。student_name

实例变量:

以_开头,其他和普通变量一样。_student_age

私有实例变量(外部访问会报错):

以__开头(2个下划线),其他和普通变量一样。__student_score

普通函数:

和普通变量一样,小写字母,单词之间用_分割。get_student_name()

私有函数(外部访问会报错):

以__开头(2个下划线),其他和普通函数一样。__get_student_name()

专有变量:

__开头,__结尾,一般为python的自有变量,不要以这种方式命名。doc

异常:

异常命名规范和类的一样,若异常本身是一个错误,名称带上“Error”后缀。

其他规范

①使用4个空格的缩进,不使用Tap,更不要混合使用空格和Tap。

②类和top-level函数定义之间空两行,类中方法空一行。

③函数内逻辑无关片段空一行。

④导入模块时,按照标准库模块、第三方模块、应用程序自定义模块的顺序导入,且相互之间空一行。

⑤不要在一句import中多个库。

⑥不要将多句语句写在同一行,尽管使用‘;’允许。

⑦块注释,在一段代码前增加的注释。在‘#’后加一空格。段落之间以只有‘#’的行间隔。比如:

⑧为所有的共有模块、函数、类、方法写文档字符串。文档字符串要换行使用下面的格式。

⑨尽可能使用‘is’‘is not’取代‘==’。

⑩异常中不要使用裸露的except,except后跟具体的exceptions。

⑪使用isinstance()比较对象的类型。

去期待陌生,去拥抱惊喜。


版权声明:本文内容由网络用户投稿,版权归原作者所有,本站不拥有其著作权,亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容,请联系我们jiasou666@gmail.com 处理,核实后本网站将在24小时内删除侵权内容。

上一篇:Python解析JSON【python第三方Demjson库】【将 Python对象编码成 JSON 字符串 || 将JSON字符串解码成Python对象】(python json解析)
下一篇:解决netty中spring对象注入失败的问题
相关文章

 发表评论

暂时没有评论,来抢沙发吧~