o ŀg<'@sdZddlmZddlmZmZddlZddlmZddl m Z GdddZ Gd d d Z d d d dfd+ddZ GdddZedddd,dd Zeed!d"d,d#d$Zeed%d"d,d&d'Zeed(d"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)CallablefinalN)doc)find_stack_levelcsTeZdZUeZded<eZded<ed ddZ d dd Z dfd d Z Z S) DirNamesMixinset[str] _accessorszfrozenset[str] _hidden_attrsreturncCs |j|jBS)z: Delete unwanted __dir__ for this object. )r r selfrH/var/www/html/myenv/lib/python3.10/site-packages/pandas/core/accessor.py_dir_deletionss zDirNamesMixin._dir_deletionscsfddjDS)z9 Add additional __dir__ for this object. csh|] }t|r|qSr)hasattr).0accessorr rr "sz/DirNamesMixin._dir_additions..)r r rr 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__rrr$szDirNamesMixin.__dir__)r r)r r) __name__ __module__ __qualname__rr __annotations__ frozensetr rrrr __classcell__rrrrrs   rc@sHeZdZdZdddZdddZddd Zed d d d fdddZdS)PandasDelegatez@ Abstract base class for delegating methods/properties. namestrcOtd|)NzYou cannot access the property  TypeErrorr r%argskwargsrrr_delegate_property_get6z%PandasDelegate._delegate_property_getcOstd|d)Nz The property z cannot be setr()r r%valuer+r,rrr_delegate_property_set9sz%PandasDelegate._delegate_property_setcOr')NzYou cannot call method r(r*rrr_delegate_method<r.zPandasDelegate._delegate_methodFcC|SNrxrrrFzPandasDelegate.T accessorsrtyp overwriteboolaccessor_mappingCallable[[str], str]raise_on_missingr Nonec s|d fdd }d fdd }|D])} |s!t| ddur!q|dkr*|| } n|| } |s5t|| s;t|| | 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. 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&cs>fdd}fdd}|_|_t||tjdS)Ncs |Sr3)r-r r%rr_getter_s z[PandasDelegate._add_delegate_accessors.._create_delegator_property.._gettercs ||Sr3)r0)r new_valuesr@rr_setterbs z[PandasDelegate._add_delegate_accessors.._create_delegator_property.._setter)fgetfsetr)rpropertygetattr__doc__)r%rArCr<delegater@r_create_delegator_property^s  zJPandasDelegate._add_delegate_accessors.._create_delegator_propertycs(fdd}|_tj|_|S)Ncs|jg|Ri|Sr3)r1)r r+r,r@rrfoszSPandasDelegate._add_delegate_accessors.._create_delegator_method..f)rrGrH)r%rLrIr@r_create_delegator_methodns zHPandasDelegate._add_delegate_accessors.._create_delegator_methodNrFr%r&)rGrsetattr) clsrJr8r9r:r<r>rKrMr%rLrrIr_add_delegate_accessors?s   z&PandasDelegate._add_delegate_accessorsNrN) r8rr9r&r:r;r<r=r>r;r r?) rrr rHr-r0r1 classmethodrQrrrrr$1s   r$FcCr2r3rr4rrrr6r7r6Tr8rr9r&r:r;r<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. 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)r:r<r>)rQ)rPr<r8rJr:r>r9rradd_delegate_accessorssz.delegate_names..add_delegate_accessorsr)rJr8r9r:r<r>rTrrSrdelegate_namess( rUc@s"eZdZdZd ddZdd 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``. r%r&r r?cCs||_||_dSr3)_name _accessor)r r%rrrr__init__s zCachedAccessor.__init__cCs,|dur|jS||}t||j||Sr3)rXobject __setattr__rW)r objrP accessor_objrrr__get__s  zCachedAccessor.__get__N)r%r&r r?)rrr rHrYr^rrrrrVs  rV)klassothersr%csfdd}|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^trtjdt|dtdtdttdtt|j |S)Nzregistration of accessor z under name z for type z: is overriding a preexisting attribute with the same name.) stacklevel) rwarningswarnrepr UserWarningrrOrVr add)rrPr%rr decorator2s   z%_register_accessor..decoratorr)r%rPrirrhr_register_accessorsI rj DataFrame)r`cCddlm}t||S)Nr)rk)pandasrkrj)r%rkrrrregister_dataframe_accessorB  rnSeriescCrl)Nr)rp)rmrprj)r%rprrrregister_series_accessorIrorqIndexcCrl)Nr)rr)rmrrrj)r%rrrrrregister_index_accessorPrors) r8rr9r&r:r;r<r=r>r;rN)rH __future__rtypingrrrcpandas.util._decoratorsrpandas.util._exceptionsrrr$rUrVrjrnrqrsrrrrs*   [ < %  X