1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
|
import json
from dataclasses import dataclass
from datetime import datetime
from textwrap import dedent
from typing import Annotated, Dict, Literal, Optional, Union
import pydantic
import pytest
from pydantic import BaseModel, ConfigDict, Field, PositiveInt, validate_call
from pydantic import ValidationError as PydanticValidationError
from pydantic.alias_generators import to_camel
from cyclopts import MissingArgumentError, Parameter, ValidationError
# Modified from https://docs.pydantic.dev/latest/#pydantic-examples
class Outfit(BaseModel):
body: str
head: str
has_socks: bool
class User(BaseModel):
id: PositiveInt
name: str = Field(default="John Doe")
signup_ts: Union[datetime, None]
tastes: Dict[str, PositiveInt]
outfit: Optional[Outfit] = None
def test_pydantic_error_msg(app, console):
@app.command
@validate_call
def foo(value: PositiveInt):
print(value)
assert app["foo"].default_command == foo
# foo(1)
with pytest.raises(PydanticValidationError):
foo(-1)
with console.capture() as capture, pytest.raises(ValidationError):
app(["foo", "-1"], console=console, exit_on_error=False, print_error=True)
actual = capture.get()
expected_prefix = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Invalid value "-1" for "VALUE". 1 validation error for │
│ constrained-int │
│ Input should be greater than 0 [type=greater_than, │
│ input_value=-1, input_type=int] │
│ For further information visit │
"""
)
assert actual.startswith(expected_prefix)
def test_pydantic_error_from_function_body(app):
@app.command
def foo(value: int):
# id=-1 is not a valid PositiveError
User(id=-1, signup_ts=None, tastes={})
with pytest.raises(PydanticValidationError):
app(["foo", "-1"])
def test_bind_pydantic_basemodel(app, assert_parse_args):
@app.command
def foo(user: User):
pass
external_data = {
"id": 123,
"signup_ts": "2019-06-01 12:22",
"tastes": {
"wine": 9,
b"cheese": 7,
"cabbage": "1",
},
"outfit": {
"body": "t-shirt",
"head": "baseball-cap",
"has_socks": True,
},
}
assert_parse_args(
foo,
'foo --user.id=123 --user.signup-ts="2019-06-01 12:22" --user.tastes.wine=9 --user.tastes.cheese=7 --user.tastes.cabbage=1 --user.outfit.body=t-shirt --user.outfit.head=baseball-cap --user.outfit.has-socks',
User(**external_data),
)
def test_bind_pydantic_basemodel_from_json(app, assert_parse_args, monkeypatch):
@app.command
def foo(user: Annotated[User, Parameter(env_var="USER")]):
pass
external_data = {
"id": 123,
"signup_ts": "2019-06-01 12:22",
"tastes": {
"wine": 9,
"cheese": 7,
"cabbage": "1",
},
"outfit": {
"body": "t-shirt",
"head": "baseball-cap",
"has_socks": True,
},
}
monkeypatch.setenv("USER", json.dumps(external_data))
assert_parse_args(
foo,
'foo --user.id=123 --user.signup-ts="2019-06-01 12:22" --user.tastes.wine=9 --user.tastes.cheese=7 --user.tastes.cabbage=1 --user.outfit.body=t-shirt --user.outfit.head=baseball-cap --user.outfit.has-socks',
User(**external_data),
)
def test_bind_pydantic_basemodel_help(app, console):
@app.default
def foo(user: User):
pass
with console.capture() as capture:
app("--help", console=console)
actual = capture.get()
expected = dedent(
"""\
Usage: foo COMMAND [ARGS] [OPTIONS]
╭─ Commands ─────────────────────────────────────────────────────────╮
│ --help -h Display this message and exit. │
│ --version Display application version. │
╰────────────────────────────────────────────────────────────────────╯
╭─ Parameters ───────────────────────────────────────────────────────╮
│ * USER.ID --user.id [required] │
│ USER.NAME --user.name [default: John Doe] │
│ * USER.SIGNUP-TS [required] │
│ --user.signup-ts │
│ * --user.tastes [required] │
│ --user.outfit.body │
│ --user.outfit.head │
│ --user.outfit.has-socks - │
│ -user.outfit.no-has-soc │
│ ks │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_bind_pydantic_basemodel_missing_arg(app, console):
"""Partially defining an Outfit should raise a MissingArgumentError."""
@app.command
def foo(user: User):
pass
with console.capture() as capture, pytest.raises(MissingArgumentError):
app.parse_args(
'foo --user.id=123 --user.signup-ts="2019-06-01 12:22" --user.tastes.wine=9 --user.tastes.cheese=7 --user.tastes.cabbage=1 --user.outfit.body=t-shirt',
console=console,
exit_on_error=False,
)
actual = capture.get()
expected = dedent(
"""\
╭─ Error ────────────────────────────────────────────────────────────╮
│ Command "foo" parameter "--user.outfit.head" requires an argument. │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_pydantic_alias_1(app, console, assert_parse_args):
class User(BaseModel):
model_config = ConfigDict(
# A callable that takes a field name and returns an alias for it.
alias_generator=to_camel,
# Whether an aliased field may be populated by its name as given by the model attribute, as well as the alias.
# e.g. for this model, both "user_name=" and "userName=" should work.
populate_by_name=True,
# Whether to build models and look up discriminators of tagged unions using python object attributes.
from_attributes=True,
)
user_name: str
"Name of user."
age_in_years: int
"Age of user in years."
@app.command
def foo(user: User):
pass
with console.capture() as capture:
app("foo --help", console=console)
actual = capture.get()
expected = dedent(
"""\
Usage: test_pydantic foo [ARGS] [OPTIONS]
╭─ Parameters ───────────────────────────────────────────────────────╮
│ * USER.USER-NAME Name of user. [required] │
│ --user.user-name │
│ --user.username │
│ * USER.AGE-IN-YEARS Age of user in years. [required] │
│ --user.age-in-years │
│ --user.ageinyears │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
assert_parse_args(
foo,
"foo --user.username='Bob Smith' --user.age_in_years=100",
user=User(user_name="Bob Smith", age_in_years=100),
)
@pytest.mark.parametrize(
"env_var",
[
'{"storage_class": "longhorn"}',
'{"storageclass": "longhorn"}',
# check for incorrectly parsing "null" as a string
'{"storage_class": "longhorn", "limit": null}',
],
)
def test_pydantic_alias_env_var_json(app, assert_parse_args, monkeypatch, env_var):
"""
https://github.com/BrianPugh/cyclopts/issues/332
"""
monkeypatch.setenv("SPEC", env_var)
class BaseK8sModel(BaseModel):
model_config = ConfigDict(
alias_generator=to_camel,
populate_by_name=True,
from_attributes=True,
)
class Spec(BaseK8sModel):
storage_class: str
limit: Optional[int] = None
@app.default
def run(spec: Annotated[Spec, Parameter(env_var="SPEC")]) -> None:
pass
assert_parse_args(run, "", Spec(storage_class="longhorn"))
def test_parameter_decorator_pydantic_nested_1(app, console):
"""
https://github.com/BrianPugh/cyclopts/issues/320
See Also
--------
test_parameter_decorator_dataclass_nested_1
"""
class S3Path(BaseModel):
bucket: Annotated[str, Parameter()]
key: str
@Parameter(name="*") # Flatten namespace.
class S3CliParams(BaseModel):
path: Annotated[S3Path, Parameter(name="*")]
region: Annotated[str, Parameter(name="area")]
@app.command
def action(*, s3_path: S3CliParams):
pass
with console.capture() as capture:
app("action --help", console=console)
actual = capture.get()
expected = dedent(
"""\
Usage: test_pydantic action [OPTIONS]
╭─ Parameters ───────────────────────────────────────────────────────╮
│ * --bucket [required] │
│ * --key [required] │
│ * --area [required] │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
def test_pydantic_field_description(app, console):
"""Test that pydantic Field.description is used for help text."""
class UserModel(BaseModel):
# Simple case - Field.description should be used
name: str = Field(description="User name.")
# Parameter(help=...) takes precedence over Field
name_with_param: Annotated[
str,
Parameter(help="User name with Parameter help."),
] = "Jane Doe"
# Field description in Annotated should be used
name_with_field_in_annotated: Annotated[
str,
Field(description="Description from Field in Annotated."),
] = "John Doe"
# Another simple case
age: int = Field(description="User age in years.")
@app.default
def main(user: UserModel):
pass
with console.capture() as capture:
app("--help", console=console)
actual = capture.get()
# Debugging output removed to avoid cluttering test outputs
# If needed, use: logging.debug(f"Actual help content: {actual}")
# Verify that Field.description is used for help text
assert "User name." in actual
# Verify that Parameter(help=...) takes precedence
assert "User name with Parameter help." in actual
# Verify that Field.description is used from Annotated as well
assert "Description from Field in Annotated." in actual
# Verify the other description is present
assert "User age in years." in actual
def test_pydantic_annotated_field_discriminator(app, assert_parse_args, console):
"""From https://github.com/BrianPugh/cyclopts/issues/377"""
class DatasetImage(pydantic.BaseModel):
type: Literal["image"] = "image"
path: str
resolution: tuple[int, int]
class DatasetVideo(pydantic.BaseModel):
type: Literal["video"] = "video"
path: str
resolution: tuple[int, int]
fps: int
Dataset = Annotated[Union[DatasetImage, DatasetVideo], pydantic.Field(discriminator="type")]
@dataclass
class Config:
dataset: Dataset # pyright: ignore[reportInvalidTypeForm]
@app.default
def main(
config: Annotated[Optional[Config], Parameter(name="*")] = None,
):
pass
assert_parse_args(
main,
"--dataset.type=image --dataset.path foo.png --dataset.resolution 640 480",
Config(DatasetImage(path="foo.png", resolution=(640, 480))),
)
assert_parse_args(
main,
"--dataset.type=video --dataset.path foo.mp4 --dataset.resolution 640 480 --dataset.fps 30",
Config(DatasetVideo(path="foo.mp4", resolution=(640, 480), fps=30)),
)
with console.capture() as capture:
app("--help", console=console)
actual = capture.get()
expected = dedent(
"""\
Usage: main COMMAND [ARGS] [OPTIONS]
╭─ Commands ─────────────────────────────────────────────────────────╮
│ --help -h Display this message and exit. │
│ --version Display application version. │
╰────────────────────────────────────────────────────────────────────╯
╭─ Parameters ───────────────────────────────────────────────────────╮
│ DATASET.TYPE [choices: image, video] │
│ --dataset.type │
│ DATASET.PATH │
│ --dataset.path │
│ DATASET.RESOLUTION │
│ --dataset.resolution -- │
│ dataset.empty-resolutio │
│ n │
│ DATASET.FPS --dataset.fps │
╰────────────────────────────────────────────────────────────────────╯
"""
)
assert actual == expected
@pytest.mark.parametrize(
"dataclass_decorator",
[
dataclass,
pydantic.dataclasses.dataclass,
],
)
def test_pydantic_annotated_field_discriminator_dataclass(app, assert_parse_args, dataclass_decorator):
"""Pydantic discriminator should work, even if the union'd types are not pydantic.BaseModel."""
@dataclass_decorator
class DatasetImage:
type: Literal["image"]
path: str
resolution: tuple[int, int]
@dataclass_decorator
class DatasetVideo:
type: Literal["video"]
path: str
resolution: tuple[int, int]
fps: int
Dataset = Annotated[Union[DatasetImage, DatasetVideo], pydantic.Field(discriminator="type")]
@dataclass_decorator
class Config:
dataset: Dataset # pyright: ignore[reportInvalidTypeForm]
@app.default
def main(
config: Annotated[Optional[Config], Parameter(name="*")] = None,
):
pass
assert_parse_args(
main,
"--dataset.type=image --dataset.path foo.png --dataset.resolution 640 480",
Config(DatasetImage(type="image", path="foo.png", resolution=(640, 480))), # pyright: ignore
)
assert_parse_args(
main,
"--dataset.type=video --dataset.path foo.mp4 --dataset.resolution 640 480 --dataset.fps 30",
Config(DatasetVideo(type="video", path="foo.mp4", resolution=(640, 480), fps=30)), # pyright: ignore
)
|