Python变量、方法、类的命名规则

#!/usr/bin/env python
# -*- coding: utf-8 -*-"""
__Title__ &＃61; &＃39;下划线变量与命名&＃39;
__Author__ &＃61; &＃39;Zhangyf&＃39;
__Author_email__ &＃61;&＃39;hpuyanfeng&＃64;126.com&＃39;
__Time__ &＃61; &＃39;2018/1/22&＃39;
"""# 变量命名总结&＃xff1a;
# 1.单下划线开头变量&＃xff1a;protected
# 2.双下划线开头变量&＃xff1a;private
# 3.双下划线开头&＃xff0c;双下划线结尾&＃xff1a;系统内置变量"""
单下划线开头变量
_xxx&＃xff0c;单下划线开头的变量&＃xff0c;标明是一个受保护(protected)的变量&＃xff0c;原则上不允许直接访问&＃xff0c;但外部类还是可以访问到这个变量。
这只是程序员之间的一个约定&＃xff0c;用于警告说明这是一个私有变量&＃xff0c;外部类不要去访问它。
print(stu._name) 当要输入_name时&＃xff0c;pycharm不会进行_name的提示
print(stu.age) 当要显示age时&＃xff0c;pycharm会进行age的提示"""class Student:
def __init__(self, name, sex):
self._name &＃61; name
self.sex &＃61; sexstu &＃61; Student(&＃39;zyf&＃39;, &＃39;Male&＃39;)
print(stu._name) # 单下划线protected的变量&＃xff0c;原则上不允许直接访问 输出&＃xff1a;zyf
print(stu.sex) # age可以直接访问 输出&＃xff1a;Male"""
双下划线开头
__xxx&＃xff0c;双下划线开头的&＃xff0c;表示的是私有类型(private)的变量。
只能是允许这个类本身进行访问了, 连子类也不可以.
用于命名一个类属性&＃xff08;类变量&＃xff09;,调用时名字被改变
&＃xff08;在类Student内部&＃xff0c;__name变成_Student__name,如 self._Student__name)
双下划线开头的实例变量是不是一定不能从外部访问呢&＃xff1f;其实也不是。仍然可以通过_Student__name来访问__name变量&＃xff1a;
"""class Person:
def __init__(self, name):
self.__name &＃61; nameper &＃61; Person(&＃39;zyf2&＃39;)
print(per._Person__name) # 输出zyf2 但是无法直接访问__name"""
双下划线开头&＃xff0c;并且以双下划线结尾
__xxx__&＃xff0c;以双下划线开头&＃xff0c;并且以双下划线结尾的&＃xff0c;是内置变量.
内置变量是可以直接访问的&＃xff0c;不是 private 变量&＃xff0c;如__init__&＃xff0c;__import__或是__file__。
★不要自己定义这类变量
xxx_&＃xff0c;单下划线结尾的变量一般只是为了避免与 Python 关键字的命名冲突
USER_CONSTANT&＃xff0c;大写加下划线&＃xff0c;对于不会发生改变的全局变量&＃xff0c;使用大写加下划线
"""# 函数命名总结&＃xff1a;
# 1.私有方法&＃xff1a;小写和一个前导下划线
# 2.特殊方法&＃xff08;魔术方法&＃xff09;&＃xff1a;小写和两个前导下划线&＃xff0c;两个后置下划线
# 3.函数参数&＃xff1a;小写和下划线&＃xff0c;缺省值等号两边无空格"""
函数
总体而言应该使用&＃xff0c;小写和下划线私有方法 &＃xff1a; 小写和一个前导下划线
这里和私有变量一样&＃xff0c;并不是真正的私有访问权限。
同时也应该注意一般函数不要使用两个前导下划线(当遇到两个前导下划线时&＃xff0c;Python 的名称改编特性将发挥作用)。特殊函数后面会提及。#特殊方法 &＃xff1a; 小写和两个前导下划线&＃xff0c;两个后置下划线
#这种风格只应用于特殊函数&＃xff0c;比如操作符重载等。#函数参数 : 小写和下划线&＃xff0c;缺省值等号两边无空格"""# 私有方法
class PrivateCase:
&＃64;staticmethod
def _secrete():
print(r"Don&＃39;t test me")priC &＃61; PrivateCase()
priC._secrete() # _secrete为protected member# 特殊方法&＃xff08;魔术方法&＃xff09;
def __add__(self, other):
return int.__add__(other)# 函数参数
def connect(self, user&＃61;None):
self._user &＃61; user"""
★类名称命名&＃xff1a;
类总是使用驼峰格式命名&＃xff0c;即所有单词首字母大写其余字母小写。
类名应该简明&＃xff0c;精确&＃xff0c;并足以从中理解类所完成的工作。
常见的一个方法是使用表示其类型或者特性的后缀&＃xff0c;例如:SQLEngine &＃xff0c;MimeTypes
对于基类而言&＃xff0c;可以使用一个 Base 或者 Abstract 前缀
不要滥用 *args 和 **kwargs&＃xff0c;可能会破坏函数的健壮性
"""