Source code for options.errors

#
# For licensing see accompanying LICENSE file.
# Copyright (C) 2023 Apple Inc. All Rights Reserved.
#

from common import is_test_env


class UnrecognizedYamlConfigEntry(Warning):
    # TODO: consider converting UnrecognizedYamlConfigEntry Warning to an Exception.
    def __init__(self, key: str) -> None:
        message = (
            f"Yaml config key '{key}' was not recognized by argparser. If you think that you have already added "
            f"argument in options/opts.py file, then check for typos. If not, then please add it to options/opts.py."
        )
        super().__init__(message)

        if is_test_env():
            # Currently, we only raise an exception in test environment.
            raise ValueError(message)