U +if!@sdZddlmZddlZddlmZddlmZGdddZGdd d Z d d d d ddZ GdddZ edddddZ ee ddddZ ee ddddZee ddddZdS)!z accessor.py contains base classes for implementing accessor properties that can be mixed into or pinned onto other pandas classes. ) annotationsN)doc)find_stack_levelcs\eZdZUeZded<eZded<ddddZdddd Z d dfd d Z Z S) DirNamesMixinzset[str] _accessorszfrozenset[str] _hidden_attrs)returncCs |j|jBS)z: Delete unwanted __dir__ for this object. )rrselfr G/home/mars/bis/venv/lib/python3.8/site-packages/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_additionsz list[str]cs*tt}|||B}t|S)z Provide method name lookup and completion. Notes ----- Only provide 'public' methods. )setsuper__dir__r rsorted)r rv __class__r r rszDirNamesMixin.__dir__) __name__ __module__ __qualname__rr__annotations__ frozensetrr rr __classcell__r r rr rs rc@s>eZdZdZddZddZddZedd d d d d ZdS)PandasDelegatez@ Abstract base class for delegating methods/properties. cOstd|dS)NzYou cannot access the property  TypeErrorr nameargskwargsr r r _delegate_property_get1sz%PandasDelegate._delegate_property_getcOstd|ddS)Nz The property z cannot be setr!)r r$valuer%r&r r r _delegate_property_set4sz%PandasDelegate._delegate_property_setcOstd|dS)NzYou cannot call method r!r#r r r _delegate_method7szPandasDelegate._delegate_methodFstrbooltyp overwritec sZfdd}fdd}|D]8}|dkr2||}n||}|sHt||st|||qdS)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. cs:fdd}fdd}|_|_t||tjdS)Ncs |SN)r'r r$r r _getterOsz[PandasDelegate._add_delegate_accessors.._create_delegator_property.._gettercs ||Sr0)r))r new_valuesr1r r _setterRsz[PandasDelegate._add_delegate_accessors.._create_delegator_property.._setter)fgetfsetr)rpropertygetattr__doc__)r$r2r4delegater1r _create_delegator_propertyNs   zJPandasDelegate._add_delegate_accessors.._create_delegator_propertycs$fdd}|_tj|_|S)Ncs|jf||Sr0)r*)r r%r&r1r r f]szSPandasDelegate._add_delegate_accessors.._create_delegator_method..f)rr8r9)r$r=r:r1r _create_delegator_method\s zHPandasDelegate._add_delegate_accessors.._create_delegator_methodr7N)rsetattr) clsr; accessorsr.r/r<r>r$r=r r:r _add_delegate_accessors:s   z&PandasDelegate._add_delegate_accessorsN)F) rrrr9r'r)r* classmethodrBr r r r r ,sr Fr+r,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. Returns ------- callable A class decorator. Examples -------- @delegate_names(Categorical, ["categories", "ordered"], "property") class CategoricalAccessor(PandasDelegate): [...] cs|jd|S)N)r/)rB)r@rAr;r/r.r r add_delegate_accessorssz.delegate_names..add_delegate_accessorsr )r;rAr.r/rEr rDr delegate_namesqsrFc@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``. r+None)r$rcCs||_||_dSr0)_name _accessor)r r$rr r r __init__szCachedAccessor.__init__cCs,|dkr|jS||}t||j||Sr0)rJobject __setattr__rI)r objr@Z accessor_objr r r __get__s  zCachedAccessor.__get__N)rrrr9rKrOr r r r rGsrG)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$r@rYr rXr _register_accessorsI rZ DataFrame)rQcCsddlm}t||S)Nr)r[)pandasr[rZ)r$r[r r r register_dataframe_accessors r]SeriescCsddlm}t||S)Nr)r^)r\r^rZ)r$r^r r r register_series_accessors r_IndexcCsddlm}t||S)Nr)r`)r\r`rZ)r$r`r r r register_index_accessor&s ra)F)r9 __future__rrSZpandas.util._decoratorsrZpandas.util._exceptionsrrr rFrGrZr]r_rar r r r s    E)%  X