### Python 中 `__all__` 和 `__name__` 的作用及用法 #### 一、`__all__` 的作用及用法 在 Python 模块中，`__all__` 是一个特殊的列表变量，用于显式定义哪些属性或方法可以通过 `from module import *` 导入到其他模块中。如果没有定义 `__all__`，那么默认情况下，只有那些未以下划线开头的全局对象会被导入。 具体来说： - 当开发者希望控制通过 `from ... import *` 方式可以访问的内容时，可以在模块中设置 `__all__` 列表。 - 如果设置了 `__all__ = ['A', 'B']`，则即使模块中有更多可导出的对象（如 C），也只有 A 和 B 能被成功导入[^2]。 示例代码如下： ```python # test.py 文件内容 def func_A(): return "Function A" def func_B(): return "Function B" def func_C(): return "Function C" __all__ = ["func_A", "func_B"] # 只允许导出 func_A 和 func_B ``` 在这种情况下，如果另一个脚本尝试使用 `from test import *`，只会导入 `func_A` 和 `func_B`，而不会导入 `func_C`。 --- #### 二、`__name__` 的作用及用法 `__name__` 是 Python 提供的一个内置系统变量，表示当前模块的名字。它的主要用途是用来区分模块是在单独运行还是被当作模块引入： - **当模块独立运行时**：`__name__` 的值为 `"__main__"`。 - **当模块被其他文件导入时**：`__name__` 的值为模块的实际名称（即文件名去掉 `.py` 后缀的部分）。 这种特性常用来编写测试代码，在开发阶段验证功能是否正常工作，而不影响将其作为依赖项导入的情况。通常的做法是将测试逻辑放入以下条件语句中： ```python if __name__ == "__main__": # 测试代码部分 pass ``` 这样做的好处在于，当此模块被直接执行时会触发内部的测试逻辑；然而，一旦它是作为一个库被外部程序加载，则跳过这些测试逻辑[^1]。 --- ### 总结对比 | 特性 | 描述 | |--------------|----------------------------------------------------------------------| | **`__all__`** | 控制 `from module import *` 所能导入的具体成员名单 | | **`__name__`**| 表明当前模块的身份标识，判断其是以主程序形式运行还是被其他地方引用 | --- #### 示例综合应用 下面是一个完整的例子展示如何联合运用这两个概念： ```python # my_module.py 文件内容 def public_function(): """这是一个公开可用的功能""" return "Public Function Called!" def _private_function(): """这是仅供内部使用的私有函数""" return "Private Function Called!" if __name__ == "__main__": print(public_function()) # 输出 Public Function Called! __all__ = ["public_function"] # 显式声明仅暴露 public_function 函数给外界 ``` 在此基础上，假如存在另一段代码试图利用上述模块： ```python # another_script.py 文件内容 from my_module import * print(public_function()) # 正确打印 Public Function Called! try: print(_private_function()) # 报错 NameError: name '_private_function' is not defined except Exception as e: print(e) ``` 可以看到由于 `_private_function()` 并不在 `__all__` 定义范围内，故无法经由星号通配符获取到它。 ---