B `R@sdZddlmZddlmZddlmZGdddeZGdddej eZ Gd d d eZ Gd d d ej e Z Gd dde e ZGddde ZGdddeZGdddeZGddde ZGdddejeeeeZdS)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@seZdZdZddZdS) IItemMappingz%Simplest readable mapping object cCsdS)z`Get a value for a key A `KeyError` is raised if there is no value for the key. N)keyrre/home/kop/projects/devel/pgwui/test_venv/lib/python3.7/site-packages/zope/interface/common/mapping.py __getitem__'szIItemMapping.__getitem__N)__name__ __module__ __qualname____doc__r rrrrr#src@s"eZdZdZdddZddZdS) IReadMappingz^ Basic mapping interface. .. versionchanged:: 5.0.0 Extend ``IContainer`` NcCsdS)zaGet a value for a key The default is returned if there is no value for the key. Nr)rdefaultrrrget6szIReadMapping.getcCsdS)z$Tell if a key exists in the mapping.Nr)rrrr __contains__<szIReadMapping.__contains__)N)r r r r rrrrrrr.s rc@s eZdZdZddZddZdS) IWriteMappingz!Mapping methods for changing datacCsdS)z.Delete a value from the mapping using the key.Nr)rrrr __delitem__DszIWriteMapping.__delitem__cCsdS)zSet a new item in the mapping.Nr)rvaluerrr __setitem__GszIWriteMapping.__setitem__N)r r r r rrrrrrrAsrc@s0eZdZdZddZddZddZdd Zd S) IEnumerableMappingzp Mapping objects whose items can be enumerated. .. versionchanged:: 5.0.0 Extend ``ISized`` cCsdS)z/Return the keys of the mapping object. NrrrrrkeysSszIEnumerableMapping.keyscCsdS)z?Return an iterator for the keys of the mapping object. Nrrrrr__iter__WszIEnumerableMapping.__iter__cCsdS)z1Return the values of the mapping object. Nrrrrrvalues[szIEnumerableMapping.valuescCsdS)z0Return the items of the mapping object. Nrrrrritems_szIEnumerableMapping.itemsN)r r r r rrrrrrrrrKs rc@seZdZdZdS)IMappingz Simple mapping interface N)r r r r rrrrrcsrc@s,eZdZdZer(ddZddZddZdS) 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. cCsdS)z-iterate over keys; equivalent to ``__iter__``NrrrrriterkeyspszIIterableMapping.iterkeyscCsdS)ziterate over valuesNrrrrr itervaluessszIIterableMapping.itervaluescCsdS)ziterate over itemsNrrrrr iteritemsvszIIterableMapping.iteritemsN)r r r r PY2rrrrrrrrfs rc@seZdZdZddZdS)IClonableMappingzSSomething that can produce a copy of itself. This is available in `dict`. cCsdS)zreturn copy of dictNrrrrrcopyszIClonableMapping.copyN)r r r r r"rrrrr!ysr!c@seZdZdZerddZdS)IExtendedReadMappingz Something with a particular method equivalent to ``__contains__``. On Python 2, `dict` provides this method, but it was removed in Python 3. cCsdS)zCTell if a key exists in the mapping; equivalent to ``__contains__``Nr)rrrrhas_keyszIExtendedReadMapping.has_keyN)r r r r r r$rrrrr#sr#c@s<eZdZdZddZddZd ddZdd d Zd d ZdS)IExtendedWriteMappingzHAdditional mutation methods. These are all provided by `dict`. cCsdS)zdelete all itemsNrrrrrclearszIExtendedWriteMapping.clearcCsdS)z0 Update D from E: for k in E.keys(): D[k] = E[k]Nr)drrrupdateszIExtendedWriteMapping.updateNcCsdS)z@D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in DNr)rrrrr setdefaultsz IExtendedWriteMapping.setdefaultcCsdS)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)krrrrpops zIExtendedWriteMapping.popcCsdS)zeremove and return some (key, value) pair as a 2-tuple; but raise KeyError if mapping is emptyNrrrrrpopitemszIExtendedWriteMapping.popitem)N)N) r r r r r&r(r)r+r,rrrrr%s   r%c@seZdZdZdS) 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`` N)r r r r rrrrr-s r-N)r Zzope.interfacerZzope.interface._compatrr Zzope.interface.commonrrZ IContainerrrZISizedrrrr!r#r%ZIMutableMappingr-rrrrs