U MZf&@sdZddlmZddlmZmZddlZddlmZddl m Z GdddZ Gd d d Z d d d dfddddddddZ GdddZedddddZeeddddZeed dd!d"Zeed#dd$d%ZdS)&z accessor.py contains base classes for implementing accessor properties that can be mixed into or pinned onto other pandas classes. ) annotations)CallablefinalN)doc)find_stack_levelcs`eZdZUeZded<eZded<eddddZ dddd Z d dfd d Z Z S) DirNamesMixinzset[str] _accessorszfrozenset[str] _hidden_attrs)returncCs |j|jBS)z: Delete unwanted __dir__ for this object. )rr selfr 8/tmp/pip-unpacked-wheel-nbcvw55c/pandas/core/accessor.py_dir_deletionsszDirNamesMixin._dir_deletionscsfddjDS)z9 Add additional __dir__ for this object. csh|]}t|r|qSr )hasattr).0accessorr r r "s z/DirNamesMixin._dir_additions..)rr r r r_dir_additionsszDirNamesMixin._dir_additions list[str]cs*tt}|||B}t|S)z Provide method name lookup and completion. Notes ----- Only provide 'public' methods. )setsuper__dir__rrsorted)r rv __class__r rr$szDirNamesMixin.__dir__) __name__ __module__ __qualname__rr__annotations__ frozensetr rrrr __classcell__r r rrrs rc @sPeZdZdZddZddZddZedd d d fd d dddddddZdS)PandasDelegatez@ Abstract base class for delegating methods/properties. cOstd|dS)NzYou cannot access the property  TypeErrorr nameargskwargsr r r_delegate_property_get6sz%PandasDelegate._delegate_property_getcOstd|ddS)Nz The property z cannot be setr$)r r'valuer(r)r r r_delegate_property_set9sz%PandasDelegate._delegate_property_setcOstd|dS)NzYou cannot call method r$r&r r r_delegate_method<szPandasDelegate._delegate_methodFcCs|SNr xr r rFzPandasDelegate.TrstrboolCallable[[str], str]None) accessorstyp overwriteaccessor_mappingraise_on_missingr c sxfdd}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. cs>fdd}fdd}|_|_t||tjdS)Ncs |Sr.)r*r r'r r_getter_sz[PandasDelegate._add_delegate_accessors.._create_delegator_property.._gettercs ||Sr.)r,)r Z new_valuesr<r r_setterbsz[PandasDelegate._add_delegate_accessors.._create_delegator_property.._setter)fgetfsetr)rpropertygetattr__doc__)r'r=r>r:delegater<r_create_delegator_property^s  zJPandasDelegate._add_delegate_accessors.._create_delegator_propertycs(fdd}|_tj|_|S)Ncs|jf||Sr.)r-)r r(r)r<r rfoszSPandasDelegate._add_delegate_accessors.._create_delegator_method..f)rrBrC)r'rGrDr<r_create_delegator_methodns zHPandasDelegate._add_delegate_accessors.._create_delegator_methodNrA)rBrsetattr) clsrEr7r8r9r:r;rFrHr'rGr rDr_add_delegate_accessors?s  z&PandasDelegate._add_delegate_accessorsN) rrrrCr*r,r- classmethodrKr r r rr#1sr#FcCs|Sr.r r/r r rr1r2r1Trr3r4r5)r7r8r9r:r;csfdd}|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): [...] cs|jd|S)N)r9r:r;)rK)rJr:r7rEr9r;r8r radd_delegate_accessorssz.delegate_names..add_delegate_accessorsr )rEr7r8r9r:r;rNr rMrdelegate_namess( rOc@s(eZdZdZdddddZddZd 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``. r3r6)r'r cCs||_||_dSr.)_name _accessor)r r'rr r r__init__szCachedAccessor.__init__cCs,|dkr|jS||}t||j||Sr.)rRobject __setattr__rQ)r objrJZ accessor_objr r r__get__s  zCachedAccessor.__get__N)rrrrCrSrWr r r rrPsrP)klassZotherscsfdd}|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 cs^tr.decoratorr )r'rJrar r`r_register_accessorsI rb DataFrame)rYcCsddlm}t||S)Nr)rc)pandasrcrb)r'rcr r rregister_dataframe_accessorBs reSeriescCsddlm}t||S)Nr)rf)rdrfrb)r'rfr r rregister_series_accessorIs rgIndexcCsddlm}t||S)Nr)rh)rdrhrb)r'rhr r rregister_index_accessorPs ri)rC __future__rtypingrrr[Zpandas.util._decoratorsrZpandas.util._exceptionsrrr#rOrPrbrergrir r r rs(   [<%  X