Получить полное имя класса объекта в Python
В целях ведения журнала я хочу получить полное имя класса объекта Python. (Под полной квалификацией я подразумеваю имя класса, включая имя пакета и модуля.)
Я знаю о x.__class__.__name__
, но есть ли простой способ получить пакет и модуль?
13 ответов
Со следующей программой
#! /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
Приведенные ответы не относятся к вложенным классам. Хотя он не доступен до Python 3.3 ( PEP 3155), вы действительно хотите использовать __qualname__
класса. В конце концов (3,4? PEP 395), __qualname__
также будет существовать для модулей, чтобы иметь дело со случаями, когда модуль переименовывается (т.е. когда он переименовывается в __main__
).
Вот один из них, основанный на превосходном ответе Грега Бэкона, но с парой дополнительных проверок:
__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__
)
Для python3.7 я использую:
".".join([obj.__module__, obj.__name__])
Получение:
package.subpackage.ClassName
Рассмотрите возможность использования 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'>
Некоторые люди (например, /questions/5676864/poluchit-polnoe-imya-klassa-obekta-v-python/5676870#5676870) утверждают, что __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>
__module__
сделал бы трюк.
Пытаться:
>>> import re
>>> print re.compile.__module__
re
Этот сайт предполагает, что __package__
может работать на Python 3.0; Однако приведенные там примеры не будут работать под моей консолью Python 2.5.2.
Это хак, но я поддерживаю 2.6 и просто нужно что-то простое:
>>> from logging.handlers import MemoryHandler as MH
>>> str(MH).split("'")[1]
'logging.handlers.MemoryHandler'
Bellow - это просто улучшение ответа Грега Бэкона, протестированное для класса, экземпляра, метода, функции, как встроенной, так и определяемой пользователем.
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
Поскольку интерес этой темы состоит в том, чтобы получить полностью определенные имена, здесь есть подводный камень, возникающий при использовании относительного импорта вместе с основным модулем, существующим в том же пакете. Например, с настройкой модуля ниже:
$ 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
Когда гул импортирует бар, используя относительный путь, бар видит Baz.__module__
как просто "baz", но во втором импорте, который использует полное имя, bar видит то же самое, что и "foo.baz".
Если вы сохраняете полные имена где-то, лучше избегать относительного импорта для этих классов.
Это адаптация ответов Грега Бэкона и М.Б. для использования квалифицированного имени класса. Обратите внимание, что вопрос действительно запрашивал полное имя класса. Он был протестирован с 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
Мое решение:
def fullname(obj) -> str:
if type(obj).__qualname__ != "type":
# obj is instance
return ".".join(
[
obj.__class__.__module__,
obj.__class__.__qualname__,
]
)
# obj is not instance
return ".".join([obj.__module__, obj.__qualname__])
# not instance
>>> print(fullname(datetime))
"datetime.datetime"
# instance
>>> print(fullname(datetime.now())
"datetime.datetime"
# instance
>>> print(fullname(3))
"builtins.int"
Ни один из ответов здесь не работал для меня. В моем случае я использовал 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