Jak zajrzeć do obiektu Python?

Zaczynam pisać w różnych projektach przy użyciu Pythona (w tym tworzenie stron internetowych Django i tworzenie gier Panda3D).

Aby pomóc mi zrozumieć, co się dzieje, chciałbym po prostu „spojrzeć” wewnątrz obiektów Pythona, aby zobaczyć, jak zaznaczają - podobnie jak ich metody i właściwości.

Powiedzmy, że mam obiekt Python. Czego potrzebowałbym do wydrukowania jego zawartości? Czy to w ogóle możliwe?

Python ma silny zestaw funkcji introspekcji.

Spójrz na następujące wbudowane funkcje :

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

type()i dir()są szczególnie przydatne do sprawdzania odpowiednio typu obiektu i jego zestawu atrybutów.

object.__dict__

Najpierw przeczytaj źródło.

Po drugie, użyj dir()funkcji.

Dziwi mnie, że nikt jeszcze nie wspomniał o pomocy!

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

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

foo()
    foo!

Pomoc pozwala przeczytać dokumentację i dowiedzieć się, jakie atrybuty może mieć klasa, co jest dość pomocne.

Jeśli jest to eksploracja, aby zobaczyć, co się dzieje, polecam spojrzeć na IPython . Dodaje to różne skróty w celu uzyskania dokumentacji obiektów, właściwości, a nawet kodu źródłowego. Na przykład dołączając „?” funkcja da pomoc dla obiektu (w rzeczywistości skrót do „help (obj)”, co przy użyciu dwóch? („ func??”) wyświetli kod źródłowy, jeśli jest dostępny.

Istnieje również wiele dodatkowych udogodnień, takich jak uzupełnianie tabulatorów, ładne drukowanie wyników, historia wyników itp., Które sprawiają, że jest to bardzo przydatne w tego rodzaju programowaniu eksploracyjnym.

Dla bardziej programowego wykorzystania introspekcji, podstawowe builtins podoba dir(), vars(), getattretc będzie użyteczny, ale jest warta twojego czasu na sprawdzeniu sprawdzić moduł. Aby pobrać źródło funkcji, użyj „ inspect.getsource” np., Stosując ją do siebie:

>>> 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 jest również często przydatny, jeśli masz do czynienia z zawijaniem lub manipulowaniem funkcjami, ponieważ poda nazwy i wartości domyślne parametrów funkcji.

Jeśli interesuje Cię GUI, spójrz na objbrowser . Wykorzystuje moduł inspekcji ze standardowej biblioteki Python do introspekcji obiektów pod spodem.

Możesz wymienić atrybuty obiektu za pomocą dir () w powłoce:

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

Oczywiście istnieje również moduł inspekcji: 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__

Spróbuj 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)

Wynik:

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

Inni wspominali już o wbudowanym dir (), który brzmi jak to, czego szukasz, ale oto kolejna dobra wskazówka. Wiele bibliotek - w tym większość bibliotek standardowych - jest rozpowszechnianych w formie źródłowej. Oznacza to, że możesz dość łatwo odczytać kod źródłowy bezpośrednio. Sztuka polega na znalezieniu go; na przykład:

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

Plik * .pyc jest skompilowany, więc usuń końcowy „c” i otwórz nieskompilowany plik * .py w swoim ulubionym edytorze lub przeglądarce plików:

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

Uważam, że jest to niezwykle przydatne do odkrywania rzeczy, takich jak które wyjątki są wywoływane z danego API. Tego rodzaju szczegóły rzadko są dobrze udokumentowane w świecie Pythona.

Chociaż pprintinni już wspominali, chciałbym dodać trochę kontekstu.

Moduł pprint umożliwia „dowolne drukowanie” dowolnych struktur danych w języku Python w formie, która może być wykorzystana jako dane wejściowe do interpretera. Jeśli sformatowane struktury zawierają obiekty, które nie są podstawowymi typami języka Python, reprezentacja może nie być wczytywalna. Może tak być w przypadku uwzględnienia obiektów takich jak pliki, gniazda, klasy lub instancje, a także wielu innych wbudowanych obiektów, które nie są reprezentowalne jako stałe Pythona.

