pyproject.toml

[build-system]
requires = ["flit_core >=3.2,<4"]
build-backend = "flit_core.buildapi"

[project]
name = "opensafely-ehrql"
description = ""
version = "2+local"
readme = "README.md"
authors = [{name = "OpenSAFELY", email = "tech@opensafely.org"}]
license-files = ["LICENSE"]
license = "GPL-3.0-or-later"
requires-python = ">=3.13"
dependencies = [
  "pyarrow",
  "sqlalchemy",
  # Database driver for MS-SQL
  "pymssql",
  # Trino python client and database driver
  "trino",
  # Gives us isolation from the system version of SQLite and means we don't
  # need to worry about e.g. some versions of SQLite missing the `FLOOR`
  # function.
  "sqlean.py",
  # For graphing query graphs
  "networkx",
  "pydot",
  # speed up for dummy data next generation
  "numpy",
]

[project.scripts]
ehrql = "ehrql.__main__:entrypoint"

[project.urls]
Home = "https://opensafely.org"
Documentation = "https://docs.opensafely.org"
Source = "https://github.com/opensafely-core/ehrql"

[tool.coverage.run]
branch = true

[tool.coverage.report]
fail_under = 100
skip_covered = true
exclude_also = [
    # this indicates that the line should never be hit
    "assert False",
    # this condition is only true when a module is run as a script
    'if __name__ == "__main__":',
    # this indicates that a method should be defined in a subclass
    "raise NotImplementedError",
    # this is just for type hints and doesn't appear in the runtime code
    "@overload",
    # function used for defining test fixture code inline
    "@function_body_as_string",
    # Custom multiline pragma to allow excluding whole files. See:
    # https://coverage.readthedocs.io/en/7.11.0/excluding.html#multi-line-exclusion-regexes
    '\A(?s:.*# pragma: no cover file.*)\Z',
]
omit = [
    "tests/acceptance/external_studies/*",
]

[tool.coverage.html]

[tool.flit.module]
name = "ehrql"

[tool.pydocstyle]
convention = "google"
add_select = [
  "D213",
]
# Base ignores for all docstrings, for module/package specific ones add them to
# the CLI args in justfile
add_ignore = [
  "D100",
  "D104",
  "D107",
  "D212",
]

[tool.pytest.ini_options]
addopts = "--tb=native --strict-markers --dist=loadgroup -p no:legacypath"
testpaths = ["tests"]
filterwarnings = [
    # ignnore dbapi() deprecation warnings for the third party TrinoDialect that we subclass
    "ignore:.*dbapi.*TrinoDialect.*:sqlalchemy.exc.SADeprecationWarning",
    # ignore warning about pydot being unmaintained; there's no obvious easy-to-install replacement
    "ignore:.*nx.nx_pydot.to_pydot.*:DeprecationWarning",
]

[tool.ruff]
line-length = 88
exclude = [
  ".direnv",
  ".git",
  ".github/",
  ".ipynb_checkpoints",
  ".pytest_cache",
  ".venv/",
  "__pycache__",
  "coverage/",
  "docker/",
  "docs/",
  "htmlcov/",
  "tests/acceptance/external_studies/",
  "tests/fixtures/bad_definition_files",
  "venv/",
]

[tool.ruff.lint]
extend-select = [
  "A", # flake8-builtins
  "I",  # isort
  "INP",  # flake8-no-pep420
  "UP",  # pyupgrade
  "W",  # pycodestyle warning
]
extend-ignore = [
  "A005", # ignore stdlib-module-shadowing
  "E501", # line-too-long
  "UP032", # replace `.format` with f-string
]

isort.lines-after-imports = 2

# Note: any `exclude-newer-package` timestamps should be removed if > 7 days old
# See https://github.com/opensafely-core/repo-template/blob/main/DEVELOPERS.md for details
[tool.uv]
exclude-newer = "2026-04-15T00:00:00Z"
exclude-newer-package = {}

[dependency-groups]
dev = [
  "docker",
  "hypothesis",
  "openpyxl>=3.1.5",
  "pre-commit",
  "pyright[nodejs]",
  "pytest",
  "pytest-cov",
  "pytest-mock",
  "pytest-xdist",
  "ruff",
  "toml",

  # docs
  "mkdocs",
  "mkdocs-material",
]