�
JDvcR � �r � d Z ddlmZ ddlmZ ddlmZ G d� de� � Z G d� dej e� � Z
G d � d
e� � Z G d � d ej e
� � Z
G d
� de e
� � Z G d� de
� � Z G d� de� � Z G d� de� � Z G d� de � � Z G d� dej eeee� � ZdS )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)�PYTHON2)� collectionsc � � e Zd ZdZd� ZdS )� IItemMappingz%Simplest readable mapping object
c � � dS )z`Get a value for a key
A `KeyError` is raised if there is no value for the key.
N� ��keys �?/usr/lib/python3/dist-packages/zope/interface/common/mapping.py� __getitem__zIItemMapping.__getitem__' � � � � � N)�__name__�
__module__� __qualname__�__doc__r
r r r r r # s- � � � � � �� � � � � � r r c � � e Zd ZdZdd�Zd� ZdS )� IReadMappingz^
Basic mapping interface.
.. versionchanged:: 5.0.0
Extend ``IContainer``
Nc � � dS )zaGet a value for a key
The default is returned if there is no value for the key.
Nr �r �defaults r �getzIReadMapping.get6 r r c � � dS )z$Tell if a key exists in the mapping.Nr r
s r � __contains__zIReadMapping.__contains__< r r �N)r r r r r r r r r r r . sA � � � � � �� � � � � � 3� 3� 3� 3� 3r r c � � e Zd ZdZd� Zd� ZdS )�
IWriteMappingz!Mapping methods for changing datac � � dS )z.Delete a value from the mapping using the key.Nr r
s r � __delitem__zIWriteMapping.__delitem__D r r c � � dS )z Set a new item in the mapping.Nr )r �values r � __setitem__zIWriteMapping.__setitem__G r r N)r r r r r r# r r r r r A s8 � � � � � �+�+�=� =� =�-� -� -� -� -r r c �* � e Zd ZdZd� Zd� Zd� Zd� ZdS )�IEnumerableMappingzp
Mapping objects whose items can be enumerated.
.. versionchanged:: 5.0.0
Extend ``ISized``
c � � dS )z/Return the keys of the mapping object.
Nr r r r �keyszIEnumerableMapping.keysS r r c � � dS )z?Return an iterator for the keys of the mapping object.
Nr r r r �__iter__zIEnumerableMapping.__iter__W r r c � � dS )z1Return the values of the mapping object.
Nr r r r �valueszIEnumerableMapping.values[ r r c � � dS )z0Return the items of the mapping object.
Nr r r r �itemszIEnumerableMapping.items_ r r N)r r r r r' r) r+ r- r r r r% r% K sZ � � � � � �� � � � � � � � � � � � � � � r r% c � � e Zd ZdZdS )�IMappingz Simple mapping interface N�r r r r r r r r/ r/ c s � � � � � �$�$�$�$r r/ c �, � e Zd ZdZer d� Zd� Zd� ZdS dS )�IIterableMappingz�A mapping that has distinct methods for iterating
without copying.
On Python 2, a `dict` has these methods, but on Python 3
the methods defined in `IEnumerableMapping` already iterate
without copying.
c � � dS )z-iterate over keys; equivalent to ``__iter__``Nr r r r �iterkeyszIIterableMapping.iterkeysp r r c � � dS )ziterate over valuesNr r r r �
itervalueszIIterableMapping.itervaluess r r c � � dS )ziterate over itemsNr r r r � iteritemszIIterableMapping.iteritemsv r r N)r r r r �PY2r4 r6 r8 r r r r2 r2 f s_ � � � � � �� � � !� <� <� <� "� "� "� !� !� !� !� !�!� !r r2 c � � e Zd ZdZd� ZdS )�IClonableMappingzSSomething that can produce a copy of itself.
This is available in `dict`.
c � � dS )zreturn copy of dictNr r r r �copyzIClonableMapping.copy r r N)r r r r r= r r r r; r; y s- � � � � � �� �
� � � � r r; c � � e Zd ZdZerd� ZdS dS )�IExtendedReadMappingz�
Something with a particular method equivalent to ``__contains__``.
On Python 2, `dict` provides this method, but it was removed
in Python 3.
c � � dS )zCTell if a key exists in the mapping; equivalent to ``__contains__``Nr r
s r �has_keyz IExtendedReadMapping.has_key� r r N)r r r r r9 rA r r r r? r? � sI � � � � � �� � � V� V� V� V� V� V�V� Vr r? c �4 � e Zd ZdZd� Zd� Zdd�Zdd�Zd� ZdS ) �IExtendedWriteMappingzHAdditional mutation methods.
These are all provided by `dict`.
c � � dS )zdelete all itemsNr r r r �clearzIExtendedWriteMapping.clear� r r c � � dS )z0 Update D from E: for k in E.keys(): D[k] = E[k]Nr )�ds r �updatez IExtendedWriteMapping.update� r r Nc � � dS )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 � � dS )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 �popzIExtendedWriteMapping.pop� r r c � � dS )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 rE rH rJ rM rO r r r rC rC � sw � � � � � �� �
� � �;� ;� ;�K� K� K� K� � � � �;� ;� ;� ;� ;r rC c � � e Zd ZdZdS )� 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``
Nr0 r r r rQ rQ � s � � � � � � � � � r rQ N)r �zope.interfacer �zope.interface._compatr r9 �zope.interface.commonr r �
IContainerr r �ISizedr% r/ r2 r; r? rC �IMutableMappingrQ r r r �<module>rX s �� � �" %� $� $� $� $� $� 1� 1� 1� 1� 1� 1� -� -� -� -� -� -� � � � � �9� � � �3� 3� 3� 3� 3�;�)�<� 3� 3� 3�&-� -� -� -� -�I� -� -� -� � � � � ��+�\� � � �0%� %� %� %� %�}� 0� %� %� %�!� !� !� !� !�)� !� !� !�& � � � � �y� � � �
V�
V�
V�
V�
V�+�
V�
V�
V� ;� ;� ;� ;� ;�M� ;� ;� ;�< � � � � ��#� � 3�5E�x� � � � � r |