pygae/galgebra

class KwargParser:
    """
    Helper function to emulate Python 3 keyword-only arguments.

    Use as::

        def func(x1, **kwargs):
            kw = KwargParser('func', kwargs)
            a = kw.pop('a')
            b = kw.pop('b', 2)
            kw.reject_remaining()
            ...

    To emulate the Python 3 syntax::

        def func(x1, *, a, b=2):
            ...

    This is also useful for functions with overloaded signatures, for which
    a single Python 3 signature cannot be written.
    """
    def __init__(self, func_name, kwargs):
        self._func_name = func_name
        self._kwargs = kwargs

    def pop(self, arg_name, *default):
        try:
            return self._kwargs.pop(arg_name, *default)
        except KeyError:
            pass
        raise TypeError(
            '{}() missing required keyword-only argument {!r}'
            .format(self._func_name, arg_name)
        )

    def reject_remaining(self):
        if self._kwargs:
            # match the error message to what Python 3 produces
            bad_arg = next(iter(self._kwargs))
            raise TypeError(
                '{}() got an unexpected keyword argument {!r}'
                .format(self._func_name, bad_arg)
            )