pyproject.toml

[build-system]
requires = ["setuptools>=77"]
build-backend = "setuptools.build_meta"


[project]
name = "jsonargparse"
dynamic = ["version"]
description = "Minimal effort CLIs derived from type hints and parse from command line, config files and environment variables."
authors = [
    {name = "Mauricio Villegas", email = "mauricio@omnius.com"},
]
readme = "README.rst"
license = "MIT"
license-files = ["LICENSE.rst"]
requires-python = ">=3.10"

classifiers = [
    "Development Status :: 5 - Production/Stable",
    "Programming Language :: Python",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3 :: Only",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Programming Language :: Python :: 3.15",
    "Intended Audience :: Developers",
    "Operating System :: POSIX :: Linux",
    "Operating System :: MacOS",
    "Operating System :: Microsoft :: Windows",
]

[project.optional-dependencies]
all = [
    "jsonargparse[signatures]",
    "jsonargparse[yaml]",
    "jsonargparse[toml]",
    "jsonargparse[jsonnet]",
    "jsonargparse[jsonschema]",
    "jsonargparse[urls]",
    "jsonargparse[fsspec]",
    "jsonargparse[ruamel]",
    "jsonargparse[omegaconf]",
    "jsonargparse[typing-extensions]",
]
signatures = [
    "jsonargparse[docstrings]",
    "jsonargparse[typeshed]",
    "jsonargparse[typing-extensions]",
]
yaml = [
    "PyYAML>=3.13",
]
toml = [
    "tomli>=2.0.1; python_version < '3.11'",
    "tomli-w>=1.0.0",
]
jsonnet = [
    "jsonnet>=0.21.0",
]
jsonschema = [
    "jsonschema>=3.2.0",
]
urls = [
    "requests>=2.18.4",
]
fsspec = [
    "fsspec>=0.8.4",
]
shtab = [
    "shtab>=1.9.1",
]
argcomplete = [
    "argcomplete>=3.5.1",
]
ruamel = [
    "ruamel.yaml>=0.18.15",
]
omegaconf = [
    "omegaconf>=2.4.0",
]
docstrings = [
    "docstring-parser>=0.17",
]
typeshed = [
    "typeshed-client>=2.8.2",
]
typing-extensions = [
    "typing-extensions>=4.12.0; python_version < '3.11'",
]
test = [
    "jsonargparse[test-no-urls]",
    "jsonargparse[shtab]",
    "jsonargparse[argcomplete]",
    "types-PyYAML>=6.0.11",  # required by test_stubs_resolver
    "types-requests>=2.28.9,<2.34",  # required by test_stubs_resolver
    "requests<2.34",
    "responses>=0.12.0",
    "pydantic>=2.3.0",
    "attrs>=22.2.0",
]
test-no-urls = [
    "pytest>=6.2.5",
    "pytest-subtests>=0.8.0",
]
coverage = [
    "jsonargparse[test-no-urls]",
    "pytest-cov>=4.0.0",
]
dev = [
    "jsonargparse[all]",
    "jsonargparse[test]",
    "jsonargparse[coverage]",
    "jsonargparse[doc]",
    "pre-commit>=2.19.0",
    "tox>=4.0.0",
    "tox-uv>=1.0.0",
    "build>=0.10.0",
]
doc = [
    "Sphinx>=1.7.9",
    "sphinx-rtd-theme>=1.2.2",
    "autodocsumm>=0.1.10",
    "sphinx-autodoc-typehints>=1.19.5",
]
maintainer = [
    "bump2version>=0.5.11",
    "twine>=4.0.2",
]

[project.urls]
Documentation-stable = "https://jsonargparse.readthedocs.io/en/stable/"
Documentation-latest = "https://jsonargparse.readthedocs.io/en/latest/"
Changes = "https://jsonargparse.readthedocs.io/en/stable/changelog.html"
GitHub = "https://github.com/mauvilsa/jsonargparse"
PyPI = "https://pypi.org/project/jsonargparse"
SonarCloud = "https://sonarcloud.io/dashboard?id=mauvilsa_jsonargparse"
Codecov = "https://codecov.io/gh/mauvilsa/jsonargparse"


[tool.setuptools]
platforms = ["Any"]
packages = ["jsonargparse"]

[tool.setuptools.dynamic]
version = {attr = "jsonargparse.__version__"}

[tool.setuptools.package-data]
jsonargparse = ["py.typed"]


[tool.pytest.ini_options]
addopts = "-s"
testpaths = ["jsonargparse_tests"]


