问题:在Python中获取对象的全限定类名
出于记录目的,我想检索Python对象的完全限定的类名。(对于完全限定,我的意思是类名称,包括软件包和模块名称。)
我知道x.__class__.__name__
,但是有一种简单的方法来获取软件包和模块吗?
For logging purposes I want to retrieve the fully qualified class name of a Python object. (With fully qualified I mean the class name including the package and module name.)
I know about x.__class__.__name__
, but is there a simple method to get the package and module?
回答 0
随着以下程序
#! /usr/bin/env python
import foo
def fullname(o):
# o.__module__ + "." + o.__class__.__qualname__ is an example in
# this context of H.L. Mencken's "neat, plausible, and wrong."
# Python makes no guarantees as to whether the __module__ special
# attribute is defined, so we take a more circumspect approach.
# Alas, the module name is explicitly excluded from __qualname__
# in Python 3.
module = o.__class__.__module__
if module is None or module == str.__class__.__module__:
return o.__class__.__name__ # Avoid reporting __builtin__
else:
return module + '.' + o.__class__.__name__
bar = foo.Bar()
print fullname(bar)
并Bar
定义为
class Bar(object):
def __init__(self, v=42):
self.val = v
输出是
$ ./prog.py
foo.Bar
With the following program
#! /usr/bin/env python
import foo
def fullname(o):
# o.__module__ + "." + o.__class__.__qualname__ is an example in
# this context of H.L. Mencken's "neat, plausible, and wrong."
# Python makes no guarantees as to whether the __module__ special
# attribute is defined, so we take a more circumspect approach.
# Alas, the module name is explicitly excluded from __qualname__
# in Python 3.
module = o.__class__.__module__
if module is None or module == str.__class__.__module__:
return o.__class__.__name__ # Avoid reporting __builtin__
else:
return module + '.' + o.__class__.__name__
bar = foo.Bar()
print fullname(bar)
and Bar
defined as
class Bar(object):
def __init__(self, v=42):
self.val = v
the output is
$ ./prog.py
foo.Bar
回答 1
提供的答案不涉及嵌套类。尽管直到Python 3.3(PEP 3155)才可用__qualname__
,但您确实想使用该类。最终(3.4?PEP 395),__qualname__
模块也将存在,以处理模块被重命名的情况(即,将其重命名为__main__
)。
The provided answers don’t deal with nested classes. Though it’s not available until Python 3.3 (PEP 3155), you really want to use __qualname__
of the class. Eventually (3.4? PEP 395), __qualname__
will also exist for modules to deal with cases where the module is renamed (i.e. when it is renamed to __main__
).
回答 2
考虑使用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'>
Consider using the inspect
module which has functions like getmodule
which might be what are looking for:
>>>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'>
回答 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__
)
Here’s one based on Greg Bacon’s excellent answer, but with a couple of extra checks:
__module__
can be None
(according to the docs), and also for a type like str
it can be __builtin__
(which you might not want appearing in logs or whatever). The following checks for both those possibilities:
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__
(There might be a better way to check for __builtin__
. The above just relies on the fact that str is always available, and its module is always __builtin__
)
回答 4
对于python3.7我使用:
".".join([obj.__module__, obj.__name__])
获得:
package.subpackage.ClassName
For python3.7 I use:
".".join([obj.__module__, obj.__name__])
Getting:
package.subpackage.ClassName
回答 5
__module__
会成功的
尝试:
>>> import re
>>> print re.compile.__module__
re
该站点建议这__package__
可能适用于Python 3.0。但是,此处给出的示例在我的Python 2.5.2控制台下不起作用。
__module__
would do the trick.
Try:
>>> import re
>>> print re.compile.__module__
re
This site suggests that __package__
might work for Python 3.0; However, the examples given there won’t work under my Python 2.5.2 console.
回答 6
这是一个hack,但是我支持2.6,只需要简单一些即可:
>>> from logging.handlers import MemoryHandler as MH
>>> str(MH).split("'")[1]
'logging.handlers.MemoryHandler'
This is a hack but I’m supporting 2.6 and just need something simple:
>>> from logging.handlers import MemoryHandler as MH
>>> str(MH).split("'")[1]
'logging.handlers.MemoryHandler'
回答 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
请注意,它对于buildins也可以正常工作:
>>> print(full_name_with_qualname(print))
builtins.print
>>> import builtins
>>> builtins.print
<built-in function print>
Some people (e.g. https://stackoverflow.com/a/16763814/5766934) arguing that __qualname__
is better than __name__
.
Here is an example that shows the difference:
$ 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
Note, it also works correctly for buildins:
>>> print(full_name_with_qualname(print))
builtins.print
>>> import builtins
>>> builtins.print
<built-in function print>
回答 8
由于本主题的兴趣是获取完全限定的名称,因此在将相对导入与同一软件包中现有的主模块一起使用时,会出现一个陷阱。例如,使用以下模块设置:
$ 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
当嗡嗡声使用相对路径导入bar时,bar会看到 Baz.__module__
只是“ baz”,但是在第二次使用全名的导入中,bar却看到与“ foo.baz”相同。
如果要在某处保留标准名称,则最好避免这些类的相对导入。
Since the interest of this topic is to get fully qualified names, here is a pitfall that occurs when using relative imports along with the main module existing in the same package. E.g., with the below module setup:
$ 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
Here is the output showing the result of importing the same module differently:
$ 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
When hum imports bar using relative path, bar sees Baz.__module__
as just “baz”, but in the second import that uses full name, bar sees the same as “foo.baz”.
If you are persisting the fully-qualified names somewhere, it is better to avoid relative imports for those classes.
回答 9
这里没有答案对我有用。就我而言,我使用的是Python 2.7,并且知道我只会使用newstyle object
类。
def get_qualified_python_name_from_class(model):
c = model.__class__.__mro__[0]
name = c.__module__ + "." + c.__name__
return name
None of the answers here worked for me. In my case, I was using Python 2.7 and knew that I would only be working with newstyle object
classes.
def get_qualified_python_name_from_class(model):
c = model.__class__.__mro__[0]
name = c.__module__ + "." + c.__name__
return name