U
|
¬ý°dö@ ã @ sL d Z ddlmZ ddlmZmZ ddlZddlm Z ddl
|
m Z m Z m Z mZmZmZ ddlmZmZ erddlmZ dd lmZ d
|
d d d dZd dddZdd dddZd dddZd dddZ dddd d d Z d7dd dd d!d"Z d8ddd#d$Z ddd%d&Z d'd( Z!d)d*dd+d,d-Z"d.d/d0d1Z#d2d3d3d4d5d6Z$dS )9z$
|
Low-dependency indexing utilities.
|
é )Ú annotations)Ú TYPE_CHECKINGÚAnyN)Ú AnyArrayLike)Ú is_array_likeÚ is_bool_dtypeÚis_extension_array_dtypeÚ
|
is_integerÚis_integer_dtypeÚ is_list_like)ÚABCIndexÚ ABCSeries)Ú DataFrame)ÚIndexÚsliceÚbool)ÚslcÚreturnc C s& dd }|| j o$|| jo$|| jS )a(
|
Check if a slice object can be interpreted as a positional indexer.
|
|
Parameters
|
----------
|
slc : slice
|
|
Returns
|
-------
|
bool
|
|
Notes
|
-----
|
A valid positional slice may also be interpreted as a label-based slice
|
depending on the index being sliced.
|
c S s | d kpt | S ©N©r )Úval© r úQd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\pandas/core/indexers/utils.pyÚis_int_or_none6 s z1is_valid_positional_slice.<locals>.is_int_or_none)ÚstartÚstopÚstep)r r r r r Úis_valid_positional_slice$ s
|
ÿýr )r c C s t | o t| to t| tk S )z
|
Check if we have a list-like indexer that is *not* a NamedTuple.
|
|
Parameters
|
----------
|
key : object
|
|
Returns
|
-------
|
bool
|
)r Ú
|
isinstanceÚtupleÚtype)Úkeyr r r Úis_list_like_indexer@ s r" Úint)Úndimr c C s@ |dkrt | rdS t| tr<t| |kr<tdd | D S dS )zÓ
|
Return True if we are all scalar indexers.
|
|
Parameters
|
----------
|
indexer : object
|
ndim : int
|
Number of dimensions in the object being indexed.
|
|
Returns
|
-------
|
bool
|
é Tc s s | ]}t |V qd S r r )Ú.0Úxr r r Ú <genexpr>b s z$is_scalar_indexer.<locals>.<genexpr>F)r r r ÚlenÚall)Úindexerr$ r r r Úis_scalar_indexerP s
|
r, c C s6 t | rt| sdS t| ts$| f} tdd | D S )z
|
Check if we have an empty indexer.
|
|
Parameters
|
----------
|
indexer : object
|
|
Returns
|
-------
|
bool
|
Tc s s& | ] }t |tjo t|d kV qdS )r N)r ÚnpÚndarrayr) )r& Úidxr r r r( v s z#is_empty_indexer.<locals>.<genexpr>)r r) r r Úany)r+ r r r Úis_empty_indexerf s
|
|
r1 c C sÎ d}t | tjtfrt|rÊt| t|krz|jdkrzt | trJt | ¡} t | tjrr| jtj krr|
|
¡ t|kszt dt| sÊd}nBt | t rÊt|rÊt|t | |kr¾|jdkr¾t dt|sÊd}|S )a
|
Validate that value and indexer are the same length.
|
|
An special-case is allowed for when the indexer is a boolean array
|
and the number of true values equals the length of ``value``. In
|
this case, no exception is raised.
|
|
Parameters
|
----------
|
indexer : sequence
|
Key for the setitem.
|
value : array-like
|
Value for the setitem.
|
values : array-like
|
Values being set into.
|
|
Returns
|
-------
|
bool
|
Whether this is an empty listlike setting which is a no-op.
|
|
Raises
|
------
|
ValueError
|
When the indexer is an ndarray or list and the lengths don't match.
|
Fr% zKcannot set using a list-like indexer with a different length than the valueTzGcannot set using a slice indexer with a different length than the value)r r- r. Úlistr r) r$ ÚarrayÚdtypeZbool_ÚsumÚ
|
ValueErrorr Úlength_of_indexer)r+ ÚvalueÚvaluesZno_opr r r Úcheck_setitem_lengths} s4
|
|
|
ÿ
|
þýÿ
|
ÿr: z
|
np.ndarrayÚNone)ÚindicesÚnr c C sH t | rD| ¡ }|dk r,d| d}t|| ¡ }||krDtddS )a+
|
Perform bounds-checking for an indexer.
|
|
-1 is allowed for indicating missing values.
|
|
Parameters
|
----------
|
indices : ndarray
|
n : int
|
Length of the array being indexed.
|
|
Raises
|
------
|
ValueError
|
|
Examples
|
--------
|
>>> validate_indices(np.array([1, 2]), 3) # OK
|
|
>>> validate_indices(np.array([1, -2]), 3)
|
Traceback (most recent call last):
|
...
|
ValueError: negative dimensions are not allowed
|
|
>>> validate_indices(np.array([1, 2, 3]), 3)
|
Traceback (most recent call last):
|
...
|
IndexError: indices are out-of-bounds
|
|
>>> validate_indices(np.array([-1, -1]), 0) # OK
|
|
>>> validate_indices(np.array([0, 1]), 0)
|
Traceback (most recent call last):
|
...
|
IndexError: indices are out-of-bounds
|
éÿÿÿÿz-'indices' contains values less than allowed (z < -1)úindices are out-of-boundsN)r) Úminr6 ÚmaxÚ
|
IndexError)r< r= Úmin_idxÚmsgZmax_idxr r r Úvalidate_indices½ s % rE T)r= Úverifyr c C s t | tr0t | ¡} t| dkr0tjdtjdS | dk }| ¡ rX| ¡ } | | |7 < |r|| |k| dk B }| ¡ r|t d| S )a&
|
Attempt to convert indices into valid, positive indices.
|
|
If we have negative indices, translate to positive here.
|
If we have indices that are out-of-bounds, raise an IndexError.
|
|
Parameters
|
----------
|
indices : array-like
|
Array of indices that we are to convert.
|
n : int
|
Number of elements in the array that we are indexing.
|
verify : bool, default True
|
Check that all entries are between 0 and n - 1, inclusive.
|
|
Returns
|
-------
|
array-like
|
An array-like of positive indices that correspond to the ones
|
that were passed in initially to this function.
|
|
Raises
|
------
|
IndexError
|
One of the converted indices either exceeded the number of,
|
elements (specified by `n`), or was still negative.
|
r ©r4 r? )
|
r r2 r- r3 r) ÚemptyÚintpr0 ÚcopyrB )r< r= rF Úmaskr r r Úmaybe_convert_indicesñ s
|
|
rL c C s, |dk r²t | tr²t|}| j}| j}| j}|dkr:d}n|dk rJ||7 }|dksZ||kr`|}n|dk rp||7 }|dkr~d}n |dk r|d |d }}| }|| | d | S t | tttj t
|
frôt | t
|
rÚt | ¡} | j t krì| ¡ S t| S t | tr| j| j | j S t| s dS tddS )zX
|
Return the expected length of target[indexer]
|
|
Returns
|
-------
|
int
|
Nr r% z%cannot find the length of the indexer)r r r) r r r r r r- r. r2 r3 r4 r r5 Úranger" ÚAssertionError)r+ ÚtargetZ
|
target_lenr r r r r r r7 $ s<
|
|
|
|
r7 c C s t | ¡dkrtddS )zú
|
Helper function to disallow multi-dimensional indexing on 1D Series/Index.
|
|
GH#27125 indexer like idx[:, None] expands dim, but we cannot do that
|
and keep an index, so we used to return ndarray, which was deprecated
|
in GH#30588.
|
r% zzMulti-dimensional indexing (e.g. `obj[:, None]`) is no longer supported. Convert to a numpy array before indexing instead.N)r- r$ r6 )Úresultr r r Údisallow_ndim_indexingN s ÿrQ c C s8 t | dkr4t| d tr4t| tr,td| d S | S )z
|
If we have a length-1 tuple/list that contains a slice, unpack to just
|
the slice.
|
|
Notes
|
-----
|
The list case is deprecated.
|
r% r zYIndexing with a single-item list containing a slice is not allowed. Pass a tuple instead.)r) r r r2 r6 )Útupr r r Ú unpack_1tuple] s
|
ÿrS r r )Úcolumnsr8 r c C sJ | j r"t|jt|krFtdn$t| |¡d t|jkrFtddS )aÿ
|
Checks if a key used as indexer has the same length as the columns it is
|
associated with.
|
|
Parameters
|
----------
|
columns : Index The columns of the DataFrame to index.
|
key : A list-like of keys to index with.
|
value : DataFrame The value to set for the keys.
|
|
Raises
|
------
|
ValueError: If the length of key is not equal to the number of columns in value
|
or if the number of columns referenced by key is not equal to number
|
of columns.
|
z"Columns must be same length as keyr N)Z is_uniquer) rT r6 Zget_indexer_non_unique)rT r! r8 r r r Úcheck_key_lengthu s
|
|
rU r ©Úitemc C s^ t | dkr>| d tkr&| dd
} n| d tkr>| dd
} t | dkrRtd| d } | S )z/
|
Possibly unpack arr[..., n] to arr[n]
|
r% r Nr> ztoo many indices for array.)r) ÚEllipsisrB rV r r r Úunpack_tuple_and_ellipses s rY r r )r3 r+ r c
|
C s ddl m} t|r$t|tr(|S n|S t|sT||}t|dkrTtjg tjd}|j }t
|
|r¶t |rz|j t dd}ntj|t d}t|t| kr´tdt| dt| nXt|rztj|tjd}W n. tk
|
r } ztd|W 5 d }~X Y nX ntd
|
|S ) aë
|
Check if `indexer` is a valid array indexer for `array`.
|
|
For a boolean mask, `array` and `indexer` are checked to have the same
|
length. The dtype is validated, and if it is an integer or boolean
|
ExtensionArray, it is checked if there are missing values present, and
|
it is converted to the appropriate numpy array. Other dtypes will raise
|
an error.
|
|
Non-array indexers (integer, slice, Ellipsis, tuples, ..) are passed
|
through as is.
|
|
Parameters
|
----------
|
array : array-like
|
The array that is being indexed (only used for the length).
|
indexer : array-like or list-like
|
The array-like that's used to index. List-like input that is not yet
|
a numpy array or an ExtensionArray is converted to one. Other input
|
types are passed through as is.
|
|
Returns
|
-------
|
numpy.ndarray
|
The validated indexer as a numpy array that can be used to index.
|
|
Raises
|
------
|
IndexError
|
When the lengths don't match.
|
ValueError
|
When `indexer` cannot be converted to a numpy ndarray to index
|
(e.g. presence of missing values).
|
|
See Also
|
--------
|
api.types.is_bool_dtype : Check if `key` is of boolean dtype.
|
|
Examples
|
--------
|
When checking a boolean mask, a boolean ndarray is returned when the
|
arguments are all valid.
|
|
>>> mask = pd.array([True, False])
|
>>> arr = pd.array([1, 2])
|
>>> pd.api.indexers.check_array_indexer(arr, mask)
|
array([ True, False])
|
|
An IndexError is raised when the lengths don't match.
|
|
>>> mask = pd.array([True, False, True])
|
>>> pd.api.indexers.check_array_indexer(arr, mask)
|
Traceback (most recent call last):
|
...
|
IndexError: Boolean index has wrong length: 3 instead of 2.
|
|
NA values in a boolean array are treated as False.
|
|
>>> mask = pd.array([True, pd.NA])
|
>>> pd.api.indexers.check_array_indexer(arr, mask)
|
array([ True, False])
|
|
A numpy boolean mask will get passed through (if the length is correct):
|
|
>>> mask = np.array([True, False])
|
>>> pd.api.indexers.check_array_indexer(arr, mask)
|
array([ True, False])
|
|
Similarly for integer indexers, an integer ndarray is returned when it is
|
a valid indexer, otherwise an error is (for integer indexers, a matching
|
length is not required):
|
|
>>> indexer = pd.array([0, 2], dtype="Int64")
|
>>> arr = pd.array([1, 2, 3])
|
>>> pd.api.indexers.check_array_indexer(arr, indexer)
|
array([0, 2])
|
|
>>> indexer = pd.array([0, pd.NA], dtype="Int64")
|
>>> pd.api.indexers.check_array_indexer(arr, indexer)
|
Traceback (most recent call last):
|
...
|
ValueError: Cannot index with an integer indexer containing NA values
|
|
For non-integer/boolean dtypes, an appropriate error is raised:
|
|
>>> indexer = np.array([0., 2.], dtype="float64")
|
>>> pd.api.indexers.check_array_indexer(arr, indexer)
|
Traceback (most recent call last):
|
...
|
IndexError: arrays used as indices must be of integer or boolean type
|
r )r3 rG F)r4 Zna_valuez Boolean index has wrong length: z instead of z9Cannot index with an integer indexer containing NA valuesNz9arrays used as indices must be of integer or boolean type)Zpandas.core.constructionr3 r r r r r) r- rI r4 r r Zto_numpyr ZasarrayrB r
|
r6 )r3 r+ Zpd_arrayr4 Úerrr r r Úcheck_array_indexer¥ s: \
|
ÿ
|
ÿþr[ )T)N)%Ú__doc__Ú
|
__future__r Útypingr r Únumpyr- Zpandas._typingr Zpandas.core.dtypes.commonr r r r r
|
r Zpandas.core.dtypes.genericr r Zpandas.core.framer Zpandas.core.indexes.baser r r" r, r1 r: rE rL r7 rQ rS rU rY r[ r r r r Ú<module> s, @43*
|
