a
    DBìj<'  ã                   @  sø   d Z ddlmZ ddlmZmZ ddlZddlmZ ddl	m
Z
 G dd„ dƒZG d	d
„ d
ƒZddd„ dfddddddœdd„ZG dd„ dƒZeddd�ddœdd„ƒZeedd�ddœdd „ƒZeed!d�ddœd"d#„ƒZeed$d�ddœd%d&„ƒZdS )'z†

accessor.py contains base classes for implementing accessor properties
that can be mixed into or pinned onto other pandas classes.

é    )Úannotations)ÚCallableÚfinalN)Údoc)Úfind_stack_levelc                      s`   e Zd ZU eƒ Zded< eƒ Zded< eddœdd„ƒZ	ddœdd	„Z
d
dœ‡ fdd„Z‡  ZS )ÚDirNamesMixinzset[str]Ú
_accessorszfrozenset[str]Ú_hidden_attrs)Úreturnc                 C  s   | j | jB S )z:
        Delete unwanted __dir__ for this object.
        )r   r	   ©Úself© r   úS/mnt/bigstor/www/usecases/.venv/lib/python3.9/site-packages/pandas/core/accessor.pyÚ_dir_deletions   s    zDirNamesMixin._dir_deletionsc                   s   ‡ fdd„ˆ j D ƒS )z9
        Add additional __dir__ for this object.
        c                   s   h | ]}t ˆ |ƒr|’qS r   )Úhasattr)Ú.0Úaccessorr   r   r   Ú	<setcomp>"   ó    z/DirNamesMixin._dir_additions.<locals>.<setcomp>)r   r   r   r   r   Ú_dir_additions   s    zDirNamesMixin._dir_additionsú	list[str]c                   s*   t tƒ  ¡ ƒ}||  ¡  |  ¡ B }t|ƒS )z€
        Provide method name lookup and completion.

        Notes
        -----
        Only provide 'public' methods.
        )ÚsetÚsuperÚ__dir__r   r   Úsorted)r   Úrv©Ú	__class__r   r   r   $   s    zDirNamesMixin.__dir__)Ú__name__Ú
__module__Ú__qualname__r   r   Ú__annotations__Ú	frozensetr	   r   r   r   r   Ú__classcell__r   r   r   r   r      s   
r   c                	   @  sb   e Zd ZdZddœdd„Zddœdd„Zddœdd	„Zed
dd„ dfdddddddœdd„ƒZdS )ÚPandasDelegatez@
    Abstract base class for delegating methods/properties.
    Ústr©Únamec                 O  s   t d|› �ƒ‚d S )NzYou cannot access the property ©Ú	TypeError©r   r'   ÚargsÚkwargsr   r   r   Ú_delegate_property_get6   s    z%PandasDelegate._delegate_property_getc                 O  s   t d|› d�ƒ‚d S )NzThe property z cannot be setr(   )r   r'   Úvaluer+   r,   r   r   r   Ú_delegate_property_set9   s    z%PandasDelegate._delegate_property_setc                 O  s   t d|› �ƒ‚d S )NzYou cannot call method r(   r*   r   r   r   Ú_delegate_method<   s    zPandasDelegate._delegate_methodFc                 C  s   | S ©Nr   ©Úxr   r   r   Ú<lambda>F   r   zPandasDelegate.<lambda>Tr   ÚboolúCallable[[str], str]ÚNone)Ú	accessorsÚtypÚ	overwriteÚaccessor_mappingÚraise_on_missingr
   c                   s„   ddœ‡ ‡fdd„}ddœ‡ ‡fdd„}|D ]R}	|sJt ˆˆ |	ƒdƒdu rJq,|dkr\||	ƒ}
n||	ƒ}
|srt| |	ƒs,t| |	|
ƒ q,dS )	aí  
        Add accessors to cls from the delegate class.

        Parameters
        ----------
        cls
            Class to add the methods/properties to.
        delegate
            Class to get methods/properties and doc-strings.
        accessors : list of str
            List of accessors to add.
        typ : {'property', 'method'}
        overwrite : bool, default False
            Overwrite the method/property in the target class if it exists.
        accessor_mapping: Callable, default lambda x: x
            Callable to map the delegate's function to the cls' function.
        raise_on_missing: bool, default True
            Raise if an accessor does not exist on delegate.
            False skips the missing accessor.
        r%   r&   c                   s>   ‡ fdd„}‡ fdd„}ˆ |_ ˆ |_ t||tˆˆˆ ƒƒjd�S )Nc                   s
   |   ˆ ¡S r1   )r-   r   r&   r   r   Ú_getter_   s    z[PandasDelegate._add_delegate_accessors.<locals>._create_delegator_property.<locals>._getterc                   s   |   ˆ |¡S r1   )r/   )r   Ú
new_valuesr&   r   r   Ú_setterb   s    z[PandasDelegate._add_delegate_accessors.<locals>._create_delegator_property.<locals>._setter)ÚfgetÚfsetr   )r   ÚpropertyÚgetattrÚ__doc__)r'   r=   r?   ©r;   Údelegater&   r   Ú_create_delegator_property^   s    ýzJPandasDelegate._add_delegate_accessors.<locals>._create_delegator_propertyc                   s(   ‡ fdd„}ˆ |_ tˆˆˆ ƒƒj|_|S )Nc                   s   | j ˆ g|¢R i |¤ŽS r1   )r0   )r   r+   r,   r&   r   r   Úfo   s    zSPandasDelegate._add_delegate_accessors.<locals>._create_delegator_method.<locals>.f)r   rC   rD   )r'   rH   rE   r&   r   Ú_create_delegator_methodn   s    zHPandasDelegate._add_delegate_accessors.<locals>._create_delegator_methodNrB   )rC   r   Úsetattr)ÚclsrF   r8   r9   r:   r;   r<   rG   rI   r'   rH   r   rE   r   Ú_add_delegate_accessors?   s    	ÿþ
z&PandasDelegate._add_delegate_accessorsN)	r   r   r    rD   r-   r/   r0   ÚclassmethodrL   r   r   r   r   r$   1   s   ùr$   Fc                 C  s   | S r1   r   r2   r   r   r   r4   �   r   r4   Tr   r%   r5   r6   )r8   r9   r:   r;   r<   c                   s   ‡ ‡‡‡‡‡fdd„}|S )a×  
    Add delegated names to a class using a class decorator.  This provides
    an alternative usage to directly calling `_add_delegate_accessors`
    below a class definition.

    Parameters
    ----------
    delegate : object
        The class to get methods/properties & doc-strings.
    accessors : Sequence[str]
        List of accessor to add.
    typ : {'property', 'method'}
    overwrite : bool, default False
       Overwrite the method/property in the target class if it exists.
    accessor_mapping: Callable, default lambda x: x
        Callable to map the delegate's function to the cls' function.
    raise_on_missing: bool, default True
        Raise if an accessor does not exist on delegate.
        False skips the missing accessor.

    Returns
    -------
    callable
        A class decorator.

    Examples
    --------
    @delegate_names(Categorical, ["categories", "ordered"], "property")
    class CategoricalAccessor(PandasDelegate):
        [...]
    c                   s   | j ˆˆˆˆˆ ˆd� | S )N)r:   r;   r<   )rL   )rK   ©r;   r8   rF   r:   r<   r9   r   r   Úadd_delegate_accessors°   s    úz.delegate_names.<locals>.add_delegate_accessorsr   )rF   r8   r9   r:   r;   r<   rO   r   rN   r   Údelegate_namesˆ   s    (rP   c                   @  s(   e Zd ZdZdddœdd„Zdd„ Zd	S )
ÚCachedAccessora¡  
    Custom property-like object.

    A descriptor for caching accessors.

    Parameters
    ----------
    name : str
        Namespace that will be accessed under, e.g. ``df.foo``.
    accessor : cls
        Class with the extension methods.

    Notes
    -----
    For accessor, The class's __init__ method assumes that one of
    ``Series``, ``DataFrame`` or ``Index`` as the
    single argument ``data``.
    r%   r7   )r'   r
   c                 C  s   || _ || _d S r1   )Ú_nameÚ	_accessor)r   r'   r   r   r   r   Ú__init__Ø   s    zCachedAccessor.__init__c                 C  s,   |d u r| j S |   |¡}t || j|¡ |S r1   )rS   ÚobjectÚ__setattr__rR   )r   ÚobjrK   Zaccessor_objr   r   r   Ú__get__Ü   s
    
zCachedAccessor.__get__N)r   r   r    rD   rT   rX   r   r   r   r   rQ   Ä   s   rQ   Ú )ÚklassZothersr&   c                   s   ‡ ‡fdd„}|S )aG  
    Register a custom accessor on {klass} objects.

    Parameters
    ----------
    name : str
        Name under which the accessor should be registered. A warning is issued
        if this name conflicts with a preexisting attribute.

    Returns
    -------
    callable
        A class decorator.

    See Also
    --------
    register_dataframe_accessor : Register a custom accessor on DataFrame objects.
    register_series_accessor : Register a custom accessor on Series objects.
    register_index_accessor : Register a custom accessor on Index objects.

    Notes
    -----
    When accessed, your accessor will be initialized with the pandas object
    the user is interacting with. So the signature must be

    .. code-block:: python

        def __init__(self, pandas_object):  # noqa: E999
            ...

    For consistency with pandas methods, you should raise an ``AttributeError``
    if the data passed to your accessor has an incorrect dtype.

    >>> pd.Series(['a', 'b']).dt
    Traceback (most recent call last):
    ...
    AttributeError: Can only use .dt accessor with datetimelike values

    Examples
    --------
    In your library code::

        import pandas as pd

        @pd.api.extensions.register_dataframe_accessor("geo")
        class GeoAccessor:
            def __init__(self, pandas_obj):
                self._obj = pandas_obj

            @property
            def center(self):
                # return the geographic center point of this DataFrame
                lat = self._obj.latitude
                lon = self._obj.longitude
                return (float(lon.mean()), float(lat.mean()))

            def plot(self):
                # plot this array's data on a map, e.g., using Cartopy
                pass

    Back in an interactive IPython session:

        .. code-block:: ipython

            In [1]: ds = pd.DataFrame({{"longitude": np.linspace(0, 10),
               ...:                    "latitude": np.linspace(0, 20)}})
            In [2]: ds.geo.center
            Out[2]: (5.0, 10.0)
            In [3]: ds.geo.plot()  # plots data on a map
    c                   s^   t ˆ ˆƒr<tjdt| ƒ› dtˆƒ› dtˆ ƒ› d�ttƒ d� tˆ ˆtˆ| ƒƒ ˆ j 	ˆ¡ | S )Nzregistration of accessor z under name z
 for type z: is overriding a preexisting attribute with the same name.)Ú
stacklevel)
r   ÚwarningsÚwarnÚreprÚUserWarningr   rJ   rQ   r   Úadd)r   ©rK   r'   r   r   Ú	decorator2  s    
ÿÿûz%_register_accessor.<locals>.decoratorr   )r'   rK   rb   r   ra   r   Ú_register_accessoré   s    Irc   Ú	DataFrame)rZ   c                 C  s   ddl m} t| |ƒS )Nr   )rd   )Úpandasrd   rc   )r'   rd   r   r   r   Úregister_dataframe_accessorB  s    rf   ÚSeriesc                 C  s   ddl m} t| |ƒS )Nr   )rg   )re   rg   rc   )r'   rg   r   r   r   Úregister_series_accessorI  s    rh   ÚIndexc                 C  s   ddl m} t| |ƒS )Nr   )ri   )re   ri   rc   )r'   ri   r   r   r   Úregister_index_accessorP  s    rj   )rD   Ú
__future__r   Útypingr   r   r\   Zpandas.util._decoratorsr   Zpandas.util._exceptionsr   r   r$   rP   rQ   rc   rf   rh   rj   r   r   r   r   Ú<module>   s(   [ú<%
X


