lordwelch/settngs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Set optional None types

Browse Source
This commit is contained in:
Timmy Welch 2024-05-18 13:03:50 -07:00
parent 709aec31f0
commit eca7be0c51
2 changed files with 80 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
settngs/__init__.py
View File

@ -208,57 +208,60 @@ class Setting:
return NotImplemented return NotImplemented
return self.__dict__ == other.__dict__ return self.__dict__ == other.__dict__
def _guess_type(self) -> type | str | None: def _guess_type(self) -> tuple[type | str | None, bool]:
if self.type is None and self.action is None: if self.type is None and self.action is None:
if self.cmdline: if self.cmdline:
if self.nargs in ('+', '*') or isinstance(self.nargs, int) and self.nargs > 1: if self.nargs in ('+', '*') or isinstance(self.nargs, int) and self.nargs > 1:
return List[str] return List[str], self.default is None
return str return str, self.default is None
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]: if not isinstance(self.default, str) and not _isnamedtupleinstance(self.default) and isinstance(self.default, Sequence) and self.default and self.default[0]:
try: try:
return cast(type, type(self.default)[type(self.default[0])]) return cast(type, type(self.default)[type(self.default[0])]), self.default is None
except Exception: except Exception:
... ...
return type(self.default) return type(self.default), self.default is None
return 'Any' return 'Any', self.default is None
if isinstance(self.type, type): if isinstance(self.type, type):
return self.type return self.type, self.default is None
if self.type is not None: if self.type is not None:
type_hints = typing.get_type_hints(self.type) type_hints = typing.get_type_hints(self.type)
if 'return' in type_hints: if 'return' in type_hints:
t: type | str = type_hints['return'] t: type | str = type_hints['return']
return t return t, self.default is None
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]: if not isinstance(self.default, str) and not _isnamedtupleinstance(self.default) and isinstance(self.default, Sequence) and self.default and self.default[0]:
try: try:
return cast(type, type(self.default)[type(self.default[0])]) return cast(type, type(self.default)[type(self.default[0])]), self.default is None
except Exception: except Exception:
... ...
return type(self.default) return type(self.default), self.default is None
return 'Any' return 'Any', self.default is None
if self.action in ('store_true', 'store_false', BooleanOptionalAction): if self.action in ('store_true', 'store_false'):
return bool return bool, False
if self.action == BooleanOptionalAction:
return bool, self.default is None
if self.action in ('store_const',): if self.action in ('store_const',):
return type(self.const) return type(self.const), self.default is None
if self.action in ('count',): if self.action in ('count',):
return int return int, self.default is None
if self.action in ('append', 'extend'): if self.action in ('append', 'extend'):
return List[str] return List[str], self.default is None
if self.action in ('append_const',): if self.action in ('append_const',):
return list # list[type(self.const)] return list, self.default is None # list[type(self.const)]
if self.action in ('help', 'version'): if self.action in ('help', 'version'):
return None return None, self.default is None
return 'Any' return 'Any', self.default is None
def get_dest(self, prefix: str, names: Sequence[str], dest: str | None) -> tuple[str, str, str, bool]: def get_dest(self, prefix: str, names: Sequence[str], dest: str | None) -> tuple[str, str, str, bool]:
setting_name = None setting_name = None
@ -326,7 +329,7 @@ def generate_ns(definitions: Definitions) -> tuple[str, str]:
attributes = [] attributes = []
for group in definitions.values(): for group in definitions.values():
for setting in group.v.values(): for setting in group.v.values():
t = setting._guess_type() t, no_default = setting._guess_type()
if t is None: if t is None:
continue continue
# Default to any # Default to any
@ -351,6 +354,9 @@ def generate_ns(definitions: Definitions) -> tuple[str, str]:
if type_name == 'Any': if type_name == 'Any':
type_name = 'typing.Any' type_name = 'typing.Any'
if no_default and type_name not in ('typing.Any', 'None'):
attribute = f' {setting.internal_name}: {type_name} | None'
else:
attribute = f' {setting.internal_name}: {type_name}' attribute = f' {setting.internal_name}: {type_name}'
if attribute not in attributes: if attribute not in attributes:
attributes.append(attribute) attributes.append(attribute)
@ -385,7 +391,7 @@ def generate_dict(definitions: Definitions) -> tuple[str, str]:
for group_name, group in definitions.items(): for group_name, group in definitions.items():
attributes = [] attributes = []
for setting in group.v.values(): for setting in group.v.values():
t = setting._guess_type() t, no_default = setting._guess_type()
if t is None: if t is None:
continue continue
# Default to any # Default to any
@ -410,6 +416,9 @@ def generate_dict(definitions: Definitions) -> tuple[str, str]:
if type_name == 'Any': if type_name == 'Any':
type_name = 'typing.Any' type_name = 'typing.Any'
if no_default and type_name not in ('typing.Any', 'None'):
attribute = f' {setting.dest}: {type_name} | None'
else:
attribute = f' {setting.dest}: {type_name}' attribute = f' {setting.dest}: {type_name}'
if attribute not in attributes: if attribute not in attributes:
attributes.append(attribute) attributes.append(attribute)

