pandas 1.4.2

ParametersRaisesReturns
validate_bool_kwarg(value, arg_name, none_allowed=True, int_allowed=False)

Parameters

value : bool

Value to be validated.

arg_name : str

Name of the argument. To be reflected in the error message.

none_allowed : bool, default True

Whether to consider None to be a valid boolean.

int_allowed : bool, default False

Whether to consider integer value to be a valid boolean.

Raises

ValueError

If the value is not a valid boolean.

Returns

value

The same value as input.

Ensure that argument passed in arg_name can be interpreted as boolean.

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/util/_validators.py#218
type: <class 'function'>
Commit: