view mercurial/thirdparty/attr/converters.py @ 45507:df87821081ee

changing-files: implement equality checking This makes debugging simpler.
author Pierre-Yves David <pierre-yves.david@octobus.net>
date Tue, 15 Sep 2020 15:03:07 +0200
parents 765eb17a7eb8
children e1c586b9a43c
line wrap: on
line source

"""
Commonly useful converters.
"""

from __future__ import absolute_import, division, print_function


def optional(converter):
    """
    A converter that allows an attribute to be optional. An optional attribute
    is one which can be set to ``None``.

    :param callable converter: the converter that is used for non-``None``
        values.

    ..  versionadded:: 17.1.0
    """

    def optional_converter(val):
        if val is None:
            return None
        return converter(val)

    return optional_converter