pandas 1.4.2

ParametersRaises
deprecate_option(key: 'str', msg: 'str | None' = None, rkey: 'str | None' = None, removal_ver: 'str | None' = None) -> 'None'

Neither the existence of :None:None:`key` nor that if :None:None:`rkey` is checked. If they do not exist, any subsequence access will fail as usual, after the deprecation warning is given.

Parameters

key : str

Name of the option to be deprecated. must be a fully-qualified option name (e.g "x.y.z.rkey").

msg : str, optional

Warning message to output when the key is referenced. if no message is given a default message will be emitted.

rkey : str, optional

Name of an option to reroute access to. If specified, any referenced :None:None:`key` will be re-routed to :None:None:`rkey` including set/get/reset. rkey must be a fully-qualified option name (e.g "x.y.z.rkey"). used by the default message if no msg is specified.

removal_ver : str, optional

Specifies the version in which this option will be removed. used by the default message if no msg is specified.

Raises

OptionError

If the specified key has already been deprecated.

Mark option :None:None:`key` as deprecated, if code attempts to access this option, a warning will be produced, using msg if given, or a default message if not. if :None:None:`rkey` is given, any access to the key will be re-routed to :None:None:`rkey`.

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#520
type: <class 'function'>
Commit: