pyproject.toml

[project]
name = "connectrpc"
version = "0.11.1"
description = "Server and client runtime library for Connect RPC"
readme = "README.md"
requires-python = ">= 3.10"
license = "Apache-2.0"
license-files = ["LICENSE"]
maintainers = [
  { name = "Anuraag Agrawal", email = "anuraaga@gmail.com" },
  { name = "Spencer Nelson", email = "spencer@firetiger.com" },
  { name = "Stefan VanBuren", email = "stefan@vanburen.xyz" },
  { name = "Yasushi Itoh", email = "i2y.may.roku@gmail.com" },
]
keywords = ["connect", "grpc", "http", "protobuf", "rpc"]
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Developers",
  "Operating System :: OS Independent",
  "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",
  "Topic :: Internet :: WWW/HTTP",
  "Topic :: Software Development :: Libraries :: Python Modules",
  "Typing :: Typed",
]
dependencies = [
  "protobuf-py>=0.3.0",
  "pyqwest>=0.5.1",
]

[project.urls]
Documentation = "https://connectrpc.com/docs/python/getting-started/"
Homepage = "https://github.com/connectrpc/connect-py"
Issues = "https://github.com/connectrpc/connect-py/issues"
Repository = "https://github.com/connectrpc/connect-py"

[dependency-groups]
dev = [
  # Install all packages to be available in docs building, etc.
  "connectrpc-grpcreflect",
  "connectrpc-otel",
  "example",
  "protoc-gen-connectrpc",

  "asgiref==3.12.1",
  "brotli==1.2.0",
  "buf-bin==1.72.0",
  "granian==2.8.1",
  "grpcio-tools==1.83.0",
  "gunicorn==26.0.0",
  "hypercorn==0.18.0",
  "poethepoet==0.48.0",
  "pytest==9.1.1",
  "pytest-asyncio==1.4.0",
  "pytest-cov==7.1.0",
  "pytest-timeout==2.5.0",
  "pyvoy==1.0.0",
  "ruff==0.16.3",
  "tombi==1.4.1",
  "ty==0.0.72",
  "types-grpcio==1.83.0.20260730",
  "types-protobuf==7.34.1.20260816",
  "typing_extensions==4.16.0",
  "uvicorn==0.52.3",
  "zstandard==0.25.0",

  # dev dependencies only used in subprojects. Optimal structure would include these
  # in the subproject itself, but then `uv sync` does not install them from the
  # workspace root. We strategically keep them here instead so the entire workspace
  # is ready for editing in an IDE with a simple sync command.
  # If the below issue is resolved, we can move them back to subprojects and configure
  # our default sync setting as --all-packages.
  # https://github.com/astral-sh/uv/issues/5737
  "opentelemetry-instrumentation-asgi==0.65b0",
  "opentelemetry-instrumentation-wsgi==0.65b0",
  "opentelemetry-sdk==1.44.0",
  "protobuf>=5.28",
  "protoc-gen-grpc-py==0.3.0",
  "protoc-gen-py==0.3.0",
]

docs = ["mkdocstrings-python==2.0.6", "zensical==0.0.55"]

[build-system]
requires = ["uv_build>=0.12.0,<0.13.0"]
build-backend = "uv_build"

[tool.pytest]
# Turn all warnings into errors
filterwarnings = [
  "error",
  # Workaround https://github.com/open-telemetry/opentelemetry-python/issues/5231
  "ignore:SelectableGroups dict interface is deprecated. Use select.",
]
strict = true
testpaths = ["test"]
timeout = 1800  # 30 min

[tool.ruff]
# Don't run ruff on generated code from external plugins.
extend-exclude = ["*_pb2.py", "*_pb2.pyi"]

[tool.ruff.format]
skip-magic-trailing-comma = true
docstring-code-format = true

[tool.ruff.lint]
typing-extensions = false
select = ["ALL"]
ignore = [
  # Rules recommended to ignore when using ruff formatting
  # https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
  "W191",
  "E111",
  "E114",
  "E117",
  "E501",
  "D206",
  "D300",
  "Q",
  "COM812",
  "COM819",

  "CPY001",  # We don't use copyright headers

  "TRY301",  # Abstract `raise` to an inner function - prevents a common pattern of having different validation points when creating a single response
  "SLF001",  # Private member accessed
  "ANN401",  # Dynamically typed expressions (typing.Any) are disallowed
  "PLR2004",  # Magic value used in comparison - not helpful to name obvious constants
  # Complexity rules: humans reviewing code can judge whether complexity is justified.
  "C901",  # McCabe complexity
  "PLR0911",  # Too many return statements
  "PLR0912",  # Too many branches
  "PLR0913",  # Too many arguments in function definition
  "PLR0914",  # Too many local variables
  "PLR0915",  # Too many statements
  "PLR0916",  # Too many boolean expressions
  "PLR0917",  # Too many positional arguments
  "PLR1702",  # Too many nested blocks
  "PT012",  # pytest.raises should surround a single statement - too restrictive, author can decide

  # TODO rules
  "TD",
  "FIX002",  # Line contains TODO, consider resolving the issue
]

[tool.ruff.lint.per-file-ignores]
"conformance/test/**" = ["ANN", "BLE", "INP", "SLF", "SIM115", "S101", "D"]
"example/**" = [
  "ANN",
  "S",  # Keep examples simpler, e.g. allow normal random
  "T20",
  "D",
]
"**/test/*.py" = [
  "ANN",
  "S101",
  "S603",
  "S607",
  "FBT",
  "EM",
  "INP",
  "SLF",
  "PERF",
  "D",
]
"**/*_grpc.py" = ["N", "FBT"]

[tool.ruff.lint.isort]
combine-as-imports = true
required-imports = ["from __future__ import annotations"]
split-on-trailing-comma = false

[tool.ty.src]
exclude = [
  # gRPC generated code references `grpc.experimental`, which is not exposed by the
  # `grpc` package's public API. See https://github.com/grpc/grpc/issues/39555.
  "**/*_pb2_grpc.py",
  # Workaround lack of monorepo support by excluding subproject code from top-level project.
  # https://docs.astral.sh/ty/reference/typing-faq/#does-ty-support-monorepos
  # https://github.com/astral-sh/ty/issues/819
  "connectrpc-grpcreflect",
  "connectrpc-otel",
  "example",
]

[tool.ty.environment]
# Conformance test files import generated code as `from gen.connectrpc...` and
# sibling modules like `_util`/`_cov_embed`. Pytest and the launched server/client
# subprocesses put `conformance/test/` on sys.path; teach ty to do the same.
extra-paths = ["conformance/test"]

[tool.uv.build-backend]
module-name = "connectrpc"

[tool.uv.workspace]
members = [
  "connectrpc-grpcreflect",
  "connectrpc-otel",
  "example",
  "protoc-gen-connectrpc",
]

[tool.uv.sources]
connectrpc = { workspace = true }
connectrpc-grpcreflect = { workspace = true }
connectrpc-otel = { workspace = true }
protoc-gen-connectrpc = { workspace = true }

example = { workspace = true }