pandas 1.4.2

ParametersRaises
register_option(key: 'str', defval: 'object', doc: 'str' = '', validator: 'Callable[[object], Any] | None' = None, cb: 'Callable[[str], Any] | None' = None) -> 'None'

Parameters

key : str

Fully-qualified key, e.g. "x.y.option - z".

defval : object

Default value of the option.

doc : str

Description of the option.

validator : Callable, optional

Function of a single argument, should raise :None:None:`ValueError` if called with a value which is not a legal value for the option.

cb :

a function of a single argument "key", which is called immediately after an option value is set/reset. key is the full name of the option.

Raises

ValueError if `validator` is specified and `defval` is not a valid value.

Register an option in the package-wide pandas config object

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/_config/config.py#445
type: <class 'function'>
Commit: