3
���h" � @ s� d Z ddlmZmZ ddlZddlmZ G dd� d�ZG dd� d�Zd e e
d
�d d �Z G d
d� d�Z eddd�dd� �Z
ee
dd�dd� �Zee
dd�dd� �Zee
dd�dd � �ZdS ) z�
accessor.py contains base classes for implementing accessor properties
that can be mixed into or pinned onto other pandas classes.
� )� FrozenSet�SetN)�docc @ sB e Zd ZU e� Zee e� Ze e dd� Z
dd� Z dd� Z dS )�
DirNamesMixinc C s | j | jB S )z:
Delete unwanted __dir__ for this object.
)�
_accessors�
_deprecations)�self� r �6/tmp/pip-build-5_djhm0z/pandas/pandas/core/accessor.py�_dir_deletions s z DirNamesMixin._dir_deletionsc C sH t � }x<| jD ]2}yt| |� |j|� W q tk
r> Y qX qW |S )z9
Add additional __dir__ for this object.
)�setr �getattr�add�AttributeError)r �rv�accessorr r r
�_dir_additions s
z DirNamesMixin._dir_additionsc C s, t tt| ���}|| j� | j� B }t|�S )z�
Provide method name lookup and completion.
Notes
-----
Only provide 'public' methods.
)r �dir�typer r �sorted)r r r r r
�__dir__$ s zDirNamesMixin.__dir__N)
�__name__�
__module__� __qualname__r r r �str� frozensetr r r r r r r r r
r
s
r c @ s> e Zd ZdZdd� Zdd� Zdd� Zed
ee d �d
d ��Z
d S )�PandasDelegatez@
Abstract base class for delegating methods/properties.
c O s t d|� ���d S )Nz You cannot access the property )� TypeError)r �name�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 set)r )r r �valuer r r r r
�_delegate_property_set9 s z%PandasDelegate._delegate_property_setc O s t d|� ���d S )NzYou cannot call method )r )r r r r r r r
�_delegate_method< s z PandasDelegate._delegate_methodF)�typ� overwritec s` � fdd�}� fdd�}xB|D ]:}|dkr4||�}n||�}|sLt | |� r t| ||� q W dS )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.
c s: � fdd�}� fdd�}� |_ � |_ t||t�� �jd�S )Nc s
| j � �S )N)r! )r )r r r
�_getterT s z[PandasDelegate._add_delegate_accessors.<locals>._create_delegator_property.<locals>._getterc s | j � |�S )N)r# )r Z
new_values)r r r
�_setterW s z[PandasDelegate._add_delegate_accessors.<locals>._create_delegator_property.<locals>._setter)�fget�fsetr )r �propertyr
�__doc__)r r' r( )�delegate)r r
�_create_delegator_propertyS s zJPandasDelegate._add_delegate_accessors.<locals>._create_delegator_propertyc s$ � fdd�}� |_ t�� �j|_|S )Nc s | j � f|�|�S )N)r$ )r r r )r r r
�fb s zSPandasDelegate._add_delegate_accessors.<locals>._create_delegator_method.<locals>.f)r r
r, )r r/ )r- )r r
�_create_delegator_methoda s zHPandasDelegate._add_delegate_accessors.<locals>._create_delegator_methodr+ N)�hasattr�setattr) �clsr- � accessorsr% r& r. r0 r r/ r )r- r
�_add_delegate_accessors? s
z&PandasDelegate._add_delegate_accessorsN)F) r r r r, r! r# r$ � classmethodr �boolr5 r r r r
r 1 s r F)r% r& c s � ���fdd�}|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.
Returns
-------
callable
A class decorator.
Examples
--------
@delegate_names(Categorical, ["categories", "ordered"], "property")
class CategoricalAccessor(PandasDelegate):
[...]
c s | j �� ��d� | S )N)r& )r5 )r3 )r4 r- r& r% r r
�add_delegate_accessors� s z.delegate_names.<locals>.add_delegate_accessorsr )r- r4 r% r& r8 r )r4 r- r& r% r
�delegate_namesv s r9 c @ s( e Zd ZdZedd�dd�Zdd� ZdS )�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``.
N)r �returnc C s || _ || _d S )N)�_name� _accessor)r r r r r r
�__init__� s zCachedAccessor.__init__c C s, |d kr| j S | j |�}tj|| j|� |S )N)r= �object� __setattr__r< )r �objr3 Z accessor_objr r r
�__get__� s
zCachedAccessor.__get__)r r r r, r r> rB r r r r
r: � s r: � )�klassZothersc s � �fdd�}|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:tjdt| �� dt��� dt� �� d�tdd� t� �t�| �� � jj�� | S )Nzregistration of accessor z under name z
for type z: is overriding a preexisting attribute with the same name.� )�
stacklevel) r1 �warnings�warn�repr� UserWarningr2 r: r r )r )r3 r r r
� decorator
s
" z%_register_accessor.<locals>.decoratorr )r r3 rK r )r3 r r
�_register_accessor� s I
rL � DataFrame)rD c C s ddl m} t| |�S )Nr )rM )�pandasrM rL )r rM r r r
�register_dataframe_accessor s rO �Seriesc C s ddl m} t| |�S )Nr )rP )rN rP rL )r rP r r r
�register_series_accessor$ s rQ �Indexc C s ddl m} t| |�S )Nr )rR )rN rR rL )r rR r r r
�register_index_accessor+ s rS )F)r, Ztypingr r rG Zpandas.util._decoratorsr r r r r7 r9 r: rL rO rQ rS r r r r
�<module> s $E)%Y |