settngs/testing/settngs.py

from __future__ import annotations

import pytest
example: list[tuple[list[str], str, str]] = [
    (
        [],
        'Hello world\n',
        '',
    ),
    (
        ['--hello', 'lordwelch'],
        'Hello lordwelch\n',
        '',
    ),
    (
        ['--hello', 'lordwelch', '-s'],
        'Hello lordwelch\nSuccessfully saved settings to settings.json\n',
        '{\n  "Example Group": {\n    "hello": "lordwelch",\n    "verbose": false\n  },\n  "persistent": {\n    "test": false\n  }\n}\n',
    ),
    (
        [],
        'Hello lordwelch\n',
        '{\n  "Example Group": {\n    "hello": "lordwelch",\n    "verbose": false\n  },\n  "persistent": {\n    "test": false\n  }\n}\n',
    ),
    (
        ['-v'],
        'Hello lordwelch\nmerged_namespace.values.Example_Group__verbose=True\n',
        '{\n  "Example Group": {\n    "hello": "lordwelch",\n    "verbose": false\n  },\n  "persistent": {\n    "test": false\n  }\n}\n',
    ),
    (
        ['-v', '-s'],
        'Hello lordwelch\nSuccessfully saved settings to settings.json\nmerged_namespace.values.Example_Group__verbose=True\n',
        '{\n  "Example Group": {\n    "hello": "lordwelch",\n    "verbose": true\n  },\n  "persistent": {\n    "test": false\n  }\n}\n',
    ),
    (
        [],
        'Hello lordwelch\nmerged_namespace.values.Example_Group__verbose=True\n',
        '{\n  "Example Group": {\n    "hello": "lordwelch",\n    "verbose": true\n  },\n  "persistent": {\n    "test": false\n  }\n}\n',
    ),
    (
        ['manual settings.json'],
        'Hello lordwelch\nmerged_namespace.values.Example_Group__verbose=True\n',
        '{\n  "Example Group": {\n    "hello": "lordwelch",\n    "verbose": true\n  },\n  "persistent": {\n    "test": false,\n    "hello": "world"\n  }\n}\n',
    ),
    (
        ['--no-verbose', '-t'],
        'Hello lordwelch\n',
        '{\n  "Example Group": {\n    "hello": "lordwelch",\n    "verbose": true\n  },\n  "persistent": {\n    "test": false,\n    "hello": "world"\n  }\n}\n',
    ),
    (
        ['--no-verbose', '-s', '-t'],
        'Hello lordwelch\nSuccessfully saved settings to settings.json\n',
        '{\n  "Example Group": {\n    "hello": "lordwelch",\n    "verbose": false\n  },\n  "persistent": {\n    "test": true,\n    "hello": "world"\n  }\n}\n',
    ),
    (
        ['--hello', 'world', '--no-verbose', '--no-test', '-s'],
        'Hello world\nSuccessfully saved settings to settings.json\n',
        '{\n  "Example Group": {\n    "hello": "world",\n    "verbose": false\n  },\n  "persistent": {\n    "test": false,\n    "hello": "world"\n  }\n}\n',
    ),
    (
        [],
        'Hello world\n',
        '{\n  "Example Group": {\n    "hello": "world",\n    "verbose": false\n  },\n  "persistent": {\n    "test": false,\n    "hello": "world"\n  }\n}\n',
    ),
]
success = [
    (
        (
            ('--test-setting',),
            dict(
                group='tst',
            ),
        ),  # Equivalent to Setting("--test-setting", group="tst")
        {
            'action': None,
            'choices': None,
            'cmdline': True,
            'const': None,
            'default': None,
            'setting_name': 'test_setting',  # dest is calculated by Setting and is not used by argparse
            'dest': 'test_setting',  # dest is calculated by Setting and is not used by argparse
            'display_name': 'test_setting',  # defaults to dest
            'exclusive': False,
            'file': True,
            'flag': True,
            'group': 'tst',
            'help': None,
            'internal_name': 'tst__test_setting',  # Should almost always be "{group}__{dest}"
            'metavar': 'TEST_SETTING',  # Set manually so argparse doesn't use TST_TEST
            'nargs': None,
            'required': None,
            'type': None,
            'argparse_args': ('--test-setting',),  # *args actually sent to argparse
            'argparse_kwargs': {
                'action': None,
                'choices': None,
                'const': None,
                'default': None,
                'dest': 'tst__test_setting',
                'help': None,
                'metavar': 'TEST_SETTING',
                'nargs': None,
                'required': None,
                'type': None,
            },  # Non-None **kwargs sent to argparse
        },
    ),
    (
        (
            ('--test',),
            dict(
                group='tst',
                dest='testing',
            ),
        ),  # Equivalent to Setting("--test", group="tst", dest="testing")
        {
            'action': None,
            'choices': None,
            'cmdline': True,
            'const': None,
            'default': None,
            'setting_name': 'test',  # setting_name is calculated by Setting and is not used by argparse
            'dest': 'testing',  # dest is calculated by Setting and is not used by argparse
            'display_name': 'testing',  # defaults to dest
            'exclusive': False,
            'file': True,
            'flag': True,
            'group': 'tst',
            'help': None,
            'internal_name': 'tst__testing',  # Should almost always be "{group}__{dest}"
            'metavar': 'TESTING',  # Set manually so argparse doesn't use TST_TEST
            'nargs': None,
            'required': None,
            'type': None,
            'argparse_args': ('--test',),  # *args actually sent to argparse
            'argparse_kwargs': {
                'action': None,
                'choices': None,
                'const': None,
                'default': None,
                'dest': 'tst__testing',
                'help': None,
                'metavar': 'TESTING',
                'nargs': None,
                'required': None,
                'type': None,
            },  # Non-None **kwargs sent to argparse
        },
    ),
    (
        (
            ('--test',),
            dict(
                group='tst',
            ),
        ),  # Equivalent to Setting("--test", group="tst")
        {
            'action': None,
            'choices': None,
            'cmdline': True,
            'const': None,
            'default': None,
            'setting_name': 'test',  # dest is calculated by Setting and is not used by argparse
            'dest': 'test',  # dest is calculated by Setting and is not used by argparse
            'display_name': 'test',  # defaults to dest
            'exclusive': False,
            'file': True,
            'flag': True,
            'group': 'tst',
            'help': None,
            'internal_name': 'tst__test',  # Should almost always be "{group}__{dest}"
            'metavar': 'TEST',  # Set manually so argparse doesn't use TST_TEST
            'nargs': None,
            'required': None,
            'type': None,
            'argparse_args': ('--test',),  # *args actually sent to argparse
            'argparse_kwargs': {
                'action': None,
                'choices': None,
                'const': None,
                'default': None,
                'dest': 'tst__test',
                'help': None,
                'metavar': 'TEST',
                'nargs': None,
                'required': None,
                'type': None,
            },  # Non-None **kwargs sent to argparse
        },
    ),
    (
        (
            ('--test',),
            dict(
                action='store_true',
                group='tst',
            ),
        ),  # Equivalent to Setting("--test", group="tst", action="store_true")
        {
            'action': 'store_true',
            'choices': None,
            'cmdline': True,
            'const': None,
            'default': None,
            'setting_name': 'test',  # dest is calculated by Setting and is not used by argparse
            'dest': 'test',  # dest is calculated by Setting and is not used by argparse
            'display_name': 'test',  # defaults to dest
            'exclusive': False,
            'file': True,
            'flag': True,
            'group': 'tst',
            'help': None,
            'internal_name': 'tst__test',  # Should almost always be "{group}__{dest}"
            'metavar': None,  # store_true does not get a metavar
            'nargs': None,
            'required': None,
            'type': None,
            'argparse_args': ('--test',),  # *args actually sent to argparse
            'argparse_kwargs': {
                'action': 'store_true',
                'choices': None,
                'const': None,
                'default': None,
                'dest': 'tst__test',
                'help': None,
                'metavar': None,
                'nargs': None,
                'required': None,
                'type': None,
            },  # Non-None **kwargs sent to argparse
        },
    ),
    (
        (
            ('-t', '--test'),
            dict(
                group='tst',
            ),
        ),  # Equivalent to Setting("-t", "--test", group="tst")
        {
            'action': None,
            'choices': None,
            'cmdline': True,
            'const': None,
            'default': None,
            'setting_name': 'test',
            'dest': 'test',
            'display_name': 'test',  # defaults to dest
            'exclusive': False,
            'file': True,
            'flag': True,
            'group': 'tst',
            'help': None,
            'internal_name': 'tst__test',
            'metavar': 'TEST',
            'nargs': None,
            'required': None,
            'type': None,
            'argparse_args': ('-t', '--test'),  # Only difference with above is here
            'argparse_kwargs': {
                'action': None,
                'choices': None,
                'const': None,
                'default': None,
                'dest': 'tst__test',
                'help': None,
                'metavar': 'TEST',
                'nargs': None,
                'required': None,
                'type': None,
            },
        },
    ),
    (
        (
            ('test',),
            dict(
                group='tst',
            ),
        ),  # Equivalent to Setting("test", group="tst")
        {
            'action': None,
            'choices': None,
            'cmdline': True,
            'const': None,
            'default': None,
            'setting_name': 'test',
            'dest': 'test',
            'display_name': 'test',  # defaults to dest
            'exclusive': False,
            'file': True,
            'flag': False,
            'group': 'tst',
            'help': None,
            'internal_name': 'tst__test',
            'metavar': 'TEST',
            'nargs': None,
            'required': None,
            'type': None,
            'argparse_args': ('tst__test',),
            'argparse_kwargs': {
                'action': None,
                'choices': None,
                'const': None,
                'default': None,
                'dest': None,  # Only difference with #1 is here, argparse sets dest based on the *args passed to it
                'help': None,
                'metavar': 'TEST',
                'nargs': None,
                'required': None,
                'type': None,
            },
        },
    ),
    (
        (
            ('--test',),
            dict(),
        ),  # Equivalent to Setting("test")
        {
            'action': None,
            'choices': None,
            'cmdline': True,
            'const': None,
            'default': None,
            'setting_name': 'test',
            'dest': 'test',
            'display_name': 'test',  # defaults to dest
            'exclusive': False,
            'file': True,
            'flag': True,
            'group': '',
            'help': None,
            'internal_name': 'test',  # No group, leading _ is stripped
            'metavar': 'TEST',
            'nargs': None,
            'required': None,
            'type': None,
            'argparse_args': ('--test',),
            'argparse_kwargs': {
                'action': None,
                'choices': None,
                'const': None,
                'default': None,
                'dest': 'test',
                'help': None,
                'metavar': 'TEST',
                'nargs': None,
                'required': None,
                'type': None,
            },
        },
    ),
]

failure = [
    (
        (
            (),
            dict(
                group='tst',
            ),
        ),  # Equivalent to Setting(group="tst")
        pytest.raises(ValueError),
    ),
]