Function Mapping

src/commoncode/datautils.py:227–259

Return a mapping attribute: the optional value_type defines the type of values it stores. The key is always a string. Notes: in Python 2 the type is Dict as there is no typing available for dict for now.

(
    value_type=typing.Any,
    default=attr.NOTHING,
    validator=None,
    repr=False,
    eq=True,
    order=True,  # NOQA
    converter=None,
    help=None,
    label=None,
)

def Mapping(
    value_type=typing.Any,
    default=attr.NOTHING,
    validator=None,
    repr=False,
    eq=True,
    order=True,  # NOQA
    converter=None,
    help=None,
    label=None,
):  # NOQA
    """
    Return a mapping attribute: the optional value_type defines the type of values it
    stores. The key is always a string.

    Notes: in Python 2 the type is Dict as there is no typing available for
    dict for now.
    """
    if default is attr.NOTHING:
        default = attr.Factory(dict)

    return attribute(
        default=default,
        validator=validator,
        repr=repr,
        eq=eq,
        order=order,
        init=True,
        type=typing.Dict[str, value_type],
        converter=converter,
        help=help,
        label=label,
    )


##################################################