Як я заглядаю всередину об’єкта Python?

Я починаю кодувати різні проекти за допомогою Python (включаючи веб-розробку Django та розробку ігор Panda3D).

Щоб допомогти мені зрозуміти, що відбувається, я хотів би в основному "заглянути" всередині об'єктів Python, щоб побачити, як вони галочують - як їхні методи та властивості.

Так що скажіть, у мене є об’єкт Python, що мені потрібно, щоб роздрукувати його вміст? Це навіть можливо?

Python має сильний набір особливостей самоаналізу.

Погляньте на такі вбудовані функції :

• type()
• dir()
• id()
• getattr()
• hasattr()
• globals()
• locals()
• callable()

type()і dir()особливо корисні для огляду типу об'єкта та його набору атрибутів відповідно.

object.__dict__

Спочатку прочитайте джерело.

По-друге, використовуйте dir()функцію.

Я здивований, поки ніхто не згадав про допомогу!

In [1]: def foo():
   ...:     "foo!"
   ...:

In [2]: help(foo)
Help on function foo in module __main__:

foo()
    foo!

Довідка дозволяє прочитати docstring та отримати уявлення про те, якими атрибутами може бути клас, що дуже корисно.

Якщо це для дослідження, щоб побачити, що відбувається, я рекомендую подивитися на IPython . Це додає різні ярлики для отримання документації на об'єкти, властивостей і навіть вихідного коду. Наприклад, додавання "?" функції дасть допомогу для об'єкта (фактично, ярлик для "help (obj)", коли використовується два? 's ("func?? ") буде відображено вихідний код, якщо він доступний.

Також є маса додаткових зручностей, таких як заповнення вкладок, досить друк результатів, історія результатів тощо, що робить його дуже зручним для такого роду дослідницьких програмувань.

Для більш програмного використання інтроспекції, основні вбудовані команди люблять dir(), vars(), і getattrт.д. буде корисно, але це добре стоїть вашого часу , щоб перевірити інспектувати модуль. Щоб отримати джерело функції, використовуйте, inspect.getsourceнаприклад, " " застосувавши його до себе:

>>> print inspect.getsource(inspect.getsource)
def getsource(object):
    """Return the text of the source code for an object.

    The argument may be a module, class, method, function, traceback, frame,
    or code object.  The source code is returned as a single string.  An
    IOError is raised if the source code cannot be retrieved."""
    lines, lnum = getsourcelines(object)
    return string.join(lines, '')

inspect.getargspec також часто корисний, якщо ви маєте справу з обгортанням або маніпулюванням функціями, оскільки він дасть імена та значення за замовчуванням параметрів функції.

Якщо вас зацікавив графічний інтерфейс, погляньте на objbrowser . Для введення об'єкта під ним використовується модуль перевірки зі стандартної бібліотеки Python.

Ви можете перерахувати атрибути об'єкта з dir () в оболонці:

>>> dir(object())
['__class__', '__delattr__', '__doc__', '__format__', '__getattribute__', '__hash__', '__init__', '__new__', '__reduce__', '__reduce_ex__', '__repr__', '__setattr__', '__sizeof__', '__str__', '__subclasshook__']

Звичайно, є і модуль перевірки: http://docs.python.org/library/inspect.html#module-inspect

"""Visit http://diveintopython.net/"""

__author__ = "Mark Pilgrim (mark@diveintopython.org)"


def info(object, spacing=10, collapse=1):
    """Print methods and doc strings.

    Takes module, class, list, dictionary, or string."""
    methodList = [e for e in dir(object) if callable(getattr(object, e))]
    processFunc = collapse and (lambda s: " ".join(s.split())) or (lambda s: s)
    print "\n".join(["%s %s" %
                     (method.ljust(spacing),
                      processFunc(str(getattr(object, method).__doc__)))
                     for method in methodList])

if __name__ == "__main__":
    print help.__doc__

Спробуйте ppretty

from ppretty import ppretty


class A(object):
    s = 5

    def __init__(self):
        self._p = 8

    @property
    def foo(self):
        return range(10)


print ppretty(A(), indent='    ', depth=2, width=30, seq_length=6,
              show_protected=True, show_private=False, show_static=True,
              show_properties=True, show_address=True)

Вихід:

__main__.A at 0x1debd68L (
    _p = 8, 
    foo = [0, 1, 2, ..., 7, 8, 9], 
    s = 5
)

Інші вже згадували вбудований dir (), який звучить як те, що ви шукаєте, але ось ще одна непогана порада. Багато бібліотек, включаючи більшість стандартних бібліотек, поширюються у вихідному вигляді. Це означає, що ви можете легко читати вихідний код безпосередньо. Хитрість полягає в тому, щоб знайти його; наприклад:

>>> import string
>>> string.__file__
'/usr/lib/python2.5/string.pyc'

Файл * .pyc компілюється, тож видаліть проміжний 'c' та відкрийте некомпільований * .py файл у вашому улюбленому редакторі чи переглядачі файлів:

/usr/lib/python2.5/string.py

Я вважаю це надзвичайно корисним для виявлення речей, на зразок яких винятки зібрано із заданого API. Цей вид деталей рідко є добре задокументованим у світі Python.

Хоча pprintце вже згадувалося іншими, я хотів би додати деякий контекст.

Модуль pprint забезпечує можливість «симпатичного друку» довільних структур даних Python у формі, яка може бути використана як вхід до інтерпретатора. Якщо форматовані структури включають об'єкти, які не є основними типами Python, представлення може бути не завантажуваним. Це може бути так, якщо включені такі об'єкти, як файли, сокети, класи або екземпляри, а також багато інших вбудованих об'єктів, які не можуть бути представлені константами Python.

pprint Можливо, користуються великим попитом розробники з фоном PHP, які шукають альтернативу var_dump() .

Об'єкти з атрибутом dict можна красиво скинути за допомогою pprint()змішаного з vars(), який повертає __dict__атрибут для модуля, класу, екземпляра тощо:

from pprint import pprint
pprint(vars(your_object))

Отже, не потрібно петлі .

Для скидання всіх змінних, що містяться у глобальній чи локальній області, просто використовуйте:

pprint(globals())
pprint(locals())

locals()показує змінні, визначені у функції.
Також корисно отримати доступ до функцій з відповідним ім'ям як рядкового ключа, серед інших звичаїв :

locals()['foo']() # foo()
globals()['foo']() # foo()

Аналогічно, використовуючи dir() для перегляду вміст модуля або атрибути об'єкта.

А ще є більше.

Якщо ви хочете подивитися на параметри та методи, як зазначали інші, ви можете цілком використовувати pprintабоdir()

Якщо ви хочете побачити фактичне значення вмісту, ви можете зробити це

object.__dict__

Два чудові інструменти для перевірки коду:

1. IPython . Термінал python, який дозволяє перевірити, використовуючи завершення вкладки.

2. Затемнення за допомогою плагіна PyDev . Він має чудовий налагоджувач, який дозволяє зламати на заданому місці та оглянути об’єкти, переглядаючи всі змінні як дерево. Ви навіть можете використовувати вбудований термінал, щоб спробувати код на цьому місці або введіть об’єкт і натисніть '.' щоб він дав вам підказки для коду.

pprint та dir разом чудово працюють

Для цього існує побудова бібліотеки кодів пітона: ознайомтеся з Введеним у Python 2.7

Якщо вам цікаво переглянути вихідний код функції, що відповідає об'єкту myobj, ви можете ввести iPythonабо Jupyter Notebook:

myobj??

import pprint

pprint.pprint(obj.__dict__)

або

pprint.pprint(vars(obj))

Якщо ви хочете заглянути всередину живого об’єкта, то inspectмодуль python - це хороша відповідь. Загалом, він працює для отримання вихідного коду функцій, визначених у вихідному файлі десь на диску. Якщо ви хочете отримати джерело живих функцій та лямбда, які були визначені в інтерпретаторі, ви можете скористатися dill.source.getsourceз dill. Він також може отримати код для методів та функцій, пов'язаних або незв'язаних класів, визначених у curries ... однак, ви не зможете скласти цей код без коду об'єкта, що додається.

>>> from dill.source import getsource
>>> 
>>> def add(x,y):
...   return x+y
... 
>>> squared = lambda x:x**2
>>> 
>>> print getsource(add)
def add(x,y):
  return x+y

>>> print getsource(squared)
squared = lambda x:x**2

>>> 
>>> class Foo(object):
...   def bar(self, x):
...     return x*x+x
... 
>>> f = Foo()
>>> 
>>> print getsource(f.bar)
def bar(self, x):
    return x*x+x

>>> 

vars (obj) повертає атрибути об'єкта.

Крім того, якщо ви хочете заглянути все в список і словники, ви можете використовувати pprint ()

Уже є багато хороших підказок, але найкоротший і найпростіший (не обов’язково найкращий) ще належить згадати:

object?

Спробуйте скористатися:

print(object.stringify())

• де objectім'я змінної об'єкта, який ви намагаєтесь перевірити.

Це виводить добре відформатований та вкладений вихід, який показує всю ієрархію клавіш і значень в об'єкті.

ПРИМІТКА. Це працює в python3. Не впевнений, чи працює він у попередніх версіях

ОНОВЛЕННЯ: Це працює не на всіх типах об'єктів. Якщо ви зіткнулися з одним із цих типів (наприклад, об'єктом запиту), скористайтеся одним із наведених нижче варіантів:

• dir(object())

або

import pprint тоді: pprint.pprint(object.__dict__)