Skip to content

Commit 9139dcd

Browse files
committed
Correct parser types and list defaults
Signed-off-by: Tim Paine <3105306+timkpaine@users.noreply.github.com>
1 parent f90ca8e commit 9139dcd

3 files changed

Lines changed: 28 additions & 15 deletions

File tree

‎Makefile‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@ lint-py: ## lint python with ruff
2525
python -m ruff format --check p2a
2626

2727
lint-docs: ## lint docs with mdformat and codespell
28-
python -m mdformat --check README.md $(wildcard docs/src)
29-
python -m codespell_lib README.md $(wildcard docs/src)
28+
python -m mdformat --check README.md $(wildcard docs/src)
29+
python -m codespell_lib README.md $(wildcard docs/src)
3030

3131
fix-py: ## autoformat python code with ruff
3232
python -m ruff check --fix p2a
3333
python -m ruff format p2a
3434

3535
fix-docs: ## autoformat docs with mdformat and codespell
36-
python -m mdformat README.md $(wildcard docs/src)
37-
python -m codespell_lib --write README.md $(wildcard docs/src)
36+
python -m mdformat README.md $(wildcard docs/src)
37+
python -m codespell_lib --write README.md $(wildcard docs/src)
3838

3939
lint: lint-py lint-docs ## run all linters
4040
lints: lint

‎p2a/model.py‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
import sys
22
from argparse import ArgumentParser
33
from enum import Enum
4+
from logging import Logger
45
from pathlib import Path
56
from types import UnionType
6-
from typing import Literal, Union, get_args, get_origin
7+
from typing import Any, Literal, TypeVar, Union, cast, get_args, get_origin
78

89
from pkn.logging import getSimpleLogger
910

@@ -18,7 +19,8 @@
1819
"parse_extra_args_model",
1920
)
2021

21-
_log = None
22+
_log: Logger
23+
ModelT = TypeVar("ModelT", bound=BaseModel)
2224

2325

2426
def _initlog(level: str = "WARNING"):
@@ -38,7 +40,7 @@ def _add_argument(parser: ArgumentParser, name: str, arg_type: type, default_val
3840
parser.add_argument(name, type=arg_type, default=default_value, **kwargs)
3941

4042

41-
def parse_extra_args(subparser: ArgumentParser | None = None, argv: list[str] | None = None) -> list[str]:
43+
def parse_extra_args(subparser: ArgumentParser | None = None, argv: list[str] | None = None) -> tuple[dict[str, Any], list[str]]:
4244
if subparser is None:
4345
subparser = ArgumentParser(prog="p2a", allow_abbrev=False)
4446

@@ -126,7 +128,7 @@ def _recurse_add_fields(parser: ArgumentParser, model: Union["BaseModel", type["
126128
########################
127129
# MARK: str, int, float
128130
try:
129-
_add_argument(parser=parser, name=arg_name, arg_type=field_type, default_value=default_value)
131+
_add_argument(parser=parser, name=arg_name, arg_type=cast(type, field_type), default_value=default_value)
130132
except TypeError:
131133
# TODO: handle more complex types if needed
132134
_add_argument(parser=parser, name=arg_name, arg_type=str, default_value=default_value)
@@ -200,7 +202,10 @@ def _recurse_add_fields(parser: ArgumentParser, model: Union["BaseModel", type["
200202
#################################
201203
# MARK: List[str|int|float|bool]
202204
_add_argument(
203-
parser=parser, name=arg_name, arg_type=str, default_value=",".join(map(str, default_value)) if isinstance(field, str) else None
205+
parser=parser,
206+
name=arg_name,
207+
arg_type=str,
208+
default_value=",".join(map(str, default_value)) if isinstance(default_value, list) else None,
204209
)
205210
elif get_origin(field_type) in (dict, dict):
206211
######################
@@ -319,7 +324,7 @@ def create_model_parser(model: "BaseModel") -> ArgumentParser:
319324
return parser
320325

321326

322-
def parse_extra_args_model(model: "BaseModel", argv: list[str] | None = None) -> Union["BaseModel", dict]:
327+
def parse_extra_args_model(model: ModelT, argv: list[str] | None = None) -> tuple[ModelT, list[str]]:
323328
# Parse the extra args and update the model
324329
args, kwargs = parse_extra_args(create_model_parser(model), argv)
325330

@@ -330,8 +335,8 @@ def parse_extra_args_model(model: "BaseModel", argv: list[str] | None = None) ->
330335
parts = key.split(".")
331336

332337
# Accounting
333-
sub_model = model
334-
parent_model = None
338+
sub_model: Any = model
339+
parent_model: Any = None
335340

336341
for i, part in enumerate(parts[:-1]):
337342
if part.isdigit() and isinstance(sub_model, list):
@@ -457,7 +462,7 @@ def parse_extra_args_model(model: "BaseModel", argv: list[str] | None = None) ->
457462

458463
# Grab the field from the model class and make a type adapter
459464
field = model_to_set.__class__.model_fields[key]
460-
adapter = TypeAdapter(field.annotation)
465+
adapter = TypeAdapter(cast(Any, field.annotation))
461466

462467
if value is not None:
463468
_log.debug(f"Setting field '{key}' on model '{model_to_set.__class__.__name__}' with raw value '{value}'")

‎p2a/tests/test_model.py‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
from pydantic import BaseModel
99

10-
from p2a import parse_extra_args_model
10+
from p2a import create_model_parser, parse_extra_args_model
1111
from p2a.model import _initlog
1212

1313

@@ -46,7 +46,7 @@ class MyTopLevelModel(BaseModel, validate_assignment=True):
4646
dict_enum_key_model_value: dict[MyEnum, SubModel] = {MyEnum.OPTION_A: SubModel()}
4747

4848
submodel: SubModel
49-
submodel2: SubModel = SubModel(sub_args=84, sub_arg_with_value="predefined", sub_arg_enum=MyEnum.OPTION_B, sub_arg_literal="z")
49+
submodel2: SubModel = SubModel(sub_arg=84, sub_arg_with_value="predefined", sub_arg_enum=MyEnum.OPTION_B, sub_arg_literal="z")
5050
submodel3: SubModel | None = None
5151

5252
submodel_list_instanced: list[SubModel] = [SubModel()]
@@ -62,6 +62,13 @@ class MyTopLevelModel(BaseModel, validate_assignment=True):
6262

6363

6464
class TestCLIMdel:
65+
def test_list_default(self):
66+
class Model(BaseModel):
67+
values: list[int] = [1, 2, 3]
68+
69+
parser = create_model_parser(Model())
70+
assert parser.parse_args([]).values == "1,2,3"
71+
6572
def test_get_arg_from_model(self):
6673
with (
6774
patch.object(
@@ -164,6 +171,7 @@ def test_get_arg_from_model(self):
164171
assert model.submodel2.sub_arg_enum == MyEnum.OPTION_B
165172
assert model.submodel2.sub_arg_literal == "z"
166173

174+
assert model.submodel3 is not None
167175
assert model.submodel3.sub_arg == 300
168176
assert model.submodel_list_instanced[0].sub_arg == 400
169177
assert model.submodel_list_instanced[0].sub_arg_with_value == "list_value"

0 commit comments

Comments
 (0)