pandas 1.4.2

ParametersReturns
format_object_summary(obj, formatter: 'Callable', is_justify: 'bool' = True, name: 'str | None' = None, indent_for_name: 'bool' = True, line_break_each_value: 'bool' = False) -> 'str'

Parameters

obj : object

must be iterable and support __getitem__

formatter : callable

string formatter for an element

is_justify : bool

should justify the display

name : name, optional

defaults to the class name of the obj

indent_for_name : bool, default True

Whether subsequent lines should be indented to align with the name.

line_break_each_value : bool, default False

If True, inserts a line break for each value of obj . If False, only break lines when the a line of values gets wider than the display width.

versionadded

Returns

summary string

Return the formatted obj as a unicode string

Examples

See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them


File: /pandas/io/formats/printing.py#286
type: <class 'function'>
Commit: