Skip to main content

Pydantic 2 argparse.

Project description

pydantic-argparse-next

Argument parser based on pydantic v2.

Install:

pip install pydantic-argparse-next

Base usage:

from pydantic import BaseModel, Field
import pydantic_argparse_next as pa


class Temp(BaseModel):
    # Positional arguments
    a: str = pa.Arg(description="This is a required positional argument.")
    b: str = pa.Arg("defalut_value", description="This is a OPTIONAL positional argument.")

    # Keyword arguments
    # Simple attributes or pydantic.Field are keyword arguments.
    c: str
    d: str = Field(None, description="This is a OPTIONAL keyword argument.")
    e: str = pa.KwArg(description="This is a required keyword argument.")
Input: appname "test1" --c "test2" --e="test3"
Output: a='test1' b='defalut_value' c='test2' d=None e='test3'

More details in the documentation

Supports:

✅ Positional arguments

        ✅ Required positional arguments

        ✅ Optional positional arguments

✅ Keyword arguments

        ✅ Required keyword arguments

        ✅ Optional keyword arguments

✅ Subcommands

        ✅ Required subcommands

        ✅ Optional subcommands

        ✅ Subcommands within subcommands

✅ Actions

        ✅ Choice (And simple text and Enum object)

        ✅ Store True

        ✅ Store False

        ✅ Variadic arguments

⬜ Extra

        ⬜ Easy saving config to file

        ⬜ Easy load config from file

More details in the documentation

Docs and examples:

  1. Base usage

  2. Actions

    1. Choice

    2. Store True and Store False

    3. Subcommands

    4. Variadic

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pydantic_argparse_next-1.0.5.tar.gz (8.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pydantic_argparse_next-1.0.5-py3-none-any.whl (11.5 kB view details)

Uploaded Python 3

File details

Details for the file pydantic_argparse_next-1.0.5.tar.gz.

File metadata

  • Download URL: pydantic_argparse_next-1.0.5.tar.gz
  • Upload date:
  • Size: 8.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.12.4 Windows/11

File hashes

Hashes for pydantic_argparse_next-1.0.5.tar.gz
Algorithm Hash digest
SHA256 92553edf76bf9e65532b213015c21260364c60e5f9e831545b48683adee161c8
MD5 772a5c844cc2bcecdfeb44814139eb4e
BLAKE2b-256 8720157dc53cdb6774dec3db6217f809d8272d2dc6a399c3a3c5a46042c43245

See more details on using hashes here.

File details

Details for the file pydantic_argparse_next-1.0.5-py3-none-any.whl.

File metadata

File hashes

Hashes for pydantic_argparse_next-1.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 da546f3e92cea803ff2847b7ec1e106485c656f4951e46e5d6b487a77087ee9e
MD5 265a7b384d244e0fc8522da3c2b0fafe
BLAKE2b-256 42437302966d089db20cebfc35e2c36e26ec6a00792548bca351d5028676c45d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page