cR rdZddlmZddlmZddlmZGddeZGddej eZ Gd d eZ Gd d ej e Z Gd de e ZGdde ZGddeZGddeZGdde ZGddejeeeeZdS)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) collectionsceZdZdZdZdS) IItemMappingz%Simplest readable mapping object cdS)z`Get a value for a key A `KeyError` is raised if there is no value for the key. Nkeys =lib/python3.11/site-packages/zope/interface/common/mapping.py __getitem__zIItemMapping.__getitem__'N)__name__ __module__ __qualname____doc__r r rr rr#s-     rrc eZdZdZddZdZdS) IReadMappingz^ Basic mapping interface. .. versionchanged:: 5.0.0 Extend ``IContainer`` NcdS)zaGet a value for a key The default is returned if there is no value for the key. Nr r defaults r getzIReadMapping.get6rrcdS)z$Tell if a key exists in the mapping.Nr r s r __contains__zIReadMapping.__contains__<rrN)rrrrrrr rr rr.sA    33333rrceZdZdZdZdZdS) IWriteMappingz!Mapping methods for changing datacdS)z.Delete a value from the mapping using the key.Nr r s r __delitem__zIWriteMapping.__delitem__DrrcdS)zSet a new item in the mapping.Nr )r values r __setitem__zIWriteMapping.__setitem__GrrN)rrrrr r#r rr rrAs8++===-----rrc*eZdZdZdZdZdZdZdS)IEnumerableMappingzp Mapping objects whose items can be enumerated. .. versionchanged:: 5.0.0 Extend ``ISized`` cdS)z/Return the keys of the mapping object. Nr r rr keyszIEnumerableMapping.keysSrrcdS)z?Return an iterator for the keys of the mapping object. Nr r rr __iter__zIEnumerableMapping.__iter__WrrcdS)z1Return the values of the mapping object. Nr r rr valueszIEnumerableMapping.values[rrcdS)z0Return the items of the mapping object. Nr r rr itemszIEnumerableMapping.items_rrN)rrrrr'r)r+r-r rr r%r%KsZ              rr%ceZdZdZdS)IMappingz Simple mapping interface Nrrrrr rr r/r/cs$$$$rr/c,eZdZdZer dZdZdZdSdS)IIterableMappingzA 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. cdS)z-iterate over keys; equivalent to ``__iter__``Nr r rr iterkeyszIIterableMapping.iterkeysprrcdS)ziterate over valuesNr r rr itervalueszIIterableMapping.itervaluessrrcdS)ziterate over itemsNr r rr iteritemszIIterableMapping.iteritemsvrrN)rrrrPY2r4r6r8r rr r2r2fs_ ! < < < " " " ! ! ! ! !!!rr2ceZdZdZdZdS)IClonableMappingzSSomething that can produce a copy of itself. This is available in `dict`. cdS)zreturn copy of dictNr r rr copyzIClonableMapping.copyrrN)rrrrr=r rr r;r;ys- rr;c eZdZdZerdZdSdS)IExtendedReadMappingz Something with a particular method equivalent to ``__contains__``. On Python 2, `dict` provides this method, but it was removed in Python 3. cdS)zCTell if a key exists in the mapping; equivalent to ``__contains__``Nr r s r has_keyzIExtendedReadMapping.has_keyrrN)rrrrr9rAr rr r?r?sI V V V V V VVVrr?c4eZdZdZdZdZddZddZdZdS) IExtendedWriteMappingzHAdditional mutation methods. These are all provided by `dict`. cdS)zdelete all itemsNr r rr clearzIExtendedWriteMapping.clearrrcdS)z0 Update D from E: for k in E.keys(): D[k] = E[k]Nr )ds r updatezIExtendedWriteMapping.updaterrNcdS)z@D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in DNr rs r setdefaultz IExtendedWriteMapping.setdefaultrrcdS)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 )krs r popzIExtendedWriteMapping.poprrcdS)zeremove and return some (key, value) pair as a 2-tuple; but raise KeyError if mapping is emptyNr r rr popitemzIExtendedWriteMapping.popitemrrr) rrrrrErHrJrMrOr rr rCrCsw ;;;KKKK     ;;;;;rrCceZdZdZdS) 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`` Nr0r rr rQrQs    rrQN)rzope.interfacerzope.interface._compatrr9zope.interface.commonrr IContainerrrISizedr%r/r2r;r?rCIMutableMappingrQr rr rXs"%$$$$$111111------     9   33333;)<333&-----I---     +\   0%%%%%}0%%%!!!!!)!!!&y V V V V V+ V V V;;;;;M;;;<     #35Ex     r