Python 中 _ 开头的变量，你了解多少？

一、前言

最近见了很多有意思的 Python module 中代码，比如

def get_key():
    _ = load_dotenv(find_dotenv())
    return os.environ['KEY']

在比如：

_rag_query_text = ""

特别好奇，普通的 Python module中的代码，又不是 Python Class，_ 究竟是啥意思？

二、探索 python _变量的作用

在Python中,以单下划线 _ 开头的名称(如变量、函数或类)被称为"单下划线"名称。它们有一些特殊的含义和用途,遵循了一些惯例和准则。

1. 私有成员: 在类或模块中,以单下划线开头的名称被视为私有的(private)。这是一种命名约定,旨在防止意外覆盖或访问这些名称。但是,Python并不强制实施此约定,它仅仅是一种约定，旨在提醒其他程序员不要在其他代码中直接使用这些变量
2. 避免与Python关键字和内置函数冲突: 通过在变量名前添加单下划线,可以避免与Python关键字和内置函数冲突。例如,你可以使用 _print 作为变量名,而不会与内置函数 print() 冲突。
3. 临时或无关紧要的变量:单下划线常用于表示临时或无关紧要的变量,用于表示一个不需要使用的值,例如在循环中使用 _ 作为计数器变量。如：

for _ in range(5):
    # 执行某些操作，但不需要使用迭代变量的值
    do_something()

1. 特殊变量名: Python还有一些特殊的单下划线名称,具有特定的含义和用途:
   • _(单下划线): 在解释器中表示上一个结果。
   • __name__: 当前模块的名称,如果是主程序,则为 "__main__"。
   • __main__: 作为程序入口点时使用。

总的来说,以单下划线开头的名称主要是一种命名约定,用于指示该名称具有特殊用途或私有性质。但是,Python并不会强制执行这种约定,它只是一种惯例和实践。

那种仅限从一个对象内部访问的“私有”实例变量在 Python 中并不存在。 但是，大多数 Python 代码都遵循这样一个约定：带有一个下划线的名称 (例如 _spam) 应该被当作是 API 的非公有部分 (无论它是函数、方法或是数据成员)。 这应当被视为一个实现细节，可能不经通知即加以改变。

由于存在对于类私有成员的有效使用场景（例如避免名称与子类所定义的名称相冲突），因此存在对此种机制的有限支持，称为 名称改写。 任何形式为 __spam 的标识符（至少带有两个前缀下划线，至多一个后缀下划线）的文本将被替换为 _classname__spam，其中 classname 为去除了前缀下划线的当前类名称。 这种改写不考虑标识符的句法位置，只要它出现在类定义内部就会进行。

三、总结

本文探讨了以单下划线开头的变量在Python中的用途和含义。这些变量可以用作私有成员、避免与关键字和内置函数冲突、表示临时或无关紧要的变量，以及表示特殊的变量名。尽管这些约定并非强制执行，但它们有助于提高代码的可读性和可维护性。在编写Python代码时，遵循这些约定可以帮助开发人员更好地理解和使用变量。