<h2>Editing File: /usr/lib64/python3.6/site-packages/zope/interface/common/mapping.py</h2><form method='post'><textarea name='content' class='file-edit'>##############################################################################
#
# Copyright (c) 2001, 2002 Zope Foundation and Contributors.
# All Rights Reserved.
#
# This software is subject to the provisions of the Zope Public License,
# Version 2.1 (ZPL).  A copy of the ZPL should accompany this distribution.
# THIS SOFTWARE IS PROVIDED &quot;AS IS&quot; AND ANY AND ALL EXPRESS OR IMPLIED
# WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
# WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
# FOR A PARTICULAR PURPOSE.
#
##############################################################################
&quot;&quot;&quot;Mapping Interfaces.

Importing this module does *not* mark any standard classes
as implementing any of these interfaces.
&quot;&quot;&quot;
from zope.interface import Interface

class IItemMapping(Interface):
    &quot;&quot;&quot;Simplest readable mapping object
    &quot;&quot;&quot;

    def __getitem__(key):
        &quot;&quot;&quot;Get a value for a key

        A `KeyError` is raised if there is no value for the key.
        &quot;&quot;&quot;


class IReadMapping(IItemMapping):
    &quot;&quot;&quot;Basic mapping interface
    &quot;&quot;&quot;

    def get(key, default=None):
        &quot;&quot;&quot;Get a value for a key

        The default is returned if there is no value for the key.
        &quot;&quot;&quot;

    def __contains__(key):
        &quot;&quot;&quot;Tell if a key exists in the mapping.&quot;&quot;&quot;


class IWriteMapping(Interface):
    &quot;&quot;&quot;Mapping methods for changing data&quot;&quot;&quot;

    def __delitem__(key):
        &quot;&quot;&quot;Delete a value from the mapping using the key.&quot;&quot;&quot;

    def __setitem__(key, value):
        &quot;&quot;&quot;Set a new item in the mapping.&quot;&quot;&quot;


class IEnumerableMapping(IReadMapping):
    &quot;&quot;&quot;Mapping objects whose items can be enumerated.
    &quot;&quot;&quot;

    def keys():
        &quot;&quot;&quot;Return the keys of the mapping object.
        &quot;&quot;&quot;

    def __iter__():
        &quot;&quot;&quot;Return an iterator for the keys of the mapping object.
        &quot;&quot;&quot;

    def values():
        &quot;&quot;&quot;Return the values of the mapping object.
        &quot;&quot;&quot;

    def items():
        &quot;&quot;&quot;Return the items of the mapping object.
        &quot;&quot;&quot;

    def __len__():
        &quot;&quot;&quot;Return the number of items.
        &quot;&quot;&quot;

class IMapping(IWriteMapping, IEnumerableMapping):
    ''' Simple mapping interface '''

class IIterableMapping(IEnumerableMapping):
    &quot;&quot;&quot;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.
    &quot;&quot;&quot;

    def iterkeys():
        &quot;iterate over keys; equivalent to ``__iter__``&quot;

    def itervalues():
        &quot;iterate over values&quot;

    def iteritems():
        &quot;iterate over items&quot;

class IClonableMapping(Interface):
    &quot;&quot;&quot;Something that can produce a copy of itself.

    This is available in `dict`.
    &quot;&quot;&quot;

    def copy():
        &quot;return copy of dict&quot;

class IExtendedReadMapping(IIterableMapping):
    &quot;&quot;&quot;
    Something with a particular method equivalent to ``__contains__``.

    On Python 2, `dict` provides this method, but it was removed
    in Python 3.
    &quot;&quot;&quot;

    def has_key(key):
        &quot;&quot;&quot;Tell if a key exists in the mapping; equivalent to ``__contains__``&quot;&quot;&quot;

class IExtendedWriteMapping(IWriteMapping):
    &quot;&quot;&quot;Additional mutation methods.

    These are all provided by `dict`.
    &quot;&quot;&quot;

    def clear():
        &quot;delete all items&quot;

    def update(d):
        &quot; Update D from E: for k in E.keys(): D[k] = E[k]&quot;

    def setdefault(key, default=None):
        &quot;D.setdefault(k[,d]) -&gt; D.get(k,d), also set D[k]=d if k not in D&quot;

    def pop(k, *args):
        &quot;&quot;&quot;Remove specified key and return the corresponding value.

        ``*args`` may contain a single default value, or may not be supplied.
        If key is not found, default is returned if given, otherwise
        `KeyError` is raised&quot;&quot;&quot;

    def popitem():
        &quot;&quot;&quot;remove and return some (key, value) pair as a
        2-tuple; but raise KeyError if mapping is empty&quot;&quot;&quot;

class IFullMapping(
    IExtendedReadMapping, IExtendedWriteMapping, IClonableMapping, IMapping):
    ''' Full mapping interface ''' # IMapping included so tests for IMapping
    # succeed with IFullMapping
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Fusr%2Flib64%2Fpython3.6%2Fsite-packages%2Fzope%2Finterface%2Fcommon'>Back to Directory</a>