[project]

name = "gradient"

version = "3.6.0"

description = "The official Python library for the Gradient API"

dynamic = ["readme"]

license = "Apache-2.0"

authors = [{ name = "DigitalOcean, LLC", email = "[email protected]" }]

dependencies = [

"httpx>=0.23.0, <1",

"pydantic>=1.9.0, <3",

"typing-extensions>=4.10, <5",

"anyio>=3.5.0, <5",

"distro>=1.7.0, <2",

"sniffio",

]

requires-python = ">= 3.8"

classifiers = [

"Typing :: Typed",

"Intended Audience :: Developers",

"Programming Language :: Python :: 3.8",

"Programming Language :: Python :: 3.9",

"Programming Language :: Python :: 3.10",

"Programming Language :: Python :: 3.11",

"Programming Language :: Python :: 3.12",

"Programming Language :: Python :: 3.13",

"Operating System :: OS Independent",

"Operating System :: POSIX",

"Operating System :: MacOS",

"Operating System :: POSIX :: Linux",

"Operating System :: Microsoft :: Windows",

"Topic :: Software Development :: Libraries :: Python Modules",

"License :: OSI Approved :: Apache Software License",

]

[project.urls]

Homepage = "https://github.com/digitalocean/gradient-python"

Repository = "https://github.com/digitalocean/gradient-python"

[project.optional-dependencies]

aiohttp = ["aiohttp", "httpx_aiohttp>=0.1.8"]

[tool.rye]

managed = true

# version pins are in requirements-dev.lock

dev-dependencies = [

"pyright==1.1.399",

"mypy",

"respx",

"pytest",

"pytest-asyncio",

"ruff",

"time-machine",

"nox",

"dirty-equals>=0.6.0",

"importlib-metadata>=6.7.0",

"rich>=13.7.1",

"pytest-xdist>=3.6.1",

]

[tool.rye.scripts]

format = { chain = [

"format:ruff",

"format:docs",

"fix:ruff",

# run formatting again to fix any inconsistencies when imports are stripped

"format:ruff",

] }

"format:docs" = "python scripts/utils/ruffen-docs.py README.md api.md"

"format:ruff" = "ruff format"

"lint" = { chain = ["check:ruff", "typecheck", "check:importable"] }

"check:ruff" = "ruff check ."

"fix:ruff" = "ruff check --fix ."

"check:importable" = "python -c 'import gradient'"

typecheck = { chain = ["typecheck:pyright", "typecheck:mypy"] }

"typecheck:pyright" = "pyright"

"typecheck:verify-types" = "pyright --verifytypes gradient --ignoreexternal"

"typecheck:mypy" = "mypy ."

[build-system]

requires = ["hatchling==1.26.3", "hatch-fancy-pypi-readme"]

build-backend = "hatchling.build"

[tool.hatch.build]

include = ["src/*"]

[tool.hatch.build.targets.wheel]

packages = ["src/gradient"]

[tool.hatch.build.targets.sdist]

# Basically everything except hidden files/directories (such as .github, .devcontainers, .python-version, etc)

include = [

"/*.toml",

"/*.json",

"/*.lock",

"/*.md",

"/mypy.ini",

"/noxfile.py",

"bin/*",

"examples/*",

"src/*",

"tests/*",

]

[tool.hatch.metadata.hooks.fancy-pypi-readme]

content-type = "text/markdown"

[[tool.hatch.metadata.hooks.fancy-pypi-readme.fragments]]

path = "README.md"

[[tool.hatch.metadata.hooks.fancy-pypi-readme.substitutions]]

# replace relative links with absolute links

pattern = '\[(.+?)\]\(((?!https?://)\S+?)\)'

replacement = '[\1](https://github.com/digitalocean/gradient-python/tree/main/\g<2>)'

[tool.pytest.ini_options]

testpaths = ["tests"]

addopts = "--tb=short -n auto -m 'not smoke'"

xfail_strict = true

asyncio_mode = "auto"

asyncio_default_fixture_loop_scope = "session"

filterwarnings = ["error"]

markers = [

"smoke: lightweight external integration smoke tests hitting live Gradient services",

]

[tool.pyright]

# this enables practically every flag given by pyright.

# there are a couple of flags that are still disabled by

# default in strict mode as they are experimental and niche.

typeCheckingMode = "strict"

pythonVersion = "3.8"

exclude = [

"_dev",

".venv",

".nox",

".git",

]

reportImplicitOverride = true

reportOverlappingOverload = false

reportImportCycles = false

reportPrivateUsage = false

[tool.mypy]

pretty = true

show_error_codes = true

# Exclude _files.py because mypy isn't smart enough to apply

# the correct type narrowing and as this is an internal module

# it's fine to just use Pyright.

#

# We also exclude our `tests` as mypy doesn't always infer

# types correctly and Pyright will still catch any type errors.

exclude = ['src/gradient/_files.py', '_dev/.*.py', 'tests/.*']

strict_equality = true

implicit_reexport = true

check_untyped_defs = true

no_implicit_optional = true

warn_return_any = true

warn_unreachable = true

warn_unused_configs = true

# Turn these options off as it could cause conflicts

# with the Pyright options.

warn_unused_ignores = false

warn_redundant_casts = false

disallow_any_generics = true

disallow_untyped_defs = true

disallow_untyped_calls = true

disallow_subclassing_any = true

disallow_incomplete_defs = true

disallow_untyped_decorators = true

cache_fine_grained = true

# By default, mypy reports an error if you assign a value to the result

# of a function call that doesn't return anything. We do this in our test

# cases:

# ```

# result = ...

# assert result is None

# ```

# Changing this codegen to make mypy happy would increase complexity

# and would not be worth it.

disable_error_code = "func-returns-value,overload-cannot-match"

# https://github.com/python/mypy/issues/12162

[[tool.mypy.overrides]]

module = "black.files.*"

ignore_errors = true

ignore_missing_imports = true

[tool.ruff]

line-length = 120

output-format = "grouped"

target-version = "py38"

[tool.ruff.format]

docstring-code-format = true

[tool.ruff.lint]

select = [

# isort

"I",

# bugbear rules

"B",

# remove unused imports

"F401",

# check for missing future annotations

"FA102",

# bare except statements

"E722",

# unused arguments

"ARG",

# print statements

"T201",

"T203",

# misuse of typing.TYPE_CHECKING

"TC004",

# import rules

"TID251",

]

ignore = [

# mutable defaults

"B006",

]

unfixable = [

# disable auto fix for print statements

"T201",

"T203",

]

extend-safe-fixes = ["FA102"]

[tool.ruff.lint.flake8-tidy-imports.banned-api]

"functools.lru_cache".msg = "This function does not retain type information for the wrapped function's arguments; The `lru_cache` function from `_utils` should be used instead"

[tool.ruff.lint.isort]

length-sort = true

length-sort-straight = true

combine-as-imports = true

extra-standard-library = ["typing_extensions"]

known-first-party = ["gradient", "tests"]

[tool.ruff.lint.per-file-ignores]

"bin/**.py" = ["T201", "T203"]

"scripts/**.py" = ["T201", "T203"]

"tests/**.py" = ["T201", "T203"]

"examples/**.py" = ["T201", "T203"]