94
tests/settngs_test.py
View File

@ -649,32 +649,34 @@ class _customAction(argparse.Action): # pragma: no cover
types = ( types = (
(0, settngs.Setting('-t', '--test'), str), (0, settngs.Setting('-t', '--test'), str, True),
(1, settngs.Setting('-t', '--test', cmdline=False), 'Any'), (1, settngs.Setting('-t', '--test', cmdline=False), 'Any', True),
(2, settngs.Setting('-t', '--test', default=1, file=True, cmdline=False), int), (2, settngs.Setting('-t', '--test', default=1, file=True, cmdline=False), int, False),
(3, settngs.Setting('-t', '--test', action='count'), int), (3, settngs.Setting('-t', '--test', action='count'), int, True),
(4, settngs.Setting('-t', '--test', action='append'), List[str]), (4, settngs.Setting('-t', '--test', action='append'), List[str], True),
(5, settngs.Setting('-t', '--test', action='extend'), List[str]), (5, settngs.Setting('-t', '--test', action='extend'), List[str], True),
(6, settngs.Setting('-t', '--test', nargs='+'), List[str]), (6, settngs.Setting('-t', '--test', nargs='+'), List[str], True),
(7, settngs.Setting('-t', '--test', action='store_const', const=1), int), (7, settngs.Setting('-t', '--test', action='store_const', const=1), int, True),
(8, settngs.Setting('-t', '--test', action='append_const', const=1), list), (8, settngs.Setting('-t', '--test', action='append_const', const=1), list, True),
(9, settngs.Setting('-t', '--test', action='store_true'), bool), (9, settngs.Setting('-t', '--test', action='store_true'), bool, True),
(10, settngs.Setting('-t', '--test', action='store_false'), bool), (10, settngs.Setting('-t', '--test', action='store_false'), bool, True),
(11, settngs.Setting('-t', '--test', action=settngs.BooleanOptionalAction), bool), (11, settngs.Setting('-t', '--test', action=settngs.BooleanOptionalAction), bool, True),
(12, settngs.Setting('-t', '--test', action=_customAction), 'Any'), (12, settngs.Setting('-t', '--test', action=_customAction), 'Any', True),
(13, settngs.Setting('-t', '--test', action='help'), None), (13, settngs.Setting('-t', '--test', action='help'), None, True),
(14, settngs.Setting('-t', '--test', action='version'), None), (14, settngs.Setting('-t', '--test', action='version'), None, True),
(15, settngs.Setting('-t', '--test', type=int), int), (15, settngs.Setting('-t', '--test', type=int), int, True),
(16, settngs.Setting('-t', '--test', type=_typed_function), test_type), (16, settngs.Setting('-t', '--test', type=_typed_function), test_type, True),
(17, settngs.Setting('-t', '--test', type=_untyped_function, default=1), int), (17, settngs.Setting('-t', '--test', type=_untyped_function, default=1), int, False),
(18, settngs.Setting('-t', '--test', type=_untyped_function), 'Any'), (18, settngs.Setting('-t', '--test', type=_untyped_function), 'Any', True),
) )
@pytest.mark.parametrize('num,setting,typ', types) @pytest.mark.parametrize('num,setting,typ,no_default_expected', types)
def test_guess_type(num, setting, typ): def test_guess_type(num, setting, typ, no_default_expected):
guessed_type = setting._guess_type() x = setting._guess_type()
guessed_type, no_default = x
assert guessed_type == typ assert guessed_type == typ
assert no_default == no_default_expected
expected_src = '''from __future__ import annotations expected_src = '''from __future__ import annotations
@ -694,23 +696,23 @@ class SettngsNS(settngs.TypedNS):
... ...
''' '''
settings = ( settings = (
(0, lambda parser: parser.add_setting('-t', '--test'), expected_src.format(extra_imports='', typ='str')), (0, lambda parser: parser.add_setting('-t', '--test'), expected_src.format(extra_imports='', typ='str | None')),
(1, lambda parser: parser.add_setting('-t', '--test', cmdline=False), expected_src.format(extra_imports='import typing\n', typ='typing.Any')), (1, lambda parser: parser.add_setting('-t', '--test', cmdline=False), expected_src.format(extra_imports='import typing\n', typ='typing.Any')),
(2, lambda parser: parser.add_setting('-t', '--test', default=1, file=True, cmdline=False), expected_src.format(extra_imports='', typ='int')), (2, lambda parser: parser.add_setting('-t', '--test', default=1, file=True, cmdline=False), expected_src.format(extra_imports='', typ='int')),
(3, lambda parser: parser.add_setting('-t', '--test', action='count'), expected_src.format(extra_imports='', typ='int')), (3, lambda parser: parser.add_setting('-t', '--test', action='count'), expected_src.format(extra_imports='', typ='int | None')),
(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]')), (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] | None' if sys.version_info < (3, 9) else 'list[str] | None')),
(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]')), (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] | None' if sys.version_info < (3, 9) else 'list[str] | None')),
(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]')), (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] | None' if sys.version_info < (3, 9) else 'list[str] | None')),
(7, lambda parser: parser.add_setting('-t', '--test', action='store_const', const=1), expected_src.format(extra_imports='', typ='int')), (7, lambda parser: parser.add_setting('-t', '--test', action='store_const', const=1), expected_src.format(extra_imports='', typ='int | None')),
(8, lambda parser: parser.add_setting('-t', '--test', action='append_const', const=1), expected_src.format(extra_imports='', typ='list')), (8, lambda parser: parser.add_setting('-t', '--test', action='append_const', const=1), expected_src.format(extra_imports='', typ='list | None')),
(9, lambda parser: parser.add_setting('-t', '--test', action='store_true'), expected_src.format(extra_imports='', typ='bool')), (9, lambda parser: parser.add_setting('-t', '--test', action='store_true'), expected_src.format(extra_imports='', typ='bool | None')),
(10, lambda parser: parser.add_setting('-t', '--test', action='store_false'), expected_src.format(extra_imports='', typ='bool')), (10, lambda parser: parser.add_setting('-t', '--test', action='store_false'), expected_src.format(extra_imports='', typ='bool | None')),
(11, lambda parser: parser.add_setting('-t', '--test', action=settngs.BooleanOptionalAction), expected_src.format(extra_imports='', typ='bool')), (11, lambda parser: parser.add_setting('-t', '--test', action=settngs.BooleanOptionalAction), expected_src.format(extra_imports='', typ='bool | None')),
(12, lambda parser: parser.add_setting('-t', '--test', action=_customAction), expected_src.format(extra_imports='import typing\n', typ='typing.Any')), (12, lambda parser: parser.add_setting('-t', '--test', action=_customAction), expected_src.format(extra_imports='import typing\n', typ='typing.Any')),
(13, lambda parser: parser.add_setting('-t', '--test', action='help'), no_type_expected_src), (13, lambda parser: parser.add_setting('-t', '--test', action='help'), no_type_expected_src),
(14, lambda parser: parser.add_setting('-t', '--test', action='version'), no_type_expected_src), (14, lambda parser: parser.add_setting('-t', '--test', action='version'), no_type_expected_src),
(15, lambda parser: parser.add_setting('-t', '--test', type=int), expected_src.format(extra_imports='', typ='int')), (15, lambda parser: parser.add_setting('-t', '--test', type=int), expected_src.format(extra_imports='', typ='int | None')),
(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')), (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 | None')),
(17, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function, default=1), expected_src.format(extra_imports='', typ='int')), (17, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function, default=1), expected_src.format(extra_imports='', typ='int')),
(18, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function), expected_src.format(extra_imports='import typing\n', typ='typing.Any')), (18, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function), expected_src.format(extra_imports='import typing\n', typ='typing.Any')),
) )
@ -753,23 +755,23 @@ class SettngsDict(typing.TypedDict):
test: test test: test
''' '''
settings_dict = ( settings_dict = (
(0, lambda parser: parser.add_setting('-t', '--test'), expected_src_dict.format(extra_imports='', typ='str')), (0, lambda parser: parser.add_setting('-t', '--test'), expected_src_dict.format(extra_imports='', typ='str | None')),
(1, lambda parser: parser.add_setting('-t', '--test', cmdline=False), expected_src_dict.format(extra_imports='', typ='typing.Any')), (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')), (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')), (3, lambda parser: parser.add_setting('-t', '--test', action='count'), expected_src_dict.format(extra_imports='', typ='int | None')),
(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]')), (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] | None' if sys.version_info < (3, 9) else 'list[str] | None')),
(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]')), (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] | None' if sys.version_info < (3, 9) else 'list[str] | None')),
(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]')), (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] | None' if sys.version_info < (3, 9) else 'list[str] | None')),
(7, lambda parser: parser.add_setting('-t', '--test', action='store_const', const=1), expected_src_dict.format(extra_imports='', typ='int')), (7, lambda parser: parser.add_setting('-t', '--test', action='store_const', const=1), expected_src_dict.format(extra_imports='', typ='int | None')),
(8, lambda parser: parser.add_setting('-t', '--test', action='append_const', const=1), expected_src_dict.format(extra_imports='', typ='list')), (8, lambda parser: parser.add_setting('-t', '--test', action='append_const', const=1), expected_src_dict.format(extra_imports='', typ='list | None')),
(9, lambda parser: parser.add_setting('-t', '--test', action='store_true'), expected_src_dict.format(extra_imports='', typ='bool')), (9, lambda parser: parser.add_setting('-t', '--test', action='store_true'), expected_src_dict.format(extra_imports='', typ='bool | None')),
(10, lambda parser: parser.add_setting('-t', '--test', action='store_false'), 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 | None')),
(11, lambda parser: parser.add_setting('-t', '--test', action=settngs.BooleanOptionalAction), 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 | None')),
(12, lambda parser: parser.add_setting('-t', '--test', action=_customAction), expected_src_dict.format(extra_imports='', typ='typing.Any')), (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), (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), (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')), (15, lambda parser: parser.add_setting('-t', '--test', type=int), expected_src_dict.format(extra_imports='', typ='int | None')),
(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')), (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 | None')),
(17, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function, default=1), expected_src_dict.format(extra_imports='', typ='int')), (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')), (18, lambda parser: parser.add_setting('-t', '--test', type=_untyped_function), expected_src_dict.format(extra_imports='', typ='typing.Any')),
) )