ฉันจะดูภายในวัตถุ 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 เพิ่มทางลัดต่าง ๆ เพื่อรับเอกสารประกอบวัตถุคุณสมบัติและแม้แต่ซอร์สโค้ด ตัวอย่างเช่นการผนวก "?" ฟังก์ชั่นจะให้ความช่วยเหลือสำหรับวัตถุ (ทางลัดที่มีประสิทธิภาพสำหรับ "ความช่วยเหลือ (obj)" ในกรณีที่ใช้สอง? (" func??")) จะแสดงซอร์สโค้ดถ้ามันมีอยู่

นอกจากนี้ยังมีสิ่งอำนวยความสะดวกเพิ่มเติมมากมายเช่นการเติมแท็บ, การพิมพ์ผลลัพธ์, ประวัติผลลัพธ์ ฯลฯ ซึ่งทำให้สะดวกมากสำหรับการเขียนโปรแกรมเชิงสำรวจประเภทนี้

สำหรับการใช้งานการเขียนโปรแกรมมากขึ้นของวิปัสสนาที่ builtins พื้นฐานเช่น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 นอกจากนี้ยังมีประโยชน์บ่อยถ้าคุณกำลังจัดการกับการตัดหรือจัดการฟังก์ชั่นเนื่องจากมันจะให้ชื่อและค่าเริ่มต้นของพารามิเตอร์ฟังก์ชั่น

หากคุณกำลังสนใจใน GUI สำหรับนี้จะดูที่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
)

ในขณะที่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()เพื่อดูเนื้อหาของโมดูลหรือคุณลักษณะของวัตถุ

และยังมีอีกมาก

คนอื่นพูดถึง dir () ในตัวซึ่งฟังดูเหมือนสิ่งที่คุณกำลังมองหา แต่นี่เป็นคำแนะนำที่ดีอีกข้อหนึ่ง ห้องสมุดจำนวนมาก - รวมถึงห้องสมุดมาตรฐานส่วนใหญ่ - กระจายอยู่ในรูปแบบของแหล่งที่มา หมายความว่าคุณสามารถอ่านซอร์สโค้ดได้ง่าย เคล็ดลับอยู่ในการค้นหา ตัวอย่างเช่น:

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

ไฟล์ * .pyc ถูกคอมไพล์ดังนั้นให้ลบส่วนท้าย 'c' และเปิดไฟล์ * .py ที่ยังไม่ได้คอมไพล์ในตัวแก้ไขหรือโปรแกรมดูไฟล์ที่คุณชื่นชอบ:

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

ฉันพบว่าสิ่งนี้มีประโยชน์อย่างมากในการค้นพบสิ่งต่าง ๆ เช่นข้อยกเว้นที่ยกมาจาก API ที่กำหนด รายละเอียดชนิดนี้ไม่ค่อยได้รับการบันทึกไว้อย่างดีในโลก Python

หากคุณต้องการดูพารามิเตอร์และวิธีการตามที่คนอื่น ๆ ได้ชี้ให้เห็นคุณอาจใช้pprintหรือdir()

หากคุณต้องการดูมูลค่าที่แท้จริงของเนื้อหาคุณสามารถทำได้

object.__dict__

เครื่องมือที่ยอดเยี่ยมสำหรับการตรวจสอบโค้ดคือ:

1. IPython หลาม terminal ที่ช่วยให้คุณสามารถตรวจสอบการใช้แท็บเสร็จ

2. คราสกับปลั๊กอิน PyDev มันมีดีบักเกอร์ที่ยอดเยี่ยมที่ช่วยให้คุณสามารถทำลายที่จุดที่กำหนดและตรวจสอบวัตถุโดยการเรียกดูตัวแปรทั้งหมดเป็นต้นไม้ คุณสามารถใช้เทอร์มินัลฝังตัวเพื่อลองโค้ดที่จุดนั้นหรือพิมพ์วัตถุแล้วกด '.' ที่จะมีมันให้คำแนะนำรหัสสำหรับคุณ

pprint และ dir ร่วมกันทำงานได้ดี

มีการสร้างไลบรารี่รหัส ไพ ธ อนเพื่อจุดประสงค์นี้: ตรวจสอบแนะนำใน Python 2.7

หากคุณสนใจที่จะเห็นซอร์สโค้ดของฟังก์ชันที่สอดคล้องกับวัตถุmyobjคุณสามารถพิมพ์iPythonหรือJupyter Notebook:

myobj??

import pprint

pprint.pprint(obj.__dict__)

หรือ

pprint.pprint(vars(obj))

หากคุณต้องการดูภายในวัตถุสดแล้วinspectโมดูลของงูใหญ่เป็นคำตอบที่ดี โดยทั่วไปแล้วจะใช้เพื่อรับซอร์สโค้ดของฟังก์ชั่นที่กำหนดไว้ในไฟล์ต้นฉบับบางแห่งบนดิสก์ หากคุณต้องการที่จะได้รับแหล่งที่มาของฟังก์ชั่นที่อยู่อาศัยและ lambdas ที่ถูกกำหนดไว้ในล่ามที่คุณสามารถใช้จาก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) จะคืนค่าคุณสมบัติของวัตถุ

เคล็ดลับที่ดีหลายอย่างแล้ว แต่สั้นที่สุดและง่ายที่สุด (ไม่จำเป็นต้องดีที่สุด) ยังไม่ได้กล่าวถึง:

object?

นอกจากนี้หากคุณต้องการดูภายในรายการและพจนานุกรมคุณสามารถใช้ pprint ()

ลองใช้:

print(object.stringify())

• โดยที่objectเป็นชื่อตัวแปรของวัตถุที่คุณพยายามตรวจสอบ

สิ่งนี้จะพิมพ์เอาต์พุตที่มีการจัดรูปแบบและแท็บที่แสดงลำดับชั้นของคีย์และค่าทั้งหมดในวัตถุ

หมายเหตุ: มันใช้งานได้ใน python3 ไม่แน่ใจว่าใช้ได้กับเวอร์ชั่นก่อนหน้าหรือไม่

UPDATE: สิ่งนี้ไม่สามารถใช้ได้กับวัตถุทุกประเภท หากคุณพบหนึ่งในประเภทเหล่านั้น (เช่นวัตถุคำขอ) ให้ใช้วิธีใดวิธีหนึ่งต่อไปนี้แทน:

• dir(object())

หรือ

import pprint แล้ว: pprint.pprint(object.__dict__)