`

python命名规范(转载)

 
阅读更多

文件名
全小写,可使用下划线



应该是简短的、小写的名字。如果下划线可以改善可读性可以加入。如mypackage。


模块
与包的规范同。如mymodule。



总是使用首字母大写单词串。如MyClass。内部类可以使用额外的前导下划线。

 

 

函数&方法
函数名应该为小写,可以用下划线风格单词以增加可读性。如:myfunction,my_example_function。
*注意*:混合大小写仅被允许用于这种风格已经占据优势的时候,以便保持向后兼容。


函数和方法的参数
总使用“self”作为实例方法的第一个参数。总使用“cls”作为类方法的第一个参数。
如果一个函数的参数名称和保留的关键字冲突,通常使用一个后缀下划线好于使用缩写或奇怪的拼写。


全局变量
对于from M import *导入语句,如果想阻止导入模块内的全局变量可以使用旧有的规范,在全局变量上加一个前导的下划线。
*注意*:应避免使用全局变量


变量
变量名全部小写,由下划线连接各个单词。如color = WHITE,this_is_a_variable = 1
*注意*:
1.不论是类成员变量还是全局变量,均不使用 m 或 g 前缀。
2.私有类成员使用单一下划线前缀标识,多定义公开成员,少定义私有成员。
3.变量名不应带有类型信息,因为Python是动态类型语言。如 iValue、names_list、dict_obj 等都是不好的命名。


常量
常量名所有字母大写,由下划线连接各个单词如MAX_OVERFLOW,TOTAL。


异常
以“Error”作为后缀。


缩写
命名应当尽量使用全拼写的单词,缩写的情况有如下两种:
1.常用的缩写,如XML、ID等,在命名时也应只大写首字母,如XmlParser。
2.命名中含有长单词,对某个单词进行缩写。这时应使用约定成俗的缩写方式。
例如:
function 缩写为 fn
text 缩写为 txt
object 缩写为 obj
count 缩写为 cnt
number 缩写为 num,等。
前导后缀下划线
一个前导下划线:表示非公有。
一个后缀下划线:避免关键字冲突。
两个前导下划线:当命名一个类属性引起名称冲突时使用。
两个前导和后缀下划线:“魔”(有特殊用图)对象或者属性,例如__init__或者__file__。绝对不要创造这样的名字,而只是使用它们。
*注意*:关于下划线的使用存在一些争议。


特定命名方式
主要是指 __xxx__ 形式的系统保留字命名法。项目中也可以使用这种命名,它的意义在于这种形式的变量是只读的,这种形式的类成员函数尽量不要重载。如
class Base(object):
def __init__(self, id, parent = None):
self.__id__ = id
self.__parent__ = parent
def __message__(self, msgid):
# …略
其中 __id__、__parent__ 和 __message__ 都采用了系统保留字命名法。
附:Google Python命名规范
module_name, package_name, ClassName, method_name, ExceptionName, function_name, GLOBAL_VAR_NAME, instance_var_name, function_parameter_name, local_var_name.

分享到:
评论

相关推荐

    Python代码规范和命名规范

    Python代码规范和命名规范 Python 代码规范和命名规范是 Python 开发者所必须遵守的规则,以保证代码的可读性、可维护性和一致性。下面是 Python 代码规范和命名规范的详细说明: 编码 * 文件一律使用 UTF-8 编码...

    python编程规范.pdf

    本文简要叙述了 Python 编程规范的要点,包括代码风格、缩进方式、注释、命名约定、错误处理等方面的建议。 一、代码风格 Python 编程规范建议使用 Pythonic 风格编写代码,即遵守 Python 的语法和惯例,避免使用...

    Python命名规范1.pdf

    由于内容出现了重复并且包含了一些扫描错误,我会尽量去解释并通顺地介绍Python命名规范的相关知识点。 命名规范是编程中非常重要的部分,它不仅影响代码的可读性,还直接关联到开发效率和代码维护。Python作为一门...

    PEP8Python 编码规范

    在Python社区中,PEP8是指导Python代码格式的官方编码规范,它对如何组织代码提供了许多建议,以确保代码的可读性和一致性。PEP8主要是针对Python代码的风格指南,其目的不是强制要求,而是为了提高代码的可读性和可...

    google的python编码规范.pdf

    本文档提供了一个详细的 Python 编码规范,涵盖了 Python 语言规则、Python 风格规则、代码编写风格、注释、类、字符串、TODO 注释、导入格式、语句控制、命名等多个方面,对 Python 程序员非常有价值。

    python命名规范

    Python 命名规范 Python 命名规范是 Python 开发中的一种重要规范,旨在帮助开发者编写高质量、可读性强的代码。本文档将详细介绍 Python 中的命名规范,涵盖常量、变量、函数、模块、类和包等方面。 一、常量 在...

    Python编码规范

    以Python语言为例,全面介绍编程语言规范的方方面面

    python命名实体识别demo

    "python命名实体识别demo"是一个使用Python实现的NER演示项目,它提供了一个实际应用的示例,帮助开发者理解和学习如何在Python环境中进行NER工作。 这个项目可能基于Python的几个关键库,如spaCy、NLTK、Stanford...

    Python 编码规范(Google) _ 菜鸟教程.pdf

    Python编码规范(Google)是由Google公司所提出的Python编程风格指南,旨在提高代码的可读性和一致性。这个规范并非由Google官方直接创建和维护的项目,而是由国内程序员基于对Google风格的喜爱而创建和维护。本文档...

    Python编码规范.pdf

    Python 编码规范 Python 编码规范是指在编写 Python 代码时需要遵守的一系列规则和约定,以确保代码的可读性、可维护性和一致性。该规范涵盖了代码的布局、缩进、空格、行的最大长度、空行、编码、导入、空格等方面...

    python编码规范.pdf

    适用于初学者的python规范。 “没有规矩不成方圆”。编程工作往往是一个团队协同进行,我们写出来的代码最终可能要提供给同事或其他人阅读,因而我们迫切需要一份一致的编码规范,以提高组内代码的可读性,同时加强...

    python编码规范

    ### Python编码规范详解 #### 一、引言 在Python编程的世界里,遵循一定的编码规范不仅能够提升代码的可读性和可维护性,还能帮助开发者更好地融入社区,提高团队协作效率。本文旨在介绍Python官方推荐的编码规范...

    理解Python命名机制

    了解并遵循这些规则和约定,能使你的Python代码更加规范,易于理解和协作。在实际编程中,合理地命名变量、函数和类,可以帮助我们更好地组织和管理代码,提高代码质量。通过深入理解Python的命名机制,你将能够编写...

    python 变量命名规范1

    Python是一种高级编程语言,其语法简洁明了,但遵循一定的命名规范是非常重要的,这有助于代码的可读性和团队之间的协作。下面将详细讲解Python中的变量命名规则及其背后的逻辑。 首先,变量命名的基本原则是清晰易...

    PEP8 Python编码规范

    3. **命名规范**:规范定义了一系列命名约定,如模块名(Package and Module Names)、类名(Class Names)、异常名(Exception Names)、全局变量名(Global Variable Names)、函数名(Function Names)、方法名和...

    Google Python 编程规范 PDF(官网整理版)

    Google Python编程规范是一份由Google提供的官方编程风格指南,旨在统一Python编程实践,提升代码的可读性和可维护性。文档包括了对于Python语言规范的详细说明,以及一些编程习惯上的最佳实践。在文档中,对于代码...

Global site tag (gtag.js) - Google Analytics