<gh_stars>1-10
#
# Copyright 2021 <NAME>
#           2020-2021 <NAME>
#           2019-2020 <NAME>
#
# ### MIT license
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#

import warnings
from functools import wraps


def deprecated(version=None, alternative=None):
    """Emit a deprecation warning for a function."""

    def deprecated_decorator(func):

        def _get_warn_str(version=version, alternative=alternative):
            if version is None:
                warn_str = f'Function/property `{func.__name__}` is deprecated.'
            else:
                warn_str = f'Function/property `{func.__name__}` was deprecated in SurfaceTopography {version}.'
            if alternative is not None:
                warn_str += f' The function/property `{alternative}` provides this functionality now.'
            return warn_str

        @wraps(func)
        def deprecated_func(*args, **kwargs):
            warnings.warn(_get_warn_str(version, alternative), DeprecationWarning)
            return func(*args, **kwargs)

        docstring = deprecated_func.__doc__ or ""
        docstring += "\n\n" + _get_warn_str(version, alternative)
        deprecated_func.__doc__ = docstring

        return deprecated_func

    return deprecated_decorator


class DeprecatedDictionary(dict):
    """A dictionary that raises a deprecation warning when accessing certain keys."""

    def __init__(self, *args, **kwargs):
        self._deprecated_keys = kwargs['deprecated_keys']
        del kwargs['deprecated_keys']
        super().__init__(*args, **kwargs)

    def __getitem__(self, key):
        if key in self._deprecated_keys:
            warnings.warn(f"Dictionary key '{key}' has been deprecated.", DeprecationWarning)
        return super().__getitem__(key)

    def copy(self):
        return DeprecatedDictionary(self, deprecated_keys=self._deprecated_keys)

#
# Copyright 2021 <NAME>
#           2020-2021 <NAME>
#           2019-2020 <NAME>
#
# ### MIT license
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
#

import warnings
from functools import wraps


def deprecated(version=None, alternative=None):
    """Emit a deprecation warning for a function."""

    def deprecated_decorator(func):

        def _get_warn_str(version=version, alternative=alternative):
            if version is None:
                warn_str = f'Function/property `{func.__name__}` is deprecated.'
            else:
                warn_str = f'Function/property `{func.__name__}` was deprecated in SurfaceTopography {version}.'
            if alternative is not None:
                warn_str += f' The function/property `{alternative}` provides this functionality now.'
            return warn_str

        @wraps(func)
        def deprecated_func(*args, **kwargs):
            warnings.warn(_get_warn_str(version, alternative), DeprecationWarning)
            return func(*args, **kwargs)

        docstring = deprecated_func.__doc__ or ""
        docstring += "\n\n" + _get_warn_str(version, alternative)
        deprecated_func.__doc__ = docstring

        return deprecated_func

    return deprecated_decorator


class DeprecatedDictionary(dict):
    """A dictionary that raises a deprecation warning when accessing certain keys."""

    def __init__(self, *args, **kwargs):
        self._deprecated_keys = kwargs['deprecated_keys']
        del kwargs['deprecated_keys']
        super().__init__(*args, **kwargs)

    def __getitem__(self, key):
        if key in self._deprecated_keys:
            warnings.warn(f"Dictionary key '{key}' has been deprecated.", DeprecationWarning)
        return super().__getitem__(key)

    def copy(self):
        return DeprecatedDictionary(self, deprecated_keys=self._deprecated_keys)
# # Copyright 2021 <NAME> #           2020-2021 <NAME> #           2019-2020 <NAME> # # ### MIT license # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE # SOFTWARE. # Emit a deprecation warning for a function. A dictionary that raises a deprecation warning when accessing certain keys.