U Cv f @sfddlmZddlZddlmZddlmZGdddeZGdddZ d d Z d d Z d dZ dS)) annotationsN) DataArray)Datasetc@seZdZdZdS)AccessorRegistrationWarningz/Warning for conflicts in accessor registration.N)__name__ __module__ __qualname____doc__r r :/tmp/pip-unpacked-wheel-h316xyqg/xarray/core/extensions.pyr src@s eZdZdZddZddZdS)_CachedAccessorz?Custom property-like object (descriptor) for caching accessors.cCs||_||_dS)N)_name _accessor)selfnameaccessorr r r __init__sz_CachedAccessor.__init__cCs|dkr|jSz |j}Wntk r6i}|_YnXz ||jWStk rXYnXz||}Wn&tk rtd|jdYnX|||j<|S)Nzerror initializing z accessor.)r_cacheAttributeErrorr KeyError RuntimeError)robjclscacheZ accessor_objr r r __get__s    z_CachedAccessor.__get__N)rrrr rrr r r r r sr csfdd}|S)NcsDtr.tjd|dddtddtt||S)Nzregistration of accessor z under name z for type z: is overriding a preexisting attribute with the same name.) stacklevel)hasattrwarningswarnrsetattrr )rrrr r decorator2s z%_register_accessor..decoratorr )rrr"r r!r _register_accessor1s r#cCs t|tS)a0Register a custom accessor on xarray.DataArray objects. Parameters ---------- name : str Name under which the accessor should be registered. A warning is issued if this name conflicts with a preexisting attribute. See Also -------- register_dataset_accessor )r#rrr r r register_dataarray_accessor@s r%cCs t|tS)aRegister a custom property on xarray.Dataset objects. Parameters ---------- name : str Name under which the accessor should be registered. A warning is issued if this name conflicts with a preexisting attribute. Examples -------- In your library code: >>> @xr.register_dataset_accessor("geo") ... class GeoAccessor: ... def __init__(self, xarray_obj): ... self._obj = xarray_obj ... ... @property ... def center(self): ... # return the geographic center point of this dataset ... lon = self._obj.latitude ... lat = 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: >>> ds = xr.Dataset( ... {"longitude": np.linspace(0, 10), "latitude": np.linspace(0, 20)} ... ) >>> ds.geo.center (10.0, 5.0) >>> ds.geo.plot() # plots data on a map See Also -------- register_dataarray_accessor )r#rr$r r r register_dataset_accessorPs+r&) __future__rrZxarray.core.dataarrayrZxarray.core.datasetrWarningrr r#r%r&r r r r s   $