pprintmoże być bardzo poszukiwany przez programistów z doświadczeniem PHP, którzy szukają alternatywy dla var_dump().

Obiekty z atrybutem dict można ładnie zrzucić za pomocą pprint()mieszania z vars(), co zwraca __dict__atrybut dla modułu, klasy, instancji itp .:

from pprint import pprint
pprint(vars(your_object))

Więc nie ma potrzeby pętli .

Aby zrzucić wszystkie zmienne zawarte w zasięgu globalnym lub lokalnym, po prostu użyj:

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

locals()pokazuje zmienne zdefiniowane w funkcji.
Przydatny jest również dostęp do funkcji z odpowiadającą im nazwą jako kluczem ciągłym , między innymi :

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

Podobnie, za pomocą, dir()aby zobaczyć zawartość modułu lub atrybuty obiektu.

I jest jeszcze więcej.

Jeśli chcesz przyjrzeć się parametrom i metodom, jak zauważyli inni, możesz użyć pprintlubdir()

Jeśli chcesz zobaczyć rzeczywistą wartość zawartości, możesz to zrobić

object.__dict__

Dwa świetne narzędzia do sprawdzania kodu to:

1. IPython . Terminal pythonowy, który pozwala na sprawdzenie za pomocą uzupełniania tabulacji.

2. Zaćmienie za pomocą wtyczki PyDev . Ma doskonały debugger, który pozwala na łamanie w danym miejscu i sprawdzanie obiektów poprzez przeglądanie wszystkich zmiennych jako drzewa. Możesz nawet użyć wbudowanego terminala, aby wypróbować kod w tym miejscu lub wpisać obiekt i nacisnąć „.” aby zawierał podpowiedzi do kodu.

pprint i dir razem działają świetnie

Do tego celu służy kompilacja biblioteki kodów Pythona: inspekcja Wprowadzono w Pythonie 2.7

Jeśli chcesz zobaczyć kod źródłowy funkcji odpowiadającej obiektowi myobj, możesz wpisać iPythonlub Jupyter Notebook:

myobj??

import pprint

pprint.pprint(obj.__dict__)

lub

pprint.pprint(vars(obj))

Jeśli chcesz zajrzeć do aktywnego obiektu, inspectdobrą odpowiedzią jest moduł Pythona . Ogólnie rzecz biorąc, działa w celu uzyskania kodu źródłowego funkcji zdefiniowanych w pliku źródłowym gdzieś na dysku. Jeśli chcesz uzyskać źródło funkcji na żywo i lambd, które zostały zdefiniowane w tłumaczu, możesz użyć dill.source.getsourcez dill. Może również uzyskać kod z metod klasy i funkcji powiązanych lub niezwiązanych zdefiniowanych w curry ... jednak kompilacja tego kodu może nie być możliwa bez kodu obiektu otaczającego.

>>> 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) zwraca atrybuty obiektu.

Ponadto, jeśli chcesz przejrzeć listę i słowniki, możesz użyć pprint ()

Wiele dobrych wskazówek już teraz, ale o najkrótszych i najłatwiejszych (niekoniecznie najlepszych) trzeba jeszcze wspomnieć:

object?

Spróbuj użyć:

print(object.stringify())

• gdzie objectjest nazwa zmiennej obiektu, który próbujesz sprawdzić.

Wyświetla ładnie sformatowane i tabulowane dane wyjściowe pokazujące całą hierarchię kluczy i wartości w obiekcie.

UWAGA: Działa to w python3. Nie jestem pewien, czy działa we wcześniejszych wersjach

AKTUALIZACJA: To nie działa na wszystkich typach obiektów. Jeśli napotkasz jeden z tych typów (np. Obiekt Request), użyj jednego z następujących:

• dir(object())

lub

import pprint następnie: pprint.pprint(object.__dict__)