
    VhO              	       F   d Z ddlmZ ddlmZ  G d de      Z G d dej                  e      Z G d d	e      Z G d
 dej                  e      Z
 G d dee
      Z G d de
      Z G d de      Z G d de      Z G d de      Z G d dej                   eeee      Zy)ah  
Mapping Interfaces.

Importing this module does *not* mark any standard classes as
implementing any of these interfaces.

While this module is not deprecated, new code should generally use
:mod:`zope.interface.common.collections`, specifically
:class:`~zope.interface.common.collections.IMapping` and
:class:`~zope.interface.common.collections.IMutableMapping`. This
module is occasionally useful for its extremely fine grained breakdown
of interfaces.

The standard library :class:`dict` and :class:`collections.UserDict`
implement ``IMutableMapping``, but *do not* implement any of the
interfaces in this module.
    )	Interface)collectionsc                       e Zd ZdZd Zy)IItemMappingz%Simplest readable mapping object
    c                      y)z`Get a value for a key

        A `KeyError` is raised if there is no value for the key.
        N keys    M/home/dcms/DCMS/lib/python3.12/site-packages/zope/interface/common/mapping.py__getitem__zIItemMapping.__getitem__'           N)__name__
__module____qualname____doc__r   r   r   r   r   r   #   s    r   r   c                       e Zd ZdZddZd Zy)IReadMappingz^
    Basic mapping interface.

    .. versionchanged:: 5.0.0
       Extend ``IContainer``
    Nc                      y)zaGet a value for a key

        The default is returned if there is no value for the key.
        Nr   r
   defaults     r   getzIReadMapping.get6   r   r   c                      y)z$Tell if a key exists in the mapping.Nr   r	   s    r   __contains__zIReadMapping.__contains__<   r   r   N)r   r   r   r   r   r   r   r   r   r   r   .   s    3r   r   c                       e Zd ZdZd Zd Zy)IWriteMappingz!Mapping methods for changing datac                      y)z.Delete a value from the mapping using the key.Nr   r	   s    r   __delitem__zIWriteMapping.__delitem__D   r   r   c                      y)zSet a new item in the mapping.Nr   )r
   values     r   __setitem__zIWriteMapping.__setitem__G   r   r   N)r   r   r   r   r   r"   r   r   r   r   r   A   s    +=-r   r   c                   (    e Zd ZdZd Zd Zd Zd Zy)IEnumerableMappingzp
    Mapping objects whose items can be enumerated.

    .. versionchanged:: 5.0.0
       Extend ``ISized``
    c                       y)z/Return the keys of the mapping object.
        Nr   r   r   r   keyszIEnumerableMapping.keysS   r   r   c                       y)z?Return an iterator for the keys of the mapping object.
        Nr   r   r   r   __iter__zIEnumerableMapping.__iter__W   r   r   c                       y)z1Return the values of the mapping object.
        Nr   r   r   r   valueszIEnumerableMapping.values[   r   r   c                       y)z0Return the items of the mapping object.
        Nr   r   r   r   itemszIEnumerableMapping.items_   r   r   N)r   r   r   r   r&   r(   r*   r,   r   r   r   r$   r$   K   s    r   r$   c                       e Zd ZdZy)IMappingz Simple mapping interface Nr   r   r   r   r   r   r   r.   r.   d   s    $r   r.   c                       e Zd ZdZy)IIterableMappingzLA mapping that has distinct methods for iterating
    without copying.

    Nr/   r   r   r   r1   r1   h   s    r   r1   c                       e Zd ZdZd Zy)IClonableMappingzSSomething that can produce a copy of itself.

    This is available in `dict`.
    c                       y)zreturn copy of dictNr   r   r   r   copyzIClonableMapping.copyu   r   r   N)r   r   r   r   r5   r   r   r   r3   r3   o   s    
r   r3   c                       e Zd ZdZy)IExtendedReadMappingz
    Something with a particular method equivalent to ``__contains__``.

    On Python 2, `dict` provided the ``has_key`` method, but it was removed
    in Python 3.
    Nr/   r   r   r   r7   r7   y   s    r   r7   c                   2    e Zd ZdZd Zd ZddZddZd Zy)	IExtendedWriteMappingzHAdditional mutation methods.

    These are all provided by `dict`.
    c                       y)zdelete all itemsNr   r   r   r   clearzIExtendedWriteMapping.clear   r   r   c                      y)z0 Update D from E: for k in E.keys(): D[k] = E[k]Nr   )ds    r   updatezIExtendedWriteMapping.update   r   r   Nc                      y)z@D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in DNr   r   s     r   
setdefaultz IExtendedWriteMapping.setdefault   r   r   c                      y)a  
        pop(k[,default]) -> value

        Remove specified key and return the corresponding value.

        If key is not found, *default* is returned if given, otherwise
        `KeyError` is raised. Note that *default* must not be passed by
        name.
        Nr   )kr   s     r   popzIExtendedWriteMapping.pop   r   r   c                       y)zeremove and return some (key, value) pair as a
        2-tuple; but raise KeyError if mapping is emptyNr   r   r   r   popitemzIExtendedWriteMapping.popitem   r   r   r   )	r   r   r   r   r;   r>   r@   rC   rE   r   r   r   r9   r9      s!    
;K	;r   r9   c                       e Zd ZdZy)IFullMappinga$  
    Full mapping interface.

    Most uses of this interface should instead use
    :class:`~zope.interface.commons.collections.IMutableMapping` (one of the
    bases of this interface). The required methods are the same.

    .. versionchanged:: 5.0.0
       Extend ``IMutableMapping``
    Nr/   r   r   r   rG   rG      s    	r   rG   N)r   zope.interfacer   zope.interface.commonr   r   
IContainerr   r   ISizedr$   r.   r1   r3   r7   r9   IMutableMappingrG   r   r   r   <module>rM      s   " % -9 3;))< 3&-I -++\ 2%}0 %) y + ;M ;>r   