This is a development version (9.18.0.dev) and may be unstable.Go to latest (9.17.0)
{ } Raw JSON

bundles / IPython 9.18.0.dev / IPython / core / oinspect / Inspector / pinfo

function

IPython.core.oinspect:Inspector.pinfo

source: /IPython/core/oinspect.py:796

Signature

def pinfo(self, obj, oname = '', formatter = None, info: OInfo | None = None, detail_level = 0, enable_html_pager = True, omit_sections = ())

Summary

Show detailed information about an object.

Extended Summary

Optional arguments:

  • oname: name of the variable pointing to the object.

  • formatter: callable (optional)

    A special formatter for docstrings.

    The formatter is a callable that takes a string as an input and returns either a formatted string or a mime type bundle in the form of a dictionary.

    Although the support of custom formatter returning a string instead of a mime type bundle is deprecated.

  • info: a structure with some information fields which may have been precomputed already.

  • detail_level: if set to 1, more information is given.

  • omit_sections: set of section keys and titles to omit

Aliases

  • IPython.core.oinspect.Inspector.pinfo