乐趣区

Python中的单下划线和双下划线使用场景

jiezi

单下划线

单下划线用作变量

  • 最常见的一种使用场景是作为变量占位符，使用场景明显可以减少代码中多余变量的使用。为了方便理解，_可以看作被丢弃的变量名称，这样做可以让阅读你代码的人知道，这是个不会被使用的变量，e.g.。
for _, _, filenames in os.walk(targetDir):
    print(filenames)
    
for _ in range(100):
    print('PythonPoint')
  • 在交互解释器比如 iPython 中，_变量指向交互解释器中最后一次执行语句的返回结果。

单下划线前缀名称(例如_pythonPoint)

  • 这表示这是一个保护成员（属性或者方法），只有类对象和子类对象自己能访问到这些变量，是用来指定私有变量和方法的一种方式 (约定而已)。如果使用from a_module import * 导入时，这部分变量和函数不会被导入。不过值得注意的是，如果使用 import a_module 这样导入模块，仍然可以用 a_module._pythonPoint 这样的形式访问到这样的对象。
  • 另外单下划线开头还有一种一般不会用到的情况，例如使用一个 C 编写的扩展库有时会用下划线开头命名，然后使用一个去掉下划线的 Python 模块进行包装。如 struct 这个模块实际上是 C 模块 _struct 的一个 Python 包装。

单下划线后缀名称

  • 通常用于和 Python 关键词区分开来，比如我们需要一个变量叫做 class，但 class 是
    Python 的关键词，就可以以单下划线结尾写作class_。

双下划线

双下划线前缀名称

这表示这是一个私有成员（属性或者方法）。它无法直接像公有成员一样随便访问。双下划线开头的命名形式在 Python 的类成员中使用表示名字改编，即如果 Test 类里有一成员 __x，那么dir(Test) 时会看到 _Test__x 而非__x。这是为了避免该成员的名称与子类中的名称冲突，方便父类和子类中该成员的区分识别。但要注意这要求该名称末尾最多有一个下划线。e.g.

双下划线前缀及后缀名称

一种约定，Python 内部的名字，用来区别其他用户自定义的命名, 以防冲突。是一些 Python 的“魔术”对象，表示这是一个特殊成员。如类成员的 __init__、__del__、__add__ 等，以及全局的 __file__、__name__ 等。Python 官方推荐永远不要将这样的命名方式应用于自己的变量或函数，而是按照文档说明来使用 Python 内置的这些特殊成员。

Python 中关于私有属性、方法约定问题，官方文档如下

“Private”instance variables that cannot be accessed except from inside an object don’t exist in Python. However, there is a convention that is followed by most Python code: a name prefixed with an underscore (e.g. _spam) should be treated as a non-public part of the API (whether it is a function, a method or a data member). It should be considered an implementation detail and subject to change without notice.

Since there is a valid use-case for class-private members (namely to avoid name clashes of names with names defined by subclasses), there is limited support for such a mechanism, called name mangling. Any identifier of the form__spam (at least two leading underscores, at most one trailing underscore) is textually replaced with _classname__spam, where classname is the current class name with leading underscore(s) stripped. This mangling is done without regard to the syntactic position of the identifier, as long as it occurs within the definition of a class.

Name mangling is helpful for letting subclasses override methods without breaking intraclass method calls.

退出移动版