U
|
¬ý°d?( ã @ sà d Z ddlmZ ddlmZmZ ddlZddlmZ ddl m
|
Z
|
G dd dZ G d d
|
d
|
Z d d d dfddddddddZ G dd dZeddddd Zeed d d d Zeed d d!d" Zeed#d d$d% ZdS )&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 Zd ZU e Zded< e Zded< eddddZ dddd Z
|
d
|
d fd d Z Z S ) Ú DirNamesMixinzset[str]Ú
|
_accessorszfrozenset[str]Ú _hidden_attrs)Úreturnc C s | j | jB S )z:
|
Delete unwanted __dir__ for this object.
|
)r r ©Úself© r úKd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\pandas/core/accessor.pyÚ_dir_deletions s z DirNamesMixin._dir_deletionsc s fdd j D S )z9
|
Add additional __dir__ for this object.
|
c s h | ]}t |r|qS r )Úhasattr)Ú.0Úaccessorr r r Ú <setcomp>" s
|
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 zDirNamesMixin.__dir__) Ú__name__Ú
|
__module__Ú __qualname__r r Ú__annotations__Ú frozensetr r r r r Ú __classcell__r r r r r s
|
r c @ sP e Zd ZdZdd Zdd Zdd Zedd d
|
d fd d dddddddZdS )Ú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| dd 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 )NzYou cannot call method r$ r& r r r Ú_delegate_method< s z PandasDelegate._delegate_methodFc C s | S ©Nr ©Úxr r r Ú<lambda>F ó zPandasDelegate.<lambda>Tr ÚstrÚboolúCallable[[str], str]ÚNone)Ú accessorsÚtypÚ overwriteÚaccessor_mappingÚraise_on_missingr
|
c sx fdd} fdd}|D ]R} |s>t | ddkr>q |dkrP|| }
|
n|| }
|
|sft| | s t| | |
|
q 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.
|
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.
|
c s> fdd} fdd} |_ |_ t||t jdS )Nc s
|
| ¡S r. )r* r ©r' r r Ú_getter_ s z[PandasDelegate._add_delegate_accessors.<locals>._create_delegator_property.<locals>._getterc s | |¡S r. )r, )r Z
|
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( fdd} |_ t j|_|S )Nc s | j f||S r. )r- )r r( r) r< r r Úfo s zSPandasDelegate._add_delegate_accessors.<locals>._create_delegator_method.<locals>.f)r rB rC )r' rG rD r< r Ú_create_delegator_methodn s zHPandasDelegate._add_delegate_accessors.<locals>._create_delegator_methodNrA )rB r Úsetattr) ÚclsrE r7 r8 r9 r: r; rF rH r' rG r rD r Ú_add_delegate_accessors? s ÿþ
|
z&PandasDelegate._add_delegate_accessorsN) r r r rC r* r, r- Ú classmethodrK r r r r r# 1 s ùr# Fc C s | S r. r r/ r r r r1 r2 r1 Tr r3 r4 r5 )r7 r8 r9 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.
|
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)r9 r: r; )rK )rJ ©r: r7 rE r9 r; r8 r r Úadd_delegate_accessors° s úz.delegate_names.<locals>.add_delegate_accessorsr )rE r7 r8 r9 r: r; rN r rM r Údelegate_names s ( rO c @ s( e Zd ZdZdddddZdd Zd 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``.
|
r3 r6 )r' r
|
c C s || _ || _d S r. )Ú_nameÚ _accessor)r r' r r r r Ú__init__Ø s zCachedAccessor.__init__c C s, |d kr| j S | |¡}t || j|¡ |S r. )rR ÚobjectÚ __setattr__rQ )r ÚobjrJ Z accessor_objr r r Ú__get__Ü s
|
|
zCachedAccessor.__get__N)r r r rC rS rW r r r r rP Ä s rP Ú )Ú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 dtt d t t| j ¡ | S )Nzregistration of accessor z under name z
|
for type z: is overriding a preexisting attribute with the same name.)Ú
|
stacklevel)
|
r ÚwarningsÚwarnÚreprÚ UserWarningr rI rP r Úadd)r ©rJ r' r r Ú decorator2 s
|
"û z%_register_accessor.<locals>.decoratorr )r' rJ ra r r` r Ú_register_accessoré s I rb Ú DataFrame)rY c C s ddl m} t| |S )Nr )rc )Úpandasrc rb )r' rc r r r Úregister_dataframe_accessorB s re ÚSeriesc C s ddl m} t| |S )Nr )rf )rd rf rb )r' rf r r r Úregister_series_accessorI s rg ÚIndexc C s ddl m} t| |S )Nr )rh )rd rh rb )r' rh r r r Úregister_index_accessorP s ri )rC Ú
|
__future__r Útypingr r r[ Zpandas.util._decoratorsr Zpandas.util._exceptionsr r r# rO rP rb re rg ri r r r r Ú<module> s( [ú<%
|
|
X
|
|
|
|
|
|
