U
|
®ý°d59 ã @ sZ d Z ddlmZ ddlmZmZmZmZ ddlZ ddl
|
m Z ddl m Z mZ edeeZedeedZd d
|
Zd d Zd dddZdd Zd dddZd dddZd<ddddddd Zd=dd d d Zd d!d"d#d$Zeddd%d&d'Z ed(d)d%d*d'Z d+d,d%d-d'Z d.d/d0d1d2Z d.d/d3d4d5Z d6d6d6d7d8d9Z d dd:d;Z dS )>zV
|
Module that contains many useful utilities
|
for validating data or function arguments
|
é )Ú annotations)ÚIterableÚSequenceÚTypeVarÚoverloadN)Úlib)Úis_boolÚ
|
is_integerÚBoolishTÚ BoolishNoneTc C sl |dk rt dt|t|krht|| }t|| }|dkrDdnd}t| d| d| d| d d
|
S ) zÀ
|
Checks whether 'args' has length of at most 'compat_args'. Raises
|
a TypeError if that is not the case, similar to in Python when a
|
function is called with too many arguments.
|
r z*'max_fname_arg_count' must be non-negativeé ÚargumentÚ argumentsz() takes at most ú z (z given)N)Ú
|
ValueErrorÚlenÚ TypeError)ÚfnameÚargsÚmax_fname_arg_countÚ compat_argsZ max_arg_countZactual_arg_countr © r úNd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\pandas/util/_validators.pyÚ_check_arg_length s ÿr c C s |D ]}zR|| }|| }|dk r*|dks:|dkr@|dk r@d}n||k}t |sXtdW n$ tk
|
r~ || || k}Y nX |std| d| dqdS )zø
|
Check that the keys in `arg_val_dict` are mapped to their
|
default values as specified in `compat_args`.
|
|
Note that this function is to be called only when it has been
|
checked that arg_val_dict.keys() is a subset of compat_args
|
NFz'match' is not a booleanzthe 'z=' parameter is not supported in the pandas implementation of z())r r )r Z arg_val_dictr ÚkeyZv1Zv2Úmatchr r r Ú_check_for_default_values/ s ÿr ÚNone)Úreturnc C s, t | ||| tt||}t| || dS )a
|
Checks whether the length of the `*args` argument passed into a function
|
has at most `len(compat_args)` arguments and whether or not all of these
|
elements in `args` are set to their default values.
|
|
Parameters
|
----------
|
fname : str
|
The name of the function being passed the `*args` parameter
|
args : tuple
|
The `*args` parameter passed into a function
|
max_fname_arg_count : int
|
The maximum number of arguments that the function `fname`
|
can accept, excluding those in `args`. Used for displaying
|
appropriate error messages. Must be non-negative.
|
compat_args : dict
|
A dictionary of keys and their associated default values.
|
In order to accommodate buggy behaviour in some versions of `numpy`,
|
where a signature displayed keyword arguments but then passed those
|
arguments **positionally** internally when calling downstream
|
implementations, a dict ensures that the original
|
order of the keyword arguments is enforced.
|
|
Raises
|
------
|
TypeError
|
If `args` contains more values than there are `compat_args`
|
ValueError
|
If `args` contains values that do not correspond to those
|
of the default values specified in `compat_args`
|
N)r ÚdictÚzipr )r r r r Úkwargsr r r Ú validate_argsU s r" c C s8 t |t | }|r4t|d }t| d| ddS )z}
|
Checks whether 'kwargs' contains any keys that are not
|
in 'compat_args' and raises a TypeError if there is one.
|
r z'() got an unexpected keyword argument 'ú'N)ÚsetÚlistr )r r! r ZdiffZbad_argr r r Ú_check_for_invalid_keys~ s r& c C s$ | ¡ }t| || t| || dS )aÞ
|
Checks whether parameters passed to the **kwargs argument in a
|
function `fname` are valid parameters as specified in `*compat_args`
|
and whether or not they are set to their default values.
|
|
Parameters
|
----------
|
fname : str
|
The name of the function being passed the `**kwargs` parameter
|
kwargs : dict
|
The `**kwargs` parameter passed into `fname`
|
compat_args: dict
|
A dictionary of keys that `kwargs` is allowed to have and their
|
associated default values
|
|
Raises
|
------
|
TypeError if `kwargs` contains keys not in `compat_args`
|
ValueError if `kwargs` contains keys in `compat_args` that do not
|
map to the default values specified in `compat_args`
|
N)Úcopyr& r )r r! r Úkwdsr r r Úvalidate_kwargs s r) c C sh t | |t| ¡ || tt||}|D ] }||kr,t| d| dq,| |¡ t| || dS )aý
|
Checks whether parameters passed to the *args and **kwargs argument in a
|
function `fname` are valid parameters as specified in `*compat_args`
|
and whether or not they are set to their default values.
|
|
Parameters
|
----------
|
fname: str
|
The name of the function being passed the `**kwargs` parameter
|
args: tuple
|
The `*args` parameter passed into a function
|
kwargs: dict
|
The `**kwargs` parameter passed into `fname`
|
max_fname_arg_count: int
|
The minimum number of arguments that the function `fname`
|
requires, excluding those in `args`. Used for displaying
|
appropriate error messages. Must be non-negative.
|
compat_args: dict
|
A dictionary of keys that `kwargs` is allowed to
|
have and their associated default values.
|
|
Raises
|
------
|
TypeError if `args` contains more values than there are
|
`compat_args` OR `kwargs` contains keys not in `compat_args`
|
ValueError if `args` contains values not at the default value (`None`)
|
`kwargs` contains keys in `compat_args` that do not map to the default
|
value as specified in `compat_args`
|
|
See Also
|
--------
|
validate_args : Purely args validation.
|
validate_kwargs : Purely kwargs validation.
|
|
z-() got multiple values for keyword argument 'r# N)r ÚtupleÚvaluesr r r Úupdater) )r r r! r r Z args_dictr r r r Úvalidate_args_and_kwargs¦ s ( ÿÿ
|
r- TFÚbool)ÚvalueÚ none_allowedÚ int_allowedr c C sN t | }|r|p| dk}|r*|p(t| t}|sJtd| dt| j d| S )aR
|
Ensure that argument passed in arg_name can be interpreted as boolean.
|
|
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.
|
|
Returns
|
-------
|
value
|
The same value as input.
|
|
Raises
|
------
|
ValueError
|
If the value is not a valid boolean.
|
NzFor argument "z$" expected type bool, received type Ú.)r Ú
|
isinstanceÚintr ÚtypeÚ__name__)r/ Zarg_namer0 r1 Z
|
good_valuer r r Úvalidate_bool_kwargà s ÿr7 )Úvalidate_scalar_dict_valuec C s ddl m} | dkr$|dkr$td| dkr>|dk r>||}nR| dk rx|dkrx|rt| ttfrtdt| j dn| dk r|dk rtd| |fS )a$
|
Validate the keyword arguments to 'fillna'.
|
|
This checks that exactly one of 'value' and 'method' is specified.
|
If 'method' is specified, this validates that it's a valid method.
|
|
Parameters
|
----------
|
value, method : object
|
The 'value' and 'method' keyword arguments for 'fillna'.
|
validate_scalar_dict_value : bool, default True
|
Whether to validate that 'value' is a scalar or dict. Specifically,
|
validate that it is not a list or tuple.
|
|
Returns
|
-------
|
value, method : object
|
r )Úclean_fill_methodNz(Must specify a fill 'value' or 'method'.z>"value" parameter must be a scalar or dict, but you passed a "ú"z)Cannot specify both 'value' and 'method'.) Zpandas.core.missingr9 r r3 r% r* r r5 r6 )r/ Úmethodr8 r9 r r r Úvalidate_fillna_kwargs
|
s
|
ÿr< zfloat | Iterable[float]z
|
np.ndarray)Úqr c C sj t | ¡}d}|jdkrBd| kr,dksfn t| |d ¡n$tdd |D sft| |d ¡|S )aå
|
Validate percentiles (used by describe and quantile).
|
|
This function checks if the given float or iterable of floats is a valid percentile
|
otherwise raises a ValueError.
|
|
Parameters
|
----------
|
q: float or iterable of floats
|
A single percentile or an iterable of percentiles.
|
|
Returns
|
-------
|
ndarray
|
An ndarray of the percentiles if valid.
|
|
Raises
|
------
|
ValueError if percentiles are not in given interval([0, 1]).
|
zApercentiles should all be in the interval [0, 1]. Try {} instead.r r g Y@c s s& | ] }d | kodkn V qdS )r r Nr )Ú.0Úqsr r r Ú <genexpr>N s z&validate_percentile.<locals>.<genexpr>)ÚnpZasarrayÚndimr ÚformatÚall)r= Zq_arrÚmsgr r r Úvalidate_percentile1 s
|
|
rF )Ú ascendingr c C s d S ©Nr ©rG r r r Úvalidate_ascendingS s rJ zSequence[BoolishT]zlist[BoolishT]c C s d S rH r rI r r r rJ X s z bool | int | Sequence[BoolishT]zbool | int | list[BoolishT]c s4 ddd t | ts"t| df S fdd| D S )z8Validate ``ascending`` kwargs for ``sort_index`` method.FT)r0 r1 rG c s g | ]}t |d f qS rI )r7 )r> Úitem©r! r r Ú
|
<listcomp>e s z&validate_ascending.<locals>.<listcomp>)r3 r r7 rI r rL r rJ ] s
|
|
z
|
str | Noneztuple[bool, bool])Úclosedr c C sF d}d}| dkrd}d}n$| dkr(d}n| dkr6d}nt d||fS )a%
|
Check that the `closed` argument is among [None, "left", "right"]
|
|
Parameters
|
----------
|
closed : {None, "left", "right"}
|
|
Returns
|
-------
|
left_closed : bool
|
right_closed : bool
|
|
Raises
|
------
|
ValueError : if argument is not among valid values
|
FNTÚleftÚrightz/Closed has to be either 'left', 'right' or None)r )rN Z left_closedZ right_closedr r r Úvalidate_endpointsh s rQ )Ú inclusiver c C s6 d}t | tr"ddddd | ¡}|dkr2td|S )aD
|
Check that the `inclusive` argument is among {"both", "neither", "left", "right"}.
|
|
Parameters
|
----------
|
inclusive : {"both", "neither", "left", "right"}
|
|
Returns
|
-------
|
left_right_inclusive : tuple[bool, bool]
|
|
Raises
|
------
|
ValueError : if argument is not among valid values
|
N)TT)TF)FT)FF)ZbothrO rP Zneitherz?Inclusive has to be either 'both', 'neither', 'left' or 'right')r3 ÚstrÚgetr )rR Zleft_right_inclusiver r r Úvalidate_inclusive s
|
üûÿrU r4 )ÚlocÚlengthr c C sZ t | s td| d| | dk r,| |7 } d| kr@|ksVn td| d| | S )z¼
|
Check that we have an integer between -length and length, inclusive.
|
|
Standardize negative loc to within [0, length].
|
|
The exceptions we raise on failure match np.insert.
|
z loc must be an integer between -z and r )r r Ú
|
IndexError)rV rW r r r Úvalidate_insert_loc« s rY c C s& | t jk r"| dkr"td| dd S )N)Znumpy_nullableZpyarrowzdtype_backend z= is invalid, only 'numpy_nullable' and 'pyarrow' are allowed.)r Z
|
no_defaultr )Z dtype_backendr r r Úcheck_dtype_backend½ s
|
|
|
ÿrZ )TF)T)!Ú__doc__Ú
|
__future__r Útypingr r r r ÚnumpyrA Z pandas._libsr Zpandas.core.dtypes.commonr r r. r4 r
|
r r r r" r& r) r- r7 r< rF rJ rQ rU rY rZ r r r r Ú<module> s6 &) ; ÿ*'" !"
|
