Python name 原理及用法详解

在 Python 中，__name__ 是一个特殊的变量，在不同的情况下功能不同。本文将详细介绍 __name__ 的原理及用法，帮助读者理解并正确使用该变量。

name 原理

在 Python 中，每个模块（module）都有一个内置的名称变量 __name__，该变量的值取决于模块是被导入还是被直接执行。当模块被直接执行时，__name__ 的值为 "__main__"；当模块被导入时，__name__ 的值为模块的名称（不包含 .py 后缀）。这个判断可以通过一个简单的例子来证明：

# example.py
print(__name__)

执行 python example.py，输出结果为 "__main__"，表示该模块是被直接执行的；而在其他模块中 import example 后执行，则输出结果为 "example"，表示该模块被导入了。

name 的用法

将模块作为脚本执行

如果将 Python 源文件作为脚本直接执行，而不是将其作为模块导入，那么 __name__ 就变成了 "__main__"，这时我们可以通过判断 __name__ 的值来区分代码是被导入还是被直接执行。

例如，我们将代码写在 example.py 文件中，如果我们想在 example.py 文件顶部添加几行脚本式的命令行接口（command-line interface, CLI）代码，我们可以将该代码放在如下判断语句的内部：

if __name__ == '__main__':
    # CLI code here

这样我们就可以把该代码当作一个简单的 CLI 工具使用。如果我们在命令行中直接执行 example.py，那么该语句块就会被执行；如果我们将 example.py 作为模块导入，那么该语句块就不会被执行。

将模块作为库导入

当我们将一个模块作为库导入时，如果我们想要运行该模块内的一些代码，可以将这些代码放在一个函数或者一个代码块中，供外部程序调用。这样，外部程序在导入该模块时，就可以通过调用该函数或代码块来执行该部分代码。

例如，我们可以将代码写成如下形式：

# example.py

def say_hello():
    print("Hello, world!")

if __name__ == '__main__':
    say_hello()

在其他模块中，我们可以通过 import example 后调用 example.say_hello() 来执行 say_hello() 函数。注意，if __name__ == '__main__': 这个判断代码块中的代码只有在该模块作为脚本执行时才会被执行，而在其他模块中导入该模块时则不会执行。

示例

示例 1: 将模块作为脚本执行时的应用

我们定义一个 calc.py 文件，该文件可以把两个数进行加减乘除操作，下面我们就可以通过命令行来调用该脚本来进行数学计算：

# calc.py

def add(x, y):
    return x + y

def subtract(x, y):
    return x - y

def multiply(x, y):
    return x * y

def divide(x, y):
    if y == 0:
        raise ValueError('Cannot divide by zero!')
    return x / y

if __name__ == '__main__':
    # command-line interface
    print("Welcome to use calc.py!")
    print("Please input two numbers (a b) and an operator (+, -, *, /) separated by a space:")
    a, b, operator = input().split()
    a, b = float(a), float(b)
    if operator == '+':
        print("{} + {} = {}".format(a, b, add(a, b)))
    elif operator == '-':
        print("{} - {} = {}".format(a, b, subtract(a, b)))
    elif operator == '*':
        print("{} * {} = {}".format(a, b, multiply(a, b)))
    elif operator == '/':
        print("{} / {} = {}".format(a, b, divide(a, b)))
    else:
        print("Sorry, unsupported operator.")

保存之后，在命令行输入 python calc.py ，出现 Welcome to use calc.py! 提示语后即可使用该脚本进行计算。

示例 2: 将模块作为库导入时的应用

我们定义一个 greet.py 文件，该文件可以使用 say_hello 函数向用户名字打招呼：

# greet.py

def say_hello(name):
    print("Hello, {}!".format(name))

在其他模块中，我们可以通过导入 greet 模块后使用 greet.say_hello() 函数来向指定用户名字打招呼：

# main.py

import greet

greet.say_hello("Alice")
greet.say_hello("Bob")

保存 main.py 文件并执行，即可看到程序打印出了 "Hello, Alice!" 和 "Hello, Bob!" 两个招呼语句。

以上就是 __name__ 原理及用法的详细介绍，希望本文对你在 Python 编程中的使用有所帮助。