python - 在 Python 中获取对象的完全限定类名

Question

出于记录目的，我想检索 Python 对象的完全限定类名。（完全限定的意思是类名，包括包名和模块名。）

我知道x.__class__.__name__，但是有没有简单的方法来获取包和模块？

Answer 1

使用以下程序

#!/usr/bin/env python

import foo

def fullname(o):
    klass = o.__class__
    module = klass.__module__
    if module == 'builtins':
        return klass.__qualname__ # avoid outputs like 'builtins.str'
    return module + '.' + klass.__qualname__

bar = foo.Bar()
print(fullname(bar))

并Bar定义为

class Bar(object):
  def __init__(self, v=42):
    self.val = v

输出是

$ ./prog.py
foo.Bar

如果您仍然停留在 Python 2 上，则必须使用__name__而不是__qualname__，这对于嵌套类的信息量较少 -Bar嵌套在类中的类Foo将显示为Bar而不是Foo.Bar：

def fullname(o):
    klass = o.__class__
    module = klass.__module__
    if module == '__builtin__':
        return klass.__name__ # avoid outputs like '__builtin__.str'
    return module + '.' + klass.__name__

Answer 2

提供的答案不涉及嵌套类。

从 Python 3.3 ( PEP 3155 ) 开始，您可以使用__qualname__类而不是__name__. 否则，像这样的类

class Foo:
    class Bar: # this one
        pass

将显示为只是Bar而不是Foo.Bar.

（您仍然需要__module__单独附加到 qualname -__qualname__不打算包含模块名称。）

Answer 3

这是基于 Greg Bacon 的出色答案的一个，但有一些额外的检查：

__module__可以是None（根据文档），也str可以是类似的类型__builtin__（您可能不希望出现在日志或其他内容中）。以下检查这两种可能性：

def fullname(o):
    module = o.__class__.__module__
    if module is None or module == str.__class__.__module__:
        return o.__class__.__name__
    return module + '.' + o.__class__.__name__

（可能有更好的方法来检查__builtin__。上面只是依赖于 str 总是可用的事实，并且它的模块总是__builtin__）

Answer 4

考虑使用具有可能正在寻找的inspect功能的模块：getmodule

>>>import inspect
>>>import xml.etree.ElementTree
>>>et = xml.etree.ElementTree.ElementTree()
>>>inspect.getmodule(et)
<module 'xml.etree.ElementTree' from 
        'D:\tools\python2.5.2\lib\xml\etree\ElementTree.pyc'>

Answer 5

对于 python3.7，我使用：

".".join([obj.__module__, obj.__name__])

得到：

package.subpackage.ClassName

Answer 6

__module__会成功的。

尝试：

>>> import re
>>> print re.compile.__module__
re

该站点建议__package__可能适用于 Python 3.0；但是，那里给出的示例在我的 Python 2.5.2 控制台下不起作用。

Answer 7

有些人（例如https://stackoverflow.com/a/16763814/5766934）认为这__qualname__比__name__. 这是一个显示差异的示例：

$ cat dummy.py 
class One:
    class Two:
        pass

$ python3.6
>>> import dummy
>>> print(dummy.One)
<class 'dummy.One'>
>>> print(dummy.One.Two)
<class 'dummy.One.Two'>
>>> def full_name_with_name(klass):
...     return f'{klass.__module__}.{klass.__name__}'
>>> def full_name_with_qualname(klass):
...     return f'{klass.__module__}.{klass.__qualname__}'
>>> print(full_name_with_name(dummy.One))  # Correct
dummy.One
>>> print(full_name_with_name(dummy.One.Two))  # Wrong
dummy.Two
>>> print(full_name_with_qualname(dummy.One))  # Correct
dummy.One
>>> print(full_name_with_qualname(dummy.One.Two))  # Correct
dummy.One.Two

请注意，它也适用于内置函数：

>>> print(full_name_with_qualname(print))
builtins.print
>>> import builtins
>>> builtins.print
<built-in function print>

Answer 8

这是一个 hack，但我支持 2.6，只需要一些简单的东西：

>>> from logging.handlers import MemoryHandler as MH
>>> str(MH).split("'")[1]

'logging.handlers.MemoryHandler'

Answer 9

由于本主题的兴趣是获得完全限定的名称，因此在使用相对导入以及存在于同一包中的主模块时会出现一个陷阱。例如，使用以下模块设置：

$ cat /tmp/fqname/foo/__init__.py
$ cat /tmp/fqname/foo/bar.py
from baz import Baz
print Baz.__module__
$ cat /tmp/fqname/foo/baz.py
class Baz: pass
$ cat /tmp/fqname/main.py
import foo.bar
from foo.baz import Baz
print Baz.__module__
$ cat /tmp/fqname/foo/hum.py
import bar
import foo.bar

以下是显示以不同方式导入相同模块的结果的输出：

$ export PYTHONPATH=/tmp/fqname
$ python /tmp/fqname/main.py
foo.baz
foo.baz
$ python /tmp/fqname/foo/bar.py
baz
$ python /tmp/fqname/foo/hum.py
baz
foo.baz

当 hum 使用相对路径导入 bar 时，barBaz.__module__仅视为“baz”，但在使用全名的第二个导入中，bar 与“foo.baz”相同。

如果您在某处保留完全限定名称，最好避免这些类的相对导入。

Answer 10

这是对Greg Bacon和MB答案的改编，以使用合格的类名。请注意，该问题确实要求提供合格的类名。它使用 Python 3.8 进行了测试。

def fullname(obj: object) -> str:
    """Return the full name of the given object using its module and qualified class names."""
    # Ref: https://stackoverflow.com/a/66508248/
    module_name, class_name = obj.__class__.__module__, obj.__class__.__qualname__
    if module_name in (None, str.__class__.__module__):
        return class_name
    return module_name + "." + class_name

Answer 11

Bellow 只是对 Greg Bacon 答案的改进，针对内置和用户定义的类、实例、方法、函数进行了测试。

def fullname(o):
    try:
        # if o is a class or function, get module directly
        module = o.__module__
    except AttributeError:
        # then get module from o's class
        module = o.__class__.__module__
    try:
        # if o is a class or function, get name directly
        name = o.__qualname__
    except AttributeError:
        # then get o's class name
        name = o.__class__.__qualname__
    # if o is a method of builtin class, then module will be None
    if module == 'builtins' or module is None:
        return name
    return module + '.' + name

Answer 12

这里没有一个答案对我有用。就我而言，我使用的是 Python 2.7，并且知道我只会使用新样式object类。

def get_qualified_python_name_from_class(model):
    c = model.__class__.__mro__[0]
    name = c.__module__ + "." + c.__name__
    return name