Compare commits
10 Commits
23d0139144
...
c588fc891e
Author | SHA1 | Date | |
---|---|---|---|
|
c588fc891e | ||
|
1ce6079285 | ||
|
7c748f6815 | ||
|
8d5b30546e | ||
|
cebca481fc | ||
|
dd8cd1188e | ||
|
d30e73a679 | ||
|
fc2a175e5b | ||
|
4c385667e8 | ||
|
9ffefb3e21 |
@ -28,7 +28,7 @@ repos:
|
|||||||
hooks:
|
hooks:
|
||||||
- id: dead
|
- id: dead
|
||||||
- repo: https://github.com/asottile/pyupgrade
|
- repo: https://github.com/asottile/pyupgrade
|
||||||
rev: v3.15.0
|
rev: v3.15.1
|
||||||
hooks:
|
hooks:
|
||||||
- id: pyupgrade
|
- id: pyupgrade
|
||||||
args: [--py38-plus]
|
args: [--py38-plus]
|
||||||
@ -37,11 +37,11 @@ repos:
|
|||||||
hooks:
|
hooks:
|
||||||
- id: autopep8
|
- id: autopep8
|
||||||
- repo: https://github.com/PyCQA/flake8
|
- repo: https://github.com/PyCQA/flake8
|
||||||
rev: 6.1.0
|
rev: 7.0.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: flake8
|
- id: flake8
|
||||||
additional_dependencies: [flake8-encodings, flake8-warnings, flake8-builtins, flake8-length, flake8-print]
|
additional_dependencies: [flake8-encodings, flake8-warnings, flake8-builtins, flake8-print]
|
||||||
- repo: https://github.com/pre-commit/mirrors-mypy
|
- repo: https://github.com/pre-commit/mirrors-mypy
|
||||||
rev: v1.7.0
|
rev: v1.8.0
|
||||||
hooks:
|
hooks:
|
||||||
- id: mypy
|
- id: mypy
|
||||||
|
@ -64,7 +64,7 @@ Hello world
|
|||||||
settngs.json at the end:
|
settngs.json at the end:
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"example": {
|
"Example Group": {
|
||||||
"hello": "world",
|
"hello": "world",
|
||||||
"verbose": false
|
"verbose": false
|
||||||
},
|
},
|
||||||
|
@ -13,6 +13,7 @@ from collections import defaultdict
|
|||||||
from collections.abc import Sequence
|
from collections.abc import Sequence
|
||||||
from typing import Any
|
from typing import Any
|
||||||
from typing import Callable
|
from typing import Callable
|
||||||
|
from typing import cast
|
||||||
from typing import Dict
|
from typing import Dict
|
||||||
from typing import Generic
|
from typing import Generic
|
||||||
from typing import NoReturn
|
from typing import NoReturn
|
||||||
@ -84,6 +85,20 @@ else: # pragma: no cover
|
|||||||
removeprefix = str.removeprefix
|
removeprefix = str.removeprefix
|
||||||
|
|
||||||
|
|
||||||
|
def _isnamedtupleinstance(x: Any) -> bool:
|
||||||
|
t = type(x)
|
||||||
|
b = t.__bases__
|
||||||
|
|
||||||
|
if len(b) != 1 or b[0] != tuple:
|
||||||
|
return False
|
||||||
|
|
||||||
|
f = getattr(t, '_fields', None)
|
||||||
|
if not isinstance(f, tuple):
|
||||||
|
return False
|
||||||
|
|
||||||
|
return all(isinstance(n, str) for n in f)
|
||||||
|
|
||||||
|
|
||||||
class Setting:
|
class Setting:
|
||||||
def __init__(
|
def __init__(
|
||||||
self,
|
self,
|
||||||
@ -107,6 +122,9 @@ class Setting:
|
|||||||
exclusive: bool = False,
|
exclusive: bool = False,
|
||||||
):
|
):
|
||||||
"""
|
"""
|
||||||
|
Attributes:
|
||||||
|
setting_name: This is the name used to retrieve this Setting object from a `Config` Definitions dictionary.
|
||||||
|
This only differs from dest when a custom dest is given
|
||||||
|
|
||||||
Args:
|
Args:
|
||||||
*names: Passed directly to argparse
|
*names: Passed directly to argparse
|
||||||
@ -119,7 +137,8 @@ class Setting:
|
|||||||
required: Passed directly to argparse
|
required: Passed directly to argparse
|
||||||
help: Passed directly to argparse
|
help: Passed directly to argparse
|
||||||
metavar: Passed directly to argparse, defaults to `dest` upper-cased
|
metavar: Passed directly to argparse, defaults to `dest` upper-cased
|
||||||
dest: This is the name used to retrieve the value from a `Config` object as a dictionary
|
dest: This is the name used to retrieve the value from a `Config` object as a dictionary.
|
||||||
|
Default to `setting_name`.
|
||||||
display_name: This is not used by settngs. This is a human-readable name to be used when generating a GUI.
|
display_name: This is not used by settngs. This is a human-readable name to be used when generating a GUI.
|
||||||
Defaults to `dest`.
|
Defaults to `dest`.
|
||||||
cmdline: If this setting can be set via the commandline
|
cmdline: If this setting can be set via the commandline
|
||||||
@ -133,7 +152,7 @@ class Setting:
|
|||||||
raise ValueError('names must be specified')
|
raise ValueError('names must be specified')
|
||||||
# We prefix the destination name used by argparse so that there are no conflicts
|
# We prefix the destination name used by argparse so that there are no conflicts
|
||||||
# Argument names will still cause an exception if there is a conflict e.g. if '-f' is defined twice
|
# Argument names will still cause an exception if there is a conflict e.g. if '-f' is defined twice
|
||||||
self.internal_name, dest, self.flag = self.get_dest(group, names, dest)
|
self.internal_name, setting_name, dest, self.flag = self.get_dest(group, names, dest)
|
||||||
args: Sequence[str] = names
|
args: Sequence[str] = names
|
||||||
|
|
||||||
# We then also set the metavar so that '--config' in the group runtime shows as 'CONFIG' instead of 'RUNTIME_CONFIG'
|
# We then also set the metavar so that '--config' in the group runtime shows as 'CONFIG' instead of 'RUNTIME_CONFIG'
|
||||||
@ -155,6 +174,7 @@ class Setting:
|
|||||||
self.help = help
|
self.help = help
|
||||||
self.metavar = metavar
|
self.metavar = metavar
|
||||||
self.dest = dest
|
self.dest = dest
|
||||||
|
self.setting_name = setting_name
|
||||||
self.cmdline = cmdline
|
self.cmdline = cmdline
|
||||||
self.file = file
|
self.file = file
|
||||||
self.argparse_args = args
|
self.argparse_args = args
|
||||||
@ -194,6 +214,11 @@ class Setting:
|
|||||||
return str
|
return str
|
||||||
else:
|
else:
|
||||||
if not self.cmdline and self.default is not None:
|
if not self.cmdline and self.default is not None:
|
||||||
|
if not isinstance(self.default, str) and not _isnamedtupleinstance(self.default) and isinstance(self.default, Sequence) and self.default and self.default[0]:
|
||||||
|
try:
|
||||||
|
return cast(type, type(self.default)[type(self.default[0])])
|
||||||
|
except Exception:
|
||||||
|
...
|
||||||
return type(self.default)
|
return type(self.default)
|
||||||
return 'Any'
|
return 'Any'
|
||||||
|
|
||||||
@ -206,6 +231,11 @@ class Setting:
|
|||||||
t: type | str = type_hints['return']
|
t: type | str = type_hints['return']
|
||||||
return t
|
return t
|
||||||
if self.default is not None:
|
if self.default is not None:
|
||||||
|
if not isinstance(self.default, str) and not _isnamedtupleinstance(self.default) and isinstance(self.default, Sequence) and self.default and self.default[0]:
|
||||||
|
try:
|
||||||
|
return cast(type, type(self.default)[type(self.default[0])])
|
||||||
|
except Exception:
|
||||||
|
...
|
||||||
return type(self.default)
|
return type(self.default)
|
||||||
return 'Any'
|
return 'Any'
|
||||||
|
|
||||||
@ -228,28 +258,30 @@ class Setting:
|
|||||||
return None
|
return None
|
||||||
return 'Any'
|
return 'Any'
|
||||||
|
|
||||||
def get_dest(self, prefix: str, names: Sequence[str], dest: str | None) -> tuple[str, str, bool]:
|
def get_dest(self, prefix: str, names: Sequence[str], dest: str | None) -> tuple[str, str, str, bool]:
|
||||||
dest_name = None
|
setting_name = None
|
||||||
flag = False
|
flag = False
|
||||||
|
|
||||||
prefix = sanitize_name(prefix)
|
prefix = sanitize_name(prefix)
|
||||||
for n in names:
|
for n in names:
|
||||||
if n.startswith('--'):
|
if n.startswith('--'):
|
||||||
flag = True
|
flag = True
|
||||||
dest_name = sanitize_name(n)
|
setting_name = sanitize_name(n)
|
||||||
break
|
break
|
||||||
if n.startswith('-'):
|
if n.startswith('-'):
|
||||||
flag = True
|
flag = True
|
||||||
|
|
||||||
if dest_name is None:
|
if setting_name is None:
|
||||||
dest_name = names[0]
|
setting_name = names[0]
|
||||||
if dest:
|
if dest:
|
||||||
dest_name = dest
|
dest_name = dest
|
||||||
|
else:
|
||||||
|
dest_name = setting_name
|
||||||
if not dest_name.isidentifier():
|
if not dest_name.isidentifier():
|
||||||
raise Exception(f'Cannot use {dest_name} in a namespace')
|
raise Exception(f'Cannot use {dest_name} in a namespace')
|
||||||
|
|
||||||
internal_name = f'{prefix}__{dest_name}'.lstrip('_')
|
internal_name = f'{prefix}__{dest_name}'.lstrip('_')
|
||||||
return internal_name, dest_name, flag
|
return internal_name, setting_name, dest_name, flag
|
||||||
|
|
||||||
def filter_argparse_kwargs(self) -> dict[str, Any]:
|
def filter_argparse_kwargs(self) -> dict[str, Any]:
|
||||||
return {k: v for k, v in self.argparse_kwargs.items() if v is not None}
|
return {k: v for k, v in self.argparse_kwargs.items() if v is not None}
|
||||||
@ -284,8 +316,8 @@ if TYPE_CHECKING:
|
|||||||
ns = Namespace | TypedNS | Config[T] | None
|
ns = Namespace | TypedNS | Config[T] | None
|
||||||
|
|
||||||
|
|
||||||
def generate_ns(definitions: Definitions) -> str:
|
def generate_ns(definitions: Definitions) -> tuple[str, str]:
|
||||||
initial_imports = ['from __future__ import annotations', '', 'import settngs', '']
|
initial_imports = ['from __future__ import annotations', '', 'import settngs']
|
||||||
imports: Sequence[str] | set[str]
|
imports: Sequence[str] | set[str]
|
||||||
imports = set()
|
imports = set()
|
||||||
|
|
||||||
@ -317,12 +349,14 @@ def generate_ns(definitions: Definitions) -> str:
|
|||||||
if type_name == 'Any':
|
if type_name == 'Any':
|
||||||
type_name = 'typing.Any'
|
type_name = 'typing.Any'
|
||||||
|
|
||||||
attributes.append(f' {setting.internal_name}: {type_name}')
|
attribute = f' {setting.internal_name}: {type_name}'
|
||||||
|
if attribute not in attributes:
|
||||||
|
attributes.append(attribute)
|
||||||
# Add a blank line between groups
|
# Add a blank line between groups
|
||||||
if attributes and attributes[-1] != '':
|
if attributes and attributes[-1] != '':
|
||||||
attributes.append('')
|
attributes.append('')
|
||||||
|
|
||||||
ns = 'class settngs_namespace(settngs.TypedNS):\n'
|
ns = 'class SettngsNS(settngs.TypedNS):\n'
|
||||||
# Add a '...' expression if there are no attributes
|
# Add a '...' expression if there are no attributes
|
||||||
if not attributes or all(x == '' for x in attributes):
|
if not attributes or all(x == '' for x in attributes):
|
||||||
ns += ' ...\n'
|
ns += ' ...\n'
|
||||||
@ -336,7 +370,69 @@ def generate_ns(definitions: Definitions) -> str:
|
|||||||
imports = sorted(list(imports - {'import typing'}))
|
imports = sorted(list(imports - {'import typing'}))
|
||||||
|
|
||||||
# Merge the imports the ns class definition and the attributes
|
# Merge the imports the ns class definition and the attributes
|
||||||
return '\n'.join(initial_imports + imports) + '\n\n\n' + ns + '\n'.join(attributes)
|
return '\n'.join(initial_imports + imports), ns + '\n'.join(attributes)
|
||||||
|
|
||||||
|
|
||||||
|
def generate_dict(definitions: Definitions) -> tuple[str, str]:
|
||||||
|
initial_imports = ['from __future__ import annotations', '', 'import typing']
|
||||||
|
imports: Sequence[str] | set[str]
|
||||||
|
imports = set()
|
||||||
|
|
||||||
|
groups_are_identifiers = all(n.isidentifier() for n in definitions.keys())
|
||||||
|
classes = []
|
||||||
|
for group_name, group in definitions.items():
|
||||||
|
attributes = []
|
||||||
|
for setting in group.v.values():
|
||||||
|
t = setting._guess_type()
|
||||||
|
if t is None:
|
||||||
|
continue
|
||||||
|
# Default to any
|
||||||
|
type_name = 'Any'
|
||||||
|
|
||||||
|
# Take a string as is
|
||||||
|
if isinstance(t, str):
|
||||||
|
type_name = t
|
||||||
|
# Handle generic aliases eg dict[str, str] instead of dict
|
||||||
|
elif isinstance(t, types_GenericAlias):
|
||||||
|
type_name = str(t)
|
||||||
|
# Handle standard type objects
|
||||||
|
elif isinstance(t, type):
|
||||||
|
type_name = t.__name__
|
||||||
|
# Builtin types don't need an import
|
||||||
|
if t.__module__ != 'builtins':
|
||||||
|
imports.add(f'import {t.__module__}')
|
||||||
|
# Use the full imported name
|
||||||
|
type_name = t.__module__ + '.' + type_name
|
||||||
|
|
||||||
|
# Expand Any to typing.Any
|
||||||
|
if type_name == 'Any':
|
||||||
|
type_name = 'typing.Any'
|
||||||
|
|
||||||
|
attribute = f' {setting.dest}: {type_name}'
|
||||||
|
if attribute not in attributes:
|
||||||
|
attributes.append(attribute)
|
||||||
|
if not attributes or all(x == '' for x in attributes):
|
||||||
|
attributes = [' ...']
|
||||||
|
classes.append(
|
||||||
|
f'class {sanitize_name(group_name)}(typing.TypedDict):\n'
|
||||||
|
+ '\n'.join(attributes) + '\n\n',
|
||||||
|
)
|
||||||
|
|
||||||
|
# Remove the possible duplicate typing import
|
||||||
|
imports = sorted(list(imports - {'import typing'}))
|
||||||
|
|
||||||
|
if groups_are_identifiers:
|
||||||
|
ns = '\nclass SettngsDict(typing.TypedDict):\n'
|
||||||
|
ns += '\n'.join(f' {n}: {sanitize_name(n)}' for n in definitions.keys())
|
||||||
|
else:
|
||||||
|
ns = '\nSettngsDict = typing.TypedDict(\n'
|
||||||
|
ns += " 'SettngsDict', {\n"
|
||||||
|
for n in definitions.keys():
|
||||||
|
ns += f' {n!r}: {sanitize_name(n)},\n'
|
||||||
|
ns += ' },\n'
|
||||||
|
ns += ')\n'
|
||||||
|
# Merge the imports the ns class definition and the attributes
|
||||||
|
return '\n'.join(initial_imports + imports), '\n'.join(classes) + ns + '\n'
|
||||||
|
|
||||||
|
|
||||||
def sanitize_name(name: str) -> str:
|
def sanitize_name(name: str) -> str:
|
||||||
@ -441,13 +537,13 @@ def normalize_config(
|
|||||||
value, is_default = get_option(options, setting)
|
value, is_default = get_option(options, setting)
|
||||||
if not is_default or default:
|
if not is_default or default:
|
||||||
# User has set a custom value or has requested the default value
|
# User has set a custom value or has requested the default value
|
||||||
group_options[setting_name] = value
|
group_options[setting.dest] = value
|
||||||
elif setting_name in group_options:
|
elif setting.dest in group_options:
|
||||||
# default values have been requested to be removed
|
# default values have been requested to be removed
|
||||||
del group_options[setting_name]
|
del group_options[setting.dest]
|
||||||
elif setting_name in group_options:
|
elif setting.dest in group_options:
|
||||||
# Setting type (file or cmdline) has not been requested and should be removed for persistent groups
|
# Setting type (file or cmdline) has not been requested and should be removed for persistent groups
|
||||||
del group_options[setting_name]
|
del group_options[setting.dest]
|
||||||
normalized[group_name] = group_options
|
normalized[group_name] = group_options
|
||||||
|
|
||||||
return Config(normalized, config.definitions)
|
return Config(normalized, config.definitions)
|
||||||
@ -698,9 +794,12 @@ class Manager:
|
|||||||
return Config(c, self.definitions)
|
return Config(c, self.definitions)
|
||||||
return c
|
return c
|
||||||
|
|
||||||
def generate_ns(self) -> str:
|
def generate_ns(self) -> tuple[str, str]:
|
||||||
return generate_ns(self.definitions)
|
return generate_ns(self.definitions)
|
||||||
|
|
||||||
|
def generate_dict(self) -> tuple[str, str]:
|
||||||
|
return generate_dict(self.definitions)
|
||||||
|
|
||||||
def create_argparser(self) -> None:
|
def create_argparser(self) -> None:
|
||||||
self.argparser = create_argparser(self.definitions, self.description, self.epilog)
|
self.argparser = create_argparser(self.definitions, self.description, self.epilog)
|
||||||
|
|
||||||
@ -708,7 +807,7 @@ class Manager:
|
|||||||
"""Passes all arguments through to `Setting`, `group` and `exclusive` are already set"""
|
"""Passes all arguments through to `Setting`, `group` and `exclusive` are already set"""
|
||||||
|
|
||||||
setting = Setting(*args, **kwargs, group=self.current_group_name, exclusive=self.exclusive_group)
|
setting = Setting(*args, **kwargs, group=self.current_group_name, exclusive=self.exclusive_group)
|
||||||
self.definitions[self.current_group_name].v[setting.dest] = setting
|
self.definitions[self.current_group_name].v[setting.setting_name] = setting
|
||||||
|
|
||||||
def add_group(self, name: str, group: Callable[[Manager], None], exclusive_group: bool = False) -> None:
|
def add_group(self, name: str, group: Callable[[Manager], None], exclusive_group: bool = False) -> None:
|
||||||
"""
|
"""
|
||||||
|
@ -77,6 +77,7 @@ success = [
|
|||||||
'cmdline': True,
|
'cmdline': True,
|
||||||
'const': None,
|
'const': None,
|
||||||
'default': 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
|
'dest': 'test_setting', # dest is calculated by Setting and is not used by argparse
|
||||||
'display_name': 'test_setting', # defaults to dest
|
'display_name': 'test_setting', # defaults to dest
|
||||||
'exclusive': False,
|
'exclusive': False,
|
||||||
@ -84,7 +85,7 @@ success = [
|
|||||||
'flag': True,
|
'flag': True,
|
||||||
'group': 'tst',
|
'group': 'tst',
|
||||||
'help': None,
|
'help': None,
|
||||||
'internal_name': 'tst__test_setting', # Should almost always be "{group}_{dest}"
|
'internal_name': 'tst__test_setting', # Should almost always be "{group}__{dest}"
|
||||||
'metavar': 'TEST_SETTING', # Set manually so argparse doesn't use TST_TEST
|
'metavar': 'TEST_SETTING', # Set manually so argparse doesn't use TST_TEST
|
||||||
'nargs': None,
|
'nargs': None,
|
||||||
'required': None,
|
'required': None,
|
||||||
@ -118,6 +119,7 @@ success = [
|
|||||||
'cmdline': True,
|
'cmdline': True,
|
||||||
'const': None,
|
'const': None,
|
||||||
'default': 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
|
'dest': 'testing', # dest is calculated by Setting and is not used by argparse
|
||||||
'display_name': 'testing', # defaults to dest
|
'display_name': 'testing', # defaults to dest
|
||||||
'exclusive': False,
|
'exclusive': False,
|
||||||
@ -125,7 +127,7 @@ success = [
|
|||||||
'flag': True,
|
'flag': True,
|
||||||
'group': 'tst',
|
'group': 'tst',
|
||||||
'help': None,
|
'help': None,
|
||||||
'internal_name': 'tst__testing', # Should almost always be "{group}_{dest}"
|
'internal_name': 'tst__testing', # Should almost always be "{group}__{dest}"
|
||||||
'metavar': 'TESTING', # Set manually so argparse doesn't use TST_TEST
|
'metavar': 'TESTING', # Set manually so argparse doesn't use TST_TEST
|
||||||
'nargs': None,
|
'nargs': None,
|
||||||
'required': None,
|
'required': None,
|
||||||
@ -158,6 +160,7 @@ success = [
|
|||||||
'cmdline': True,
|
'cmdline': True,
|
||||||
'const': None,
|
'const': None,
|
||||||
'default': 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
|
'dest': 'test', # dest is calculated by Setting and is not used by argparse
|
||||||
'display_name': 'test', # defaults to dest
|
'display_name': 'test', # defaults to dest
|
||||||
'exclusive': False,
|
'exclusive': False,
|
||||||
@ -165,7 +168,7 @@ success = [
|
|||||||
'flag': True,
|
'flag': True,
|
||||||
'group': 'tst',
|
'group': 'tst',
|
||||||
'help': None,
|
'help': None,
|
||||||
'internal_name': 'tst__test', # Should almost always be "{group}_{dest}"
|
'internal_name': 'tst__test', # Should almost always be "{group}__{dest}"
|
||||||
'metavar': 'TEST', # Set manually so argparse doesn't use TST_TEST
|
'metavar': 'TEST', # Set manually so argparse doesn't use TST_TEST
|
||||||
'nargs': None,
|
'nargs': None,
|
||||||
'required': None,
|
'required': None,
|
||||||
@ -199,6 +202,7 @@ success = [
|
|||||||
'cmdline': True,
|
'cmdline': True,
|
||||||
'const': None,
|
'const': None,
|
||||||
'default': 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
|
'dest': 'test', # dest is calculated by Setting and is not used by argparse
|
||||||
'display_name': 'test', # defaults to dest
|
'display_name': 'test', # defaults to dest
|
||||||
'exclusive': False,
|
'exclusive': False,
|
||||||
@ -206,7 +210,7 @@ success = [
|
|||||||
'flag': True,
|
'flag': True,
|
||||||
'group': 'tst',
|
'group': 'tst',
|
||||||
'help': None,
|
'help': None,
|
||||||
'internal_name': 'tst__test', # Should almost always be "{group}_{dest}"
|
'internal_name': 'tst__test', # Should almost always be "{group}__{dest}"
|
||||||
'metavar': None, # store_true does not get a metavar
|
'metavar': None, # store_true does not get a metavar
|
||||||
'nargs': None,
|
'nargs': None,
|
||||||
'required': None,
|
'required': None,
|
||||||
@ -239,6 +243,7 @@ success = [
|
|||||||
'cmdline': True,
|
'cmdline': True,
|
||||||
'const': None,
|
'const': None,
|
||||||
'default': None,
|
'default': None,
|
||||||
|
'setting_name': 'test',
|
||||||
'dest': 'test',
|
'dest': 'test',
|
||||||
'display_name': 'test', # defaults to dest
|
'display_name': 'test', # defaults to dest
|
||||||
'exclusive': False,
|
'exclusive': False,
|
||||||
@ -279,6 +284,7 @@ success = [
|
|||||||
'cmdline': True,
|
'cmdline': True,
|
||||||
'const': None,
|
'const': None,
|
||||||
'default': None,
|
'default': None,
|
||||||
|
'setting_name': 'test',
|
||||||
'dest': 'test',
|
'dest': 'test',
|
||||||
'display_name': 'test', # defaults to dest
|
'display_name': 'test', # defaults to dest
|
||||||
'exclusive': False,
|
'exclusive': False,
|
||||||
@ -317,6 +323,7 @@ success = [
|
|||||||
'cmdline': True,
|
'cmdline': True,
|
||||||
'const': None,
|
'const': None,
|
||||||
'default': None,
|
'default': None,
|
||||||
|
'setting_name': 'test',
|
||||||
'dest': 'test',
|
'dest': 'test',
|
||||||
'display_name': 'test', # defaults to dest
|
'display_name': 'test', # defaults to dest
|
||||||
'exclusive': False,
|
'exclusive': False,
|
||||||
|
@ -6,7 +6,6 @@ import json
|
|||||||
import pathlib
|
import pathlib
|
||||||
import sys
|
import sys
|
||||||
from collections import defaultdict
|
from collections import defaultdict
|
||||||
from textwrap import dedent
|
|
||||||
from typing import Generator
|
from typing import Generator
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
@ -18,7 +17,18 @@ from testing.settngs import failure
|
|||||||
from testing.settngs import success
|
from testing.settngs import success
|
||||||
|
|
||||||
|
|
||||||
if sys.version_info < (3, 9): # pragma: no cover
|
if sys.version_info >= (3, 10): # pragma: no cover
|
||||||
|
List = list
|
||||||
|
help_output = '''\
|
||||||
|
usage: __main__.py [-h] [TEST ...]
|
||||||
|
|
||||||
|
positional arguments:
|
||||||
|
TEST
|
||||||
|
|
||||||
|
options:
|
||||||
|
-h, --help show this help message and exit
|
||||||
|
'''
|
||||||
|
elif sys.version_info < (3, 9): # pragma: no cover
|
||||||
from typing import List
|
from typing import List
|
||||||
help_output = '''\
|
help_output = '''\
|
||||||
usage: __main__.py [-h] [TEST [TEST ...]]
|
usage: __main__.py [-h] [TEST [TEST ...]]
|
||||||
@ -42,17 +52,6 @@ optional arguments:
|
|||||||
-h, --help show this help message and exit
|
-h, --help show this help message and exit
|
||||||
'''
|
'''
|
||||||
|
|
||||||
if sys.version_info >= (3, 10): # pragma: no cover
|
|
||||||
help_output = '''\
|
|
||||||
usage: __main__.py [-h] [TEST ...]
|
|
||||||
|
|
||||||
positional arguments:
|
|
||||||
TEST
|
|
||||||
|
|
||||||
options:
|
|
||||||
-h, --help show this help message and exit
|
|
||||||
'''
|
|
||||||
|
|
||||||
|
|
||||||
@pytest.fixture
|
@pytest.fixture
|
||||||
def settngs_manager() -> Generator[settngs.Manager, None, None]:
|
def settngs_manager() -> Generator[settngs.Manager, None, None]:
|
||||||
@ -210,6 +209,24 @@ class TestValues:
|
|||||||
assert non_defaults_normalized.values['tst'] == {'test': 'world'}
|
assert non_defaults_normalized.values['tst'] == {'test': 'world'}
|
||||||
assert non_defaults_normalized.values['tst_persistent'] == {'test': 'world'}
|
assert non_defaults_normalized.values['tst_persistent'] == {'test': 'world'}
|
||||||
|
|
||||||
|
def test_normalize_dest(self, settngs_manager):
|
||||||
|
settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
|
||||||
|
settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test2', dest='test', default='hello'))
|
||||||
|
settngs_manager.add_persistent_group('tst_persistent', lambda parser: parser.add_setting('--test', default='hello'))
|
||||||
|
|
||||||
|
defaults = settngs_manager.defaults()
|
||||||
|
defaults_normalized = settngs_manager.normalize_config(defaults, file=True, default=False)
|
||||||
|
assert defaults_normalized.values['tst'] == {}
|
||||||
|
assert defaults_normalized.values['tst_persistent'] == {}
|
||||||
|
|
||||||
|
non_defaults = settngs_manager.defaults()
|
||||||
|
non_defaults.values['tst']['test'] = 'world'
|
||||||
|
non_defaults.values['tst_persistent']['test'] = 'world'
|
||||||
|
non_defaults_normalized = settngs_manager.normalize_config(non_defaults, file=True, default=False)
|
||||||
|
|
||||||
|
assert non_defaults_normalized.values['tst'] == {'test': 'world'}
|
||||||
|
assert non_defaults_normalized.values['tst_persistent'] == {'test': 'world'}
|
||||||
|
|
||||||
def test_normalize(self, settngs_manager):
|
def test_normalize(self, settngs_manager):
|
||||||
settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
|
settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
|
||||||
settngs_manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))
|
settngs_manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))
|
||||||
@ -317,6 +334,23 @@ class TestNamespace:
|
|||||||
assert non_defaults_normalized.values.tst__test == 'world'
|
assert non_defaults_normalized.values.tst__test == 'world'
|
||||||
assert non_defaults_normalized.values.tst_persistent__test == 'world'
|
assert non_defaults_normalized.values.tst_persistent__test == 'world'
|
||||||
|
|
||||||
|
def test_normalize_dest(self, settngs_manager):
|
||||||
|
settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
|
||||||
|
settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test2', dest='test', default='hello'))
|
||||||
|
settngs_manager.add_persistent_group('tst_persistent', lambda parser: parser.add_setting('--test', default='hello'))
|
||||||
|
|
||||||
|
defaults = settngs_manager.defaults()
|
||||||
|
defaults_normalized = settngs_manager.get_namespace(settngs_manager.normalize_config(defaults, file=True, default=False), file=True, default=False)
|
||||||
|
assert defaults_normalized.values.__dict__ == {}
|
||||||
|
|
||||||
|
non_defaults = settngs_manager.get_namespace(settngs_manager.defaults(), file=True, cmdline=True)
|
||||||
|
non_defaults.values.tst__test = 'world'
|
||||||
|
non_defaults.values.tst_persistent__test = 'world'
|
||||||
|
non_defaults_normalized = settngs_manager.get_namespace(settngs_manager.normalize_config(non_defaults, file=True, default=False), file=True, default=False)
|
||||||
|
|
||||||
|
assert non_defaults_normalized.values.tst__test == 'world'
|
||||||
|
assert non_defaults_normalized.values.tst_persistent__test == 'world'
|
||||||
|
|
||||||
def test_normalize(self, settngs_manager):
|
def test_normalize(self, settngs_manager):
|
||||||
settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
|
settngs_manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
|
||||||
settngs_manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))
|
settngs_manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))
|
||||||
@ -333,7 +367,7 @@ class TestNamespace:
|
|||||||
assert normalized.persistent__hello == 'success'
|
assert normalized.persistent__hello == 'success'
|
||||||
assert normalized.persistent__world == 'world'
|
assert normalized.persistent__world == 'world'
|
||||||
|
|
||||||
def test_normalize_unknown(self, settngs_manager):
|
def test_normalize_unknown_group(self, settngs_manager):
|
||||||
manager = settngs.Manager()
|
manager = settngs.Manager()
|
||||||
manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
|
manager.add_group('tst', lambda parser: parser.add_setting('--test', default='hello'))
|
||||||
manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))
|
manager.add_persistent_group('persistent', lambda parser: parser.add_setting('--world', default='world'))
|
||||||
@ -615,83 +649,140 @@ class _customAction(argparse.Action): # pragma: no cover
|
|||||||
|
|
||||||
|
|
||||||
types = (
|
types = (
|
||||||
(settngs.Setting('-t', '--test'), str),
|
(0, settngs.Setting('-t', '--test'), str),
|
||||||
(settngs.Setting('-t', '--test', cmdline=False), 'Any'),
|
(1, settngs.Setting('-t', '--test', cmdline=False), 'Any'),
|
||||||
(settngs.Setting('-t', '--test', default=1, file=True, cmdline=False), int),
|
(2, settngs.Setting('-t', '--test', default=1, file=True, cmdline=False), int),
|
||||||
(settngs.Setting('-t', '--test', action='count'), int),
|
(3, settngs.Setting('-t', '--test', action='count'), int),
|
||||||
(settngs.Setting('-t', '--test', action='append'), List[str]),
|
(4, settngs.Setting('-t', '--test', action='append'), List[str]),
|
||||||
(settngs.Setting('-t', '--test', action='extend'), List[str]),
|
(5, settngs.Setting('-t', '--test', action='extend'), List[str]),
|
||||||
(settngs.Setting('-t', '--test', action='store_const', const=1), int),
|
(6, settngs.Setting('-t', '--test', nargs='+'), List[str]),
|
||||||
(settngs.Setting('-t', '--test', action='append_const', const=1), list),
|
(7, settngs.Setting('-t', '--test', action='store_const', const=1), int),
|
||||||
(settngs.Setting('-t', '--test', action='store_true'), bool),
|
(8, settngs.Setting('-t', '--test', action='append_const', const=1), list),
|
||||||
(settngs.Setting('-t', '--test', action='store_false'), bool),
|
(9, settngs.Setting('-t', '--test', action='store_true'), bool),
|
||||||
(settngs.Setting('-t', '--test', action=settngs.BooleanOptionalAction), bool),
|
(10, settngs.Setting('-t', '--test', action='store_false'), bool),
|
||||||
(settngs.Setting('-t', '--test', action=_customAction), 'Any'),
|
(11, settngs.Setting('-t', '--test', action=settngs.BooleanOptionalAction), bool),
|
||||||
(settngs.Setting('-t', '--test', action='help'), None),
|
(12, settngs.Setting('-t', '--test', action=_customAction), 'Any'),
|
||||||
(settngs.Setting('-t', '--test', action='version'), None),
|
(13, settngs.Setting('-t', '--test', action='help'), None),
|
||||||
(settngs.Setting('-t', '--test', type=int), int),
|
(14, settngs.Setting('-t', '--test', action='version'), None),
|
||||||
(settngs.Setting('-t', '--test', type=_typed_function), test_type),
|
(15, settngs.Setting('-t', '--test', type=int), int),
|
||||||
(settngs.Setting('-t', '--test', type=_untyped_function, default=1), int),
|
(16, settngs.Setting('-t', '--test', type=_typed_function), test_type),
|
||||||
(settngs.Setting('-t', '--test', type=_untyped_function), 'Any'),
|
(17, settngs.Setting('-t', '--test', type=_untyped_function, default=1), int),
|
||||||
|
(18, settngs.Setting('-t', '--test', type=_untyped_function), 'Any'),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize('setting,typ', types)
|
@pytest.mark.parametrize('num,setting,typ', types)
|
||||||
def test_guess_type(setting, typ):
|
def test_guess_type(num, setting, typ):
|
||||||
guessed_type = setting._guess_type()
|
guessed_type = setting._guess_type()
|
||||||
assert guessed_type == typ
|
assert guessed_type == typ
|
||||||
|
|
||||||
|
|
||||||
|
expected_src = '''from __future__ import annotations
|
||||||
|
|
||||||
|
import settngs
|
||||||
|
{extra_imports}
|
||||||
|
|
||||||
|
class SettngsNS(settngs.TypedNS):
|
||||||
|
test__test: {typ}
|
||||||
|
'''
|
||||||
|
no_type_expected_src = '''from __future__ import annotations
|
||||||
|
|
||||||
|
import settngs
|
||||||
|
|
||||||
|
|
||||||
|
class SettngsNS(settngs.TypedNS):
|
||||||
|
...
|
||||||
|
'''
|
||||||
settings = (
|
settings = (
|
||||||
(lambda parser: parser.add_setting('-t', '--test'), 'str'),
|
(0, lambda parser: parser.add_setting('-t', '--test'), expected_src.format(extra_imports='', typ='str')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', cmdline=False), 'typing.Any'),
|
(1, lambda parser: parser.add_setting('-t', '--test', cmdline=False), expected_src.format(extra_imports='import typing\n', typ='typing.Any')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', default=1, file=True, cmdline=False), 'int'),
|
(2, lambda parser: parser.add_setting('-t', '--test', default=1, file=True, cmdline=False), expected_src.format(extra_imports='', typ='int')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='count'), 'int'),
|
(3, lambda parser: parser.add_setting('-t', '--test', action='count'), expected_src.format(extra_imports='', typ='int')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='append'), List[str]),
|
(4, lambda parser: parser.add_setting('-t', '--test', action='append'), expected_src.format(extra_imports='import typing\n' if sys.version_info < (3, 9) else '', typ='typing.List[str]' if sys.version_info < (3, 9) else 'list[str]')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='extend'), List[str]),
|
(5, lambda parser: parser.add_setting('-t', '--test', action='extend'), expected_src.format(extra_imports='import typing\n' if sys.version_info < (3, 9) else '', typ='typing.List[str]' if sys.version_info < (3, 9) else 'list[str]')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='store_const', const=1), 'int'),
|
(6, lambda parser: parser.add_setting('-t', '--test', nargs='+'), expected_src.format(extra_imports='import typing\n' if sys.version_info < (3, 9) else '', typ='typing.List[str]' if sys.version_info < (3, 9) else 'list[str]')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='append_const', const=1), 'list'),
|
(7, lambda parser: parser.add_setting('-t', '--test', action='store_const', const=1), expected_src.format(extra_imports='', typ='int')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='store_true'), 'bool'),
|
(8, lambda parser: parser.add_setting('-t', '--test', action='append_const', const=1), expected_src.format(extra_imports='', typ='list')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='store_false'), 'bool'),
|
(9, lambda parser: parser.add_setting('-t', '--test', action='store_true'), expected_src.format(extra_imports='', typ='bool')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action=settngs.BooleanOptionalAction), 'bool'),
|
(10, lambda parser: parser.add_setting('-t', '--test', action='store_false'), expected_src.format(extra_imports='', typ='bool')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action=_customAction), 'typing.Any'),
|
(11, lambda parser: parser.add_setting('-t', '--test', action=settngs.BooleanOptionalAction), expected_src.format(extra_imports='', typ='bool')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='help'), None),
|
(12, lambda parser: parser.add_setting('-t', '--test', action=_customAction), expected_src.format(extra_imports='import typing\n', typ='typing.Any')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', action='version'), None),
|
(13, lambda parser: parser.add_setting('-t', '--test', action='help'), no_type_expected_src),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', type=int), 'int'),
|
(14, lambda parser: parser.add_setting('-t', '--test', action='version'), no_type_expected_src),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', nargs='+'), List[str]),
|
(15, lambda parser: parser.add_setting('-t', '--test', type=int), expected_src.format(extra_imports='', typ='int')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', type=_typed_function), 'tests.settngs_test.test_type'),
|
(16, lambda parser: parser.add_setting('-t', '--test', type=_typed_function), expected_src.format(extra_imports='import tests.settngs_test\n', typ='tests.settngs_test.test_type')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', type=_untyped_function, default=1), 'int'),
|
(17, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function, default=1), expected_src.format(extra_imports='', typ='int')),
|
||||||
(lambda parser: parser.add_setting('-t', '--test', type=_untyped_function), 'typing.Any'),
|
(18, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function), expected_src.format(extra_imports='import typing\n', typ='typing.Any')),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize('set_options,typ', settings)
|
@pytest.mark.parametrize('num,set_options,expected', settings)
|
||||||
def test_generate_ns(settngs_manager, set_options, typ):
|
def test_generate_ns(settngs_manager, num, set_options, expected):
|
||||||
settngs_manager.add_group('test', set_options)
|
settngs_manager.add_group('test', set_options)
|
||||||
|
|
||||||
src = dedent('''\
|
imports, types = settngs_manager.generate_ns()
|
||||||
from __future__ import annotations
|
generated_src = '\n\n\n'.join((imports, types))
|
||||||
|
|
||||||
import settngs
|
assert generated_src == expected
|
||||||
''')
|
|
||||||
|
|
||||||
if 'typing.' in str(typ):
|
ast.parse(generated_src)
|
||||||
src += '\nimport typing'
|
|
||||||
if typ == 'tests.settngs_test.test_type':
|
|
||||||
src += '\nimport tests.settngs_test'
|
|
||||||
src += dedent('''
|
|
||||||
|
|
||||||
|
|
||||||
class settngs_namespace(settngs.TypedNS):
|
expected_src_dict = '''from __future__ import annotations
|
||||||
''')
|
|
||||||
if typ is None:
|
|
||||||
src += ' ...\n'
|
|
||||||
else:
|
|
||||||
src += f' {settngs_manager.definitions["test"].v["test"].internal_name}: {typ}\n'
|
|
||||||
|
|
||||||
generated_src = settngs_manager.generate_ns()
|
import typing
|
||||||
|
{extra_imports}
|
||||||
|
|
||||||
assert generated_src == src
|
class test(typing.TypedDict):
|
||||||
|
test: {typ}
|
||||||
|
|
||||||
|
|
||||||
|
class SettngsDict(typing.TypedDict):
|
||||||
|
test: test
|
||||||
|
'''
|
||||||
|
no_type_expected_src_dict = '''from __future__ import annotations
|
||||||
|
|
||||||
|
import typing
|
||||||
|
|
||||||
|
|
||||||
|
class test(typing.TypedDict):
|
||||||
|
...
|
||||||
|
|
||||||
|
|
||||||
|
class SettngsDict(typing.TypedDict):
|
||||||
|
test: test
|
||||||
|
'''
|
||||||
|
settings_dict = (
|
||||||
|
(0, lambda parser: parser.add_setting('-t', '--test'), expected_src_dict.format(extra_imports='', typ='str')),
|
||||||
|
(1, lambda parser: parser.add_setting('-t', '--test', cmdline=False), expected_src_dict.format(extra_imports='', typ='typing.Any')),
|
||||||
|
(2, lambda parser: parser.add_setting('-t', '--test', default=1, file=True, cmdline=False), expected_src_dict.format(extra_imports='', typ='int')),
|
||||||
|
(3, lambda parser: parser.add_setting('-t', '--test', action='count'), expected_src_dict.format(extra_imports='', typ='int')),
|
||||||
|
(4, lambda parser: parser.add_setting('-t', '--test', action='append'), expected_src_dict.format(extra_imports='' if sys.version_info < (3, 9) else '', typ='typing.List[str]' if sys.version_info < (3, 9) else 'list[str]')),
|
||||||
|
(5, lambda parser: parser.add_setting('-t', '--test', action='extend'), expected_src_dict.format(extra_imports='' if sys.version_info < (3, 9) else '', typ='typing.List[str]' if sys.version_info < (3, 9) else 'list[str]')),
|
||||||
|
(6, lambda parser: parser.add_setting('-t', '--test', nargs='+'), expected_src_dict.format(extra_imports='' if sys.version_info < (3, 9) else '', typ='typing.List[str]' if sys.version_info < (3, 9) else 'list[str]')),
|
||||||
|
(7, lambda parser: parser.add_setting('-t', '--test', action='store_const', const=1), expected_src_dict.format(extra_imports='', typ='int')),
|
||||||
|
(8, lambda parser: parser.add_setting('-t', '--test', action='append_const', const=1), expected_src_dict.format(extra_imports='', typ='list')),
|
||||||
|
(9, lambda parser: parser.add_setting('-t', '--test', action='store_true'), expected_src_dict.format(extra_imports='', typ='bool')),
|
||||||
|
(10, lambda parser: parser.add_setting('-t', '--test', action='store_false'), expected_src_dict.format(extra_imports='', typ='bool')),
|
||||||
|
(11, lambda parser: parser.add_setting('-t', '--test', action=settngs.BooleanOptionalAction), expected_src_dict.format(extra_imports='', typ='bool')),
|
||||||
|
(12, lambda parser: parser.add_setting('-t', '--test', action=_customAction), expected_src_dict.format(extra_imports='', typ='typing.Any')),
|
||||||
|
(13, lambda parser: parser.add_setting('-t', '--test', action='help'), no_type_expected_src_dict),
|
||||||
|
(14, lambda parser: parser.add_setting('-t', '--test', action='version'), no_type_expected_src_dict),
|
||||||
|
(15, lambda parser: parser.add_setting('-t', '--test', type=int), expected_src_dict.format(extra_imports='', typ='int')),
|
||||||
|
(16, lambda parser: parser.add_setting('-t', '--test', type=_typed_function), expected_src_dict.format(extra_imports='import tests.settngs_test\n', typ='tests.settngs_test.test_type')),
|
||||||
|
(17, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function, default=1), expected_src_dict.format(extra_imports='', typ='int')),
|
||||||
|
(18, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function), expected_src_dict.format(extra_imports='', typ='typing.Any')),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize('num,set_options,expected', settings_dict)
|
||||||
|
def test_generate_dict(settngs_manager, num, set_options, expected):
|
||||||
|
settngs_manager.add_group('test', set_options)
|
||||||
|
|
||||||
|
imports, types = settngs_manager.generate_dict()
|
||||||
|
generated_src = '\n\n\n'.join((imports, types))
|
||||||
|
|
||||||
|
assert generated_src == expected
|
||||||
|
|
||||||
ast.parse(generated_src)
|
ast.parse(generated_src)
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user