pip._vendor.rich._inspect.Inspect Class Reference

Inheritance diagram for pip._vendor.rich._inspect.Inspect:

Collaboration diagram for pip._vendor.rich._inspect.Inspect:

Public Member Functions
None	__init__ (self, Any obj, *Optional[TextType] title=None, bool help=False, bool methods=False, bool docs=True, bool private=False, bool dunder=False, bool sort=True, bool all=True, bool value=True)
Panel	__rich__ (self)

Public Attributes
	highlighter
	obj
	title
	help
	methods
	docs
	private
	dunder
	sort
	value

Protected Member Functions
Text	_make_title (self, Any obj)
Optional[Text]	_get_signature (self, str name, Any obj)
Iterable[RenderableType]	_render (self)
Optional[str]	_get_formatted_doc (self, Any object_)
Protected Member Functions inherited from pip._vendor.rich.jupyter.JupyterMixin
Dict[str, str]	_repr_mimebundle_ ("ConsoleRenderable" self, Sequence[str] include, Sequence[str] exclude, **Any kwargs)

Detailed Description

A renderable to inspect any Python Object.

Args:
    obj (Any): An object to inspect.
    title (str, optional): Title to display over inspect result, or None use type. Defaults to None.
    help (bool, optional): Show full help text rather than just first paragraph. Defaults to False.
    methods (bool, optional): Enable inspection of callables. Defaults to False.
    docs (bool, optional): Also render doc strings. Defaults to True.
    private (bool, optional): Show private attributes (beginning with underscore). Defaults to False.
    dunder (bool, optional): Show attributes starting with double underscore. Defaults to False.
    sort (bool, optional): Sort attributes alphabetically. Defaults to True.
    all (bool, optional): Show all attributes. Defaults to False.
    value (bool, optional): Pretty print value of object. Defaults to True.

Member Function Documentation

_get_formatted_doc()

Optional[str] pip._vendor.rich._inspect.Inspect._get_formatted_doc (   self, Any  object_  )

protected

Extract the docstring of an object, process it and returns it.
The processing consists in cleaning up the doctring's indentation,
taking only its 1st paragraph if `self.help` is not True,
and escape its control codes.

Args:
    object_ (Any): the object to get the docstring from.

Returns:
    Optional[str]: the processed docstring, or None if no docstring was found.

_get_signature()

Optional[Text] pip._vendor.rich._inspect.Inspect._get_signature (   self, str  name, Any  obj  )

protected

Get a signature for a callable.

_make_title()

Text pip._vendor.rich._inspect.Inspect._make_title (   self, Any  obj  )

protected

Make a default title.

_render()

Iterable[RenderableType] pip._vendor.rich._inspect.Inspect._render (   self )

protected

Render object.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/rich/_inspect.py