堆栈跟踪中 Python 函数的名称

Question

在 Python2 和 Python3 中，堆栈跟踪中不使用函数的 __name__，而是使用原始名称（在 def 之后指定的名称）。

考虑这个例子：

import traceback

def a():
    return b()

def b():
    return c()

def c():
    print("\n".join(line.strip() for line in traceback.format_stack()))

a.__name__ = 'A'
b.__name__ = 'B'
c.__name__ = 'C'

a();

输出是：

File "test.py", line 16, in <module>
    a();
File "test.py", line 4, in a
    return b()
File "test.py", line 7, in b
    return c()
File "test.py", line 10, in c
    print("\n".join(line.strip() for line in traceback.format_stack()))

为什么会这样？如何更改堆栈跟踪中使用的名称？那么__name__ 属性在哪里使用呢？

Answer 1

所以，基本上每个函数都有三个可以被认为是函数的名称的东西：

代码块原名

它存储在f.__code__.co_name 中（其中f 是函数对象）。如果你使用def orig_name 创建函数，orig_name 就是那个名字。对于lambas，它是<lambda>。

此属性是只读的，不能更改。所以我知道在运行时使用自定义名称创建函数的唯一方法是exec：

exec("""def {name}():
  print '{name}'
""".format(name='any')) in globals()

any()  # prints 'any'

（在对该问题的评论中还提到了更多低级 way to do this。）

co_name 的不变性实际上是有道理的：通过它，您可以确定您在调试器中看到的名称（或只是堆栈跟踪）与您在源代码中看到的名称完全相同（以及文件名和行号）。

函数对象的__name__属性

它也别名为func_name。

您可以修改它 (orig_name.__name__ = 'updated name')，而且您肯定每天都会这样做：@functools.wraps 将已装饰函数的 __name__ 复制到新函数。

__name__ 被pydoc 之类的工具使用，这就是您需要@functools.wraps 的原因：因此您不会在文档中看到每个装饰器的技术细节。看例子：

from functools import wraps

def decorator1(f):
    def decorated(*args, **kwargs):
        print 'start1'
        f(*args, **kwargs)
    return decorated

def decorator2(f):
    @wraps(f)
    def decorated(*args, **kwargs):
        print 'start2'
        f(*args, **kwargs)
    return decorated

@decorator1
def test1():
    print 'test1'

@decorator2
def test2():
    print 'test2'

这是pydoc 的输出：

FUNCTIONS
    decorator1(f)

    decorator2(f)

    test1 = decorated(*args, **kwargs)

    test2(*args, **kwargs)

对于wraps，文档中没有decorated 的迹象。

参考名称

还有一个可以称为函数名的东西（尽管它几乎不是）是存储对该函数的引用的变量或属性的名称。

如果您使用def name 创建函数，则name 属性将添加到当前范围。对于lambda，您应该将结果分配给某个变量：name = lambda: None。

显然，您可以为同一个函数创建多个引用，并且所有引用都可以具有不同的名称。

---

所有这三件事相互连接的唯一方法是def foo 语句，该语句创建__name__ 和__code__.co_name 等于foo 的函数对象，并将其分配给foo 的属性当前范围。但它们不受任何约束，并且可以彼此不同：

import traceback                             

def make_function():                         
    def orig_name():                         
        """Docstring here                    
        """                                  
        traceback.print_stack()              
    return orig_name                         

globals()['name_in_module'] = make_function()
name_in_module.__name__ = 'updated name'     

name_in_module()                             

输出：

  File "my.py", line 13, in <module>
    name_in_module()
  File "my.py", line 7, in orig_name
    traceback.print_stack()

Pydoc：

FUNCTIONS
    make_function()

    name_in_module = updated name()
        Docstring here

---

我感谢其他人的 cmets 和答案，他们帮助我整理了我的想法和知识。

Answer 2

试图探索CPython 的实现，绝对不是专家。正如 cmets 中所指出的，当打印 f 的堆栈条目时，属性f.__code__.co_nameis used。还有f.__name__is initially set转f.__code__.co_name，but when you modify前者，后者不做相应修改。

因此，我尝试直接对其进行修改，但不可能：

>>> f.__code__.co_name = 'g'
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
TypeError: readonly attribute
>>>

为什么有两种方法可以说出函数的名称？好吧，according to the documentation、__name__ 是为“类、函数、方法、描述符或生成器实例”定义的，所以对于函数，它映射到该属性，对于其他对象，它将映射到其他对象。