3
���hO0 � @ s� d Z ddlZddlZddlZddlZddlZddlZddlmZm Z ddl
Z ddl Z
ddlmZ ddlmZmZ d@dd �Zd
d � Zd d
� Zdd� Zdd� Zdd� Zdd� Zefdd�Zefdd�Zdd� Z d d � Z d d � Z ejej ej fZ!d d!� Z"d"d#� Z#d$d%� Z$efd&d'�Z%efd(d)�Z&G d*d+� d+e'�Z(G d,d-� d-ee(�Z)d.d/� Z*G d0d1� d1e e(�Z+G d2d3� d3e e(�Z,G d4d5� d5e'�Z-G d6d7� d7e-�Z.ej/d8d9� �Z0d:d;� Z1d<d=� Z2d>d?� Z3dS )Az(Internal utilties; not for external use
� N)�Mapping�MutableMapping� )�ops)� iteritems� OrderedDict� c C s t jd| |f t|d� d S )Nz(%s has been deprecated and renamed to %s)�
stacklevel)�warnings�warn�
FutureWarning)�old_name�new_namer � r �1/tmp/pip-build-5_djhm0z/xray/xarray/core/utils.py�
alias_warning s r c s t j� �� �fdd��}|S )Nc s t �� j� � | |�S )N)r �__name__)�args�kwargs)�objr
r r �wrapper s z function_alias.<locals>.wrapper)� functools�wraps)r r
r r )r r
r �function_alias s r c s$ G � ��fdd�d��� �j � _ � S )Nc s" e Zd Z�� ��fdd�Z� ZS )z class_alias.<locals>.Wrapperc s$ t ��j� t� | �j| f|�|�S )N)r r �super�__new__)�clsr r )�Wrapper� __class__r r
r r r " s z$class_alias.<locals>.Wrapper.__new__)r �
__module__� __qualname__r �
__classcell__r )r r r
)r r r ! s r )r )r r
r )r r r
r � class_alias s r" c C s` t | tj�r| }nJt| d�r&| j� }n6i }t| d�rH| jjdkrHt|d< tjtj | �f|�}|S )a9 Given an array, safely cast it to a pandas.Index.
If it is already a pandas.Index, return it unchanged.
Unlike pandas.Index, if the array has dtype=object or dtype=timedelta64,
this function will not attempt to do automatic type conversion but will
always return an index with dtype=object.
�to_index�dtype�O)
�
isinstance�pd�Index�hasattrr# r$ �kind�object�np�asarray)�array�indexr r r r �safe_cast_to_index) s
r0 c C s* t |tj�r"|j| jkr"| j|�S |S dS )z�Wrap a transformed array with __array_wrap__ is it can be done safely.
This lets us treat arbitrary functions that take and return ndarray objects
like ufuncs, as long as they return an array with the same shape.
N)r& r, �ndarray�shapeZ__array_wrap__)�originalZ new_arrayr r r �maybe_wrap_array> s
r4 c C s8 t | tj�st |tj�r$tj| |�S | |kp2| |kS dS )zuCompare two objects for equivalence (identity or equality), using
array_equiv if either object is an ndarray
N)r& r, r1 r Z array_equiv)�first�secondr r r �
equivalentK s r7 c C s" t | �}t|�}|tj|g|�fS )zxReturns the first value from iterable, as well as a new iterable with
the same content as the original iterable
)�iter�next� itertools�chain)�iterable�gen�peekr r r �peek_atU s r? c C s> x8t |�D ],\}}|| kr
||| | � r
td| ��q
W dS )aH Check the safety of updating one dictionary with another.
Raises ValueError if dictionaries have non-compatible values for any key,
where compatibility is determined by identity (they are the same item) or
the `compat` function.
Parameters
----------
first_dict, second_dict : dict-like
All items in the second dictionary are checked against for conflicts
against items in the first dictionary.
compat : function, optional
Binary operator to determine if two values are compatible. By default,
checks for equivalence.
zJunsafe to merge dictionaries without overriding values; conflicting key %rN)r �
ValueError)�
first_dict� second_dict�compat�k�vr r r �update_safety_check^ s rF c C s@ x:t | �D ].}||ks2||kr
|| | || � r
| |= q
W dS )a� Remove incompatible items from the first dictionary in-place.
Items are retained if their keys are found in both dictionaries and the
values are compatible.
Parameters
----------
first_dict, second_dict : dict-like
Mappings to merge.
compat : function, optional
Binary operator to determine if two values are compatible. By default,
checks for equivalence.
N)�list)rA rB rC rD r r r �remove_incompatible_itemst s
rH c C s t | d�ot | d�S )N� __getitem__�keys)r) )�valuer r r � is_dict_like� s rL c C s t | t�o| td �kS )N)r& �slice)rK r r r �
is_full_slice� s rN c C s8 | d k r0t | �s td| ��|r,td| ��| S |S d S )Nz.the first argument to .%s must be a dictionaryz;cannot specify both keyword and positional arguments to .%s)rL r@ )Z
pos_kwargsZ kw_kwargs� func_namer r r �combine_pos_and_kw_args� s rP c C s0 t | d�r| jdkS tj| �p.t| t�p.| dkS )z�np.isscalar only works on primitive numeric types and (bizarrely)
excludes 0-d ndarrays; this version does more comprehensive checks
�ndimr N)r) rQ r, Zisscalarr& �
_SCALAR_TYPES)rK r r r � is_scalar� s
rS c C s0 yt j| � W n ttfk
r& dS X dS d S )NFT)r, r$ � TypeErrorr@ )r$ r r r �is_valid_numpy_dtype� s
rU c C s& t jdtd�}| g|d d �< f |_|S )Nr )r$ )r )r, �emptyr+ r2 )rK �resultr r r �tuple_to_0darray� s rX c C sL x,| D ]$}||ks&|| | || � rdS qW x|D ]}|| kr4dS q4W dS )a� Test equivalence of two dict-like objects. If any of the values are
numpy arrays, compare them correctly.
Parameters
----------
first, second : dict-like
Dictionaries to compare for equality
compat : function, optional
Binary operator to determine if two values are compatible. By default,
checks for equivalence.
Returns
-------
equals : bool
True if the dictionaries are equal
FTr )r5 r6 rC rD r r r �
dict_equiv� s
rY c C s t | �}t|||� |S )a� Return the intersection of two dictionaries as a new OrderedDict.
Items are retained if their keys are found in both dictionaries and the
values are compatible.
Parameters
----------
first_dict, second_dict : dict-like
Mappings to merge.
compat : function, optional
Binary operator to determine if two values are compatible. By default,
checks for equivalence.
Returns
-------
intersection : OrderedDict
Intersection of the contents.
)r rH )rA rB rC Znew_dictr r r �ordered_dict_intersection� s rZ c @ s e Zd ZdZdd� Zdd� ZdS )�SingleSlotPickleMixinz�Mixin class to add the ability to pickle objects whose state is defined
by a single __slots__ attribute. Only necessary under Python 2.
c C s t | | jd �S )Nr )�getattr� __slots__)�selfr r r � __getstate__� s z"SingleSlotPickleMixin.__getstate__c C s t | | jd |� d S )Nr )�setattrr] )r^ �stater r r � __setstate__� s z"SingleSlotPickleMixin.__setstate__N)r r r �__doc__r_ rb r r r r r[ � s r[ c @ sF e Zd ZdZdgZdd� Zdd� Zdd� Zd d
� Zd d � Z d
d� Z
dS )�Frozenz�Wrapper around an object implementing the mapping interface to make it
immutable. If you really want to modify the mapping, the mutable version is
saved under the `mapping` attribute.
�mappingc C s
|| _ d S )N)re )r^ re r r r �__init__ s zFrozen.__init__c C s
| j | S )N)re )r^ �keyr r r rI s zFrozen.__getitem__c C s
t | j�S )N)r8 re )r^ r r r �__iter__ s zFrozen.__iter__c C s
t | j�S )N)�lenre )r^ r r r �__len__ s zFrozen.__len__c C s
|| j kS )N)re )r^ rg r r r � __contains__ s zFrozen.__contains__c C s dt | �j| jf S )Nz%s(%r))�typer re )r^ r r r �__repr__ s zFrozen.__repr__N) r r r rc r] rf rI rh rj rk rm r r r r rd � s rd c O s t t| |��S )N)rd r )r r r r r �FrozenOrderedDict s rn c @ s` e Zd ZdZdgZddd�Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dS )�SortedKeysDictz�An wrapper for dictionary-like objects that always iterates over its
items in sorted order by key but is otherwise equivalent to the underlying
mapping.
re Nc C s |d kr i n|| _ d S )N)re )r^ re r r r rf s zSortedKeysDict.__init__c C s
| j | S )N)re )r^ rg r r r rI ! s zSortedKeysDict.__getitem__c C s || j |< d S )N)re )r^ rg rK r r r � __setitem__$ s zSortedKeysDict.__setitem__c C s | j |= d S )N)re )r^ rg r r r � __delitem__' s zSortedKeysDict.__delitem__c C s t t| j��S )N)r8 �sortedre )r^ r r r rh * s zSortedKeysDict.__iter__c C s
t | j�S )N)ri re )r^ r r r rj - s zSortedKeysDict.__len__c C s
|| j kS )N)re )r^ rg r r r rk 0 s zSortedKeysDict.__contains__c C s dt | �j| jf S )Nz%s(%r))rl r re )r^ r r r rm 3 s zSortedKeysDict.__repr__c C s t | �| jj� �S )N)rl re �copy)r^ r r r rs 6 s zSortedKeysDict.copy)N)r r r rc r] rf rI rp rq rh rj rk rm rs r r r r ro s
ro c @ sF e Zd ZdZdgZdd� Zdd� Zdd� Zd d
� Zd d � Z d
d� Z
dS )�ChainMapz�Partial backport of collections.ChainMap from Python>=3.3
Don't return this from any public APIs, since some of the public methods
for a MutableMapping are missing (they will raise a NotImplementedError)
�mapsc G s
|| _ d S )N)ru )r^ ru r r r rf B s zChainMap.__init__c C s: x,| j D ]"}y|| S tk
r( Y qX qW t|��d S )N)ru �KeyError)r^ rg re r r r rI E s
zChainMap.__getitem__c C s || j d |< d S )Nr )ru )r^ rg rK r r r rp M s zChainMap.__setitem__c C s t �d S )N)�NotImplementedError)r^ rK r r r rq P s zChainMap.__delitem__c c s@ t � }x4| jD ]*}x$|D ] }||kr|V |j|� qW qW d S )N)�setru �add)r^ �seenre �itemr r r rh S s
zChainMap.__iter__c C s t t| ���d S )N)ri r8 )r^ r r r rj [ s zChainMap.__len__N) r r r rc r] rf rI rp rq rh rj r r r r rt : s rt c @ s0 e Zd ZdZedd� �Zedd� �Zdd� ZdS ) �NdimSizeLenMixinz�Mixin class that extends a class that defines a ``shape`` property to
one that also defines ``ndim``, ``size`` and ``__len__``.
c C s
t | j�S )N)ri r2 )r^ r r r rQ c s zNdimSizeLenMixin.ndimc C s t tj| j��S )N)�intr, �prodr2 )r^ r r r �sizeg s zNdimSizeLenMixin.sizec C s, y
| j d S tk
r& td��Y nX d S )Nr zlen() of unsized object)r2 �
IndexErrorrT )r^ r r r rj l s
zNdimSizeLenMixin.__len__N)r r r rc �propertyrQ r rj r r r r r| _ s r| c @ sB e Zd ZdZedd� �Zedd� �Zd
dd�Zd d
� Zd d � Z dS )� NDArrayMixina Mixin class for making wrappers of N-dimensional arrays that conform to
the ndarray interface required for the data argument to Variable objects.
A subclass should set the `array` property and override one or more of
`dtype`, `shape` and `__getitem__`.
c C s | j jS )N)r. r$ )r^ r r r r$ z s zNDArrayMixin.dtypec C s | j jS )N)r. r2 )r^ r r r r2 ~ s zNDArrayMixin.shapeNc C s t j| d |d�S )N.)r$ )r, r- )r^ r$ r r r � __array__� s zNDArrayMixin.__array__c C s
| j | S )N)r. )r^ rg r r r rI � s zNDArrayMixin.__getitem__c C s dt | �j| jf S )Nz %s(array=%r))rl r r. )r^ r r r rm � s zNDArrayMixin.__repr__)N)
r r r rc r� r$ r2 r� rI rm r r r r r� s s
r� c c s. y
dV W n t k
r( | j� � Y nX dS )z�Context manager to ensure that a file opened by xarray is closed if an
exception is raised before the user sees the file object.
N)� Exception�close)�fr r r �close_on_error� s
r� c C s t tjd| ��S )Nz ^https?\://)�bool�re�search)�pathr r r �
is_remote_uri� s r� c K s0 t j| td�} t j| �}t j|j� |j� f|�S )z�Return True if values of an array are uniformly spaced and sorted.
>>> is_uniform_spaced(range(5))
True
>>> is_uniform_spaced([-4, 0, 100])
False
kwargs are additional arguments to ``np.isclose``
)r$ )r, r. �floatZdiff�isclose�min�max)Zarrr Zdiffsr r r �is_uniform_spaced� s
r� c C s& y t | � W n tk
r dS X dS )z$Determine whether `v` can be hashed.FT)�hashrT )rE r r r �hashable� s
r� )r )4rc �
contextlib�datetimer r: r� r
� collectionsr r Znumpyr, Zpandasr' � r Zpycompatr r r r r" r0 r4 r7 r? rF rH rL rN rP �date� timedeltarR rS rU rX rY rZ r+ r[ rd rn ro rt r| r� �contextmanagerr� r� r� r� r r r r �<module> sP
#% |