[tool.coverage.run]
relative_files = true
source = ["jsonargparse"]


[tool.mypy]
python_version = "3.12"
allow_redefinition = true
warn_unused_ignores = true
disable_error_code = "annotation-unchecked"


[tool.ruff]
fix = true
line-length = 120

[tool.ruff.lint]
select = [
    "E", "W",  # pycodestyle
    "F",       # pyflakes
    "I",       # isort
]
extend-select = [
    "RUF100",  # unused-noqa
]
ignore = [
    "E731",  # Do not convert lambda assigns to a def
    "E721",  # Allow comparing types with type()
]


[tool.typos.default.extend-identifiers]
Villegas = "Villegas"


[tool.tox]
legacy_tox_ini = """
[tox]
envlist = py{310,311,312,313,314,315}-{all-extras,no-extras,argparse},omegaconf,pydantic-v1,without-future-annotations
skip_missing_interpreters = true

[testenv]
extras =
    all-extras: test,coverage,all
    no-extras: coverage
    argparse: coverage
changedir = jsonargparse_tests
allowlist_externals = rm
passenv =
    UV_EXCLUDE_NEWER
    # Used by the gh CLI to download CPython's test_argparse.py
    GH_TOKEN
# Ensure uv installs into the tox env even if UV_SYSTEM_PYTHON=1 set outside
setenv =
    UV_SYSTEM_PYTHON = 0
    COVERAGE_FILE = {tox_root}/jsonargparse_tests/.coverage.{env_name}
commands =
    all-extras: python -m pytest {posargs}
    no-extras: python -m pytest {posargs}
    argparse: rm -f tests_argparse_{env_name}.py
    argparse: ./argparse_tests_generate.py --output_file tests_argparse_{env_name}.py --verbose false
    argparse: python -m pytest -W ignore::pytest.PytestUnknownMarkWarning --tb=no -m "not (not_supported or implementation_specific or investigate)" tests_argparse_{env_name}.py {posargs}
usedevelop = true

[testenv:.pkg]
setenv =
    {[testenv]setenv}

[testenv:omegaconf]
extras = test,coverage,all
changedir = jsonargparse_tests
setenv =
    {[testenv]setenv}
    JSONARGPARSE_OMEGACONF_FULL_TEST = true
commands =
    python -m pytest {posargs}

[testenv:pydantic-v1]
extras = coverage
# editable, so that changes in the tests source are picked up without recreating the env
deps = -e ./jsonargparse_tests
commands =
    # Test with pydantic<2
    python -c "\
        from pathlib import Path; \
        from shutil import copy; \
        copy('conftest.py', Path(r'{envtmpdir}', 'conftest.py')); \
        copy('test_pydantic.py', Path(r'{envtmpdir}', 'test_pydantic.py'))\
    "
    uv pip install --python {envpython} "pydantic<2"
    python -m pytest {posargs} {envtmpdir}/test_pydantic.py

    # Test with pydantic>=2 importing from pydantic.v1
    python -c "\
        import re, pathlib; \
        path = pathlib.Path(r'{envtmpdir}', 'test_pydantic.py'); \
        content = path.read_text(); \
        content = re.sub(r'import pydantic', 'import pydantic.v1 as pydantic', content); \
        content = re.sub(r'^annotated = [^\\n]*', 'annotated = False', content, flags=re.MULTILINE); \
        path.write_text(content)\
    "
    uv pip install --python {envpython} "pydantic>=2"
    python -m pytest {posargs} {envtmpdir}/test_pydantic.py

[testenv:without-future-annotations]
extras = test,coverage,all
# editable, so that changes in the tests source are picked up without recreating the env
deps = -e ./jsonargparse_tests
allowlist_externals = sh
commands =
    sh -c "\
        rm -rf {envtmpdir}/without_future_annotations; \
        mkdir -p {envtmpdir}/without_future_annotations; \
        cp *.py {envtmpdir}/without_future_annotations; \
        sed -i.bak -e '/^from __future__ import annotations$/d' {envtmpdir}/without_future_annotations/*.py; \
        rm -f {envtmpdir}/without_future_annotations/*.bak; \
    "
    python -m pytest {envtmpdir}/without_future_annotations {posargs}
commands_post =
    sh -c "rm -rf {envtmpdir}/without_future_annotations"

[testenv:coverage-report]
skip_install = true
deps = coverage[toml]
changedir = jsonargparse_tests
setenv =
    COVERAGE_FILE = {tox_root}/jsonargparse_tests/.coverage
commands =
    coverage combine
    coverage html
"""