pydantic-settings 2.14.2: pydantic_settings.CliSettingsSource

Clean-room public code sample — generation instructions

Write a brand-new, minimal, self-contained code sample in this clean-room directory.
Do not copy, paraphrase, or reference any existing project source. Work only from this spec.

A csx.json manifest scaffold already exists. Do not recreate it from memory. Preserve its case.goal, packages and symbols; fill its empty case.contract with exact assertions and correct its environment, commands and verifierAdapter for the files you generate.

Goal: verify pydantic_settings.CliSettingsSource in pkg:pypi/pydantic-settings@2.14.2
Kind: HOW

Use EXACTLY these public packages and versions:
  - pkg:pypi/pydantic-settings@2.14.2
Demonstrate these symbols/APIs:
  - pydantic_settings.CliSettingsSource

Rules:
  - One focused purpose; the smallest project that proves the goal.
  - Include a contract test (test/contract.*) that runs OFFLINE and exits 0 exactly when the goal behavior works.
  - Pin every dependency with a lockfile so resolution is reproducible.
  - No secrets, credentials, or tokens. No real URLs (only example.com or localhost). No absolute paths.
  - No personal names, emails, company names, or project identifiers of any kind.
  - No binaries and no generated output (node_modules, dist, target, venv, .git, .env).
  - Keep it under 200 files and 256KB packed.

{"case":{"caseId":"case:sha256:dc7b3c800571b4572aead2f8932bd133d097b940225cda008edf6eb19e95204d","contract":["CliSettingsSource parses command line arguments into settings fields","CliSettingsSource with cli_kebab_case parses kebab-case argument flags","CliSettingsSource with cli_shortcuts maps short option flags to settings fields","CliSettingsSource with cli_ignore_unknown_args ignores unrecognized CLI arguments"],"goal":"verify pydantic_settings.CliSettingsSource in pkg:pypi/pydantic-settings@2.14.2","kind":"HOW","packages":["pkg:pypi/pydantic-settings@2.14.2"],"schemaVersion":1,"symbols":["pydantic_settings.CliSettingsSource"]},"contractCommand":["python","test/contract.py"],"environment":{"arch":"x64","distro":"ubuntu","ecosystem":"pypi","libc":"glibc","libcVersion":"2.39","os":"linux","osVersionBucket":"24","packageManager":"pip","schemaVersion":1},"license":"MIT-0","packages":["pkg:pypi/pydantic-settings@2.14.2"],"schemaVersion":1,"subject":"pkg:pypi/pydantic-settings@2.14.2","symbols":["pydantic_settings.CliSettingsSource"],"verifierAdapter":"python@1"}

pydantic-settings==2.14.2
pydantic==2.13.5
pydantic-core==2.46.5
annotated-types==0.8.0
python-dotenv==1.2.3
typing-extensions==4.16.0
typing-inspection==0.4.4

{
  "schemaVersion": 1,
  "goal": "verify pydantic_settings.CliSettingsSource in pkg:pypi/pydantic-settings@2.14.2",
  "kind": "HOW",
  "packages": [
    "pkg:pypi/pydantic-settings@2.14.2"
  ],
  "symbols": [
    "pydantic_settings.CliSettingsSource"
  ]
}

from pydantic_settings import BaseSettings, CliSettingsSource, PydanticBaseSettingsSource


class ServerSettings(BaseSettings):
    host: str = "localhost"
    port: int = 8000

    @classmethod
    def settings_customise_sources(
        cls,
        settings_cls: type[BaseSettings],
        init_settings: PydanticBaseSettingsSource,
        env_settings: PydanticBaseSettingsSource,
        dotenv_settings: PydanticBaseSettingsSource,
        file_secret_settings: PydanticBaseSettingsSource,
    ) -> tuple[PydanticBaseSettingsSource, ...]:
        return (
            init_settings,
            CliSettingsSource(
                settings_cls,
                cli_parse_args=["--host", "127.0.0.1", "--port", "9000"],
            ),
        )


class KebabSettings(BaseSettings):
    app_name: str = "default_app"
    log_level: str = "INFO"

    @classmethod
    def settings_customise_sources(
        cls,
        settings_cls: type[BaseSettings],
        init_settings: PydanticBaseSettingsSource,
        env_settings: PydanticBaseSettingsSource,
        dotenv_settings: PydanticBaseSettingsSource,
        file_secret_settings: PydanticBaseSettingsSource,
    ) -> tuple[PydanticBaseSettingsSource, ...]:
        return (
            init_settings,
            CliSettingsSource(
                settings_cls,
                cli_kebab_case=True,
                cli_parse_args=["--app-name", "sample-app", "--log-level", "DEBUG"],
            ),
        )


class ShortcutSettings(BaseSettings):
    port: int = 8080

    @classmethod
    def settings_customise_sources(
        cls,
        settings_cls: type[BaseSettings],
        init_settings: PydanticBaseSettingsSource,
        env_settings: PydanticBaseSettingsSource,
        dotenv_settings: PydanticBaseSettingsSource,
        file_secret_settings: PydanticBaseSettingsSource,
    ) -> tuple[PydanticBaseSettingsSource, ...]:
        return (
            init_settings,
            CliSettingsSource(
                settings_cls,
                cli_shortcuts={"port": "p"},
                cli_parse_args=["-p", "4000"],
            ),
        )


class LenientSettings(BaseSettings):
    host: str = "localhost"

    @classmethod
    def settings_customise_sources(
        cls,
        settings_cls: type[BaseSettings],
        init_settings: PydanticBaseSettingsSource,
        env_settings: PydanticBaseSettingsSource,
        dotenv_settings: PydanticBaseSettingsSource,
        file_secret_settings: PydanticBaseSettingsSource,
    ) -> tuple[PydanticBaseSettingsSource, ...]:
        return (
            init_settings,
            CliSettingsSource(
                settings_cls,
                cli_ignore_unknown_args=True,
                cli_parse_args=["--host", "10.0.0.1", "--unrecognized-option", "ignored"],
            ),
        )


def main() -> None:
    # 1. Basic argument parsing
    server = ServerSettings()
    assert server.host == "127.0.0.1", f"Expected '127.0.0.1', got '{server.host}'"
    assert server.port == 9000, f"Expected 9000, got {server.port}"

    # 2. Kebab-case argument parsing
    kebab = KebabSettings()
    assert kebab.app_name == "sample-app", f"Expected 'sample-app', got '{kebab.app_name}'"
    assert kebab.log_level == "DEBUG", f"Expected 'DEBUG', got '{kebab.log_level}'"

    # 3. Shortcut flag
    shortcut = ShortcutSettings()
    assert shortcut.port == 4000, f"Expected 4000, got {shortcut.port}"

    # 4. Ignore unknown arguments
    lenient = LenientSettings()
    assert lenient.host == "10.0.0.1", f"Expected '10.0.0.1', got '{lenient.host}'"


if __name__ == "__main__":
    main()