pyproject.toml

# SPDX-FileCopyrightText: Contributors to the Power Grid Model project <powergridmodel@lfenergy.org>
#
# SPDX-License-Identifier: MPL-2.0

[build-system]
requires = ["setuptools", "wheel"]
build-backend = "setuptools.build_meta"

[project]
name = "power-grid-model-ds"
authors = [
  { name = "Contributors to the Power Grid Model project", email = "powergridmodel@lfenergy.org" },
]
description = "Power Grid Model extension which provides a grid data structure for simulation and analysis"
readme = "README.md"
keywords = ["power grid model"]
license = { text = "MPL-2.0" }
classifiers = [
  "Programming Language :: Python :: 3",
  "Intended Audience :: Developers",
  "Intended Audience :: Science/Research",
  "License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)",
  "Operating System :: Microsoft :: Windows",
  "Operating System :: POSIX :: Linux",
  "Operating System :: MacOS",
  "Topic :: Scientific/Engineering :: Physics",
]
requires-python = ">=3.12"
dependencies = [
  "power-grid-model>=1.12.11",
  "rustworkx>= 0.15.1",
  "numpy>=2.0",
]
dynamic = ["version"]

[project.optional-dependencies]
# Published optional dependencies, or "extras".

visualizer = [
  # Visualization (make sure these are also updated in the 'dev' group)
  "dash>=3.0.0",
  "dash-bootstrap-components>=2.0.0",
  "dash-cytoscape>=1.0.2",
  "dash-ag-grid >= 35.0.0",
]
pandas = ["pandas>=2.2.1"]

[dependency-groups]
# Local dependencies for development.

dev = [
  "pylint>=4.0",
  "pytest>=9.0",
  "coverage>=7.0",
  "ruff>=0.16.9",
  "mypy>=2.0",
  "pre-commit>=4.6.2",
  "poethepoet>=0.48.0",
  # Visualization (make sure these stay equalivalent to the 'visualizer' group)
  "dash>=3.0.0",
  "dash-bootstrap-components>=2.0.0",
  "dash-cytoscape>=1.0.2",
  "dash-ag-grid>=35.3.0",
  "nb-clean>=4.0.1",
]

doc = [
  "sphinx>=9.1.0",
  "myst-nb>=1.4.0",
  "sphinx_rtd_theme>=3.1.0",
  "readthedocs-sphinx-search>=0.3.2",
  "sphinx-hoverxref>=1.4.2",
  "numpydoc>=1.11.0",
]

[tool.uv]
default-groups = [
    "dev",
    "doc",
]

[project.urls]
Home-page = "https://lfenergy.org/projects/power-grid-model/"
GitHub = "https://github.com/PowerGridModel/power-grid-model-ds"
Documentation = "https://power-grid-model-ds.readthedocs.io/en/stable/"
Mailing-list = "https://lists.lfenergy.org/g/powergridmodel"
Discussion = "https://github.com/orgs/PowerGridModel/discussions"

[tool.setuptools.packages.find]
where = ["src"]
namespaces = false

[tool.setuptools.dynamic]
version = { file = "PYPI_VERSION" }

[tool.pylint.messages_control]
disable = [
  "logging-fstring-interpolation", # allows usage of f-strings in logging
  "missing-module-docstring",
  "too-few-public-methods",
]
good-names = ["id"]
extension-pkg-allow-list = ["rustworkx"]
max-parents = 15
max-line-length = 120

[tool.ruff]
output-format = "github"
line-length = 120
indent-width = 4
show-fixes = true

[tool.ruff.lint]
select = [
  # pycodestyle
  "E",
  # Pyflakes
  "F",
  # pyupgrade
  "UP",
  # flake8-bugbear
  "B",
  # flake8-simplify
  "SIM",
  # isort
  "I",
  "YTT",
  "BLE",
  "PERF",
  "Q",
  "ICN",
  "ISC",
  "G",
  "LOG",
  "EXE",
  "FA",
  "FURB",
  "FLY",
  "SLOT",
  # pylint
  "PL",
  # Numpy-specific rules
  "NPY",
  # Warning
  "W",
  # use pathlib
  "PTH",
  # tidy imports
  "TID",
  # unused arguments
  "ARG",
  # Return
  "RET",
  # pie
  "PIE",
  # self
  "SLF",
  # raise
  "RSE",
  # ruff sepcific rules
  "RUF",
  # bandit
  "S",
  # boolean positional value in call
  "FBT003",
  # raise vanilla args
  "TRY002",
  # pytest-style
  "PT",
]
# Allow fix for all enabled rules (when `--fix`) is provided.
fixable = ["ALL"]
unfixable = []

[tool.ruff.lint.isort]
# Imports that are imported using keyword "as" and are from the same source - are combined.
combine-as-imports = true

[tool.ruff.lint.per-file-ignores]
# S101: assert statements are used in tests
# SLF001: private member access allowed in tests
# PLR2004: magic numbers allowed in tests
"tests/*" = ["S101", "SLF001", "PLR2004"]

[tool.mypy]
follow_imports = "silent"
ignore_missing_imports = true
show_column_numbers = true
non_interactive = true
install_types = true
disable_error_code = ["assignment", "import-untyped"]

[tool.coverage.run]
relative_files = true
source = ["src"]
command_line = '--module pytest'

[tool.coverage.report]
fail_under = 90
exclude_also = [
  'if TYPE_CHECKING:',
]

[tool.poe.tasks.all]
help = "Run all CI calls"
control.expr = "check"
args = [{name = "check", type="boolean", help= "Does not correct files, only warns"}]
  [[tool.poe.tasks.all.switch]]
  case     = "True"
  sequence = ["format --check", "lint --check", "lock", "type", "cover", "report", "clean_notebooks --check", "test_notebooks"]

  [[tool.poe.tasks.all.switch]]
  sequence = ["format", "lint", "lock", "type", "cover", "report", "clean_notebooks", "test_notebooks"]


[tool.poe.tasks.lint]
help = "Lint code (with ruff & pylint)"
# --no-fix does override --fix in ruff, if --check is given to poe.
sequence = [
  {cmd='ruff check --fix --show-fixes ${check:+ --no-fix}'},
  {cmd="pylint src"},
]
args=[{name = "check", type="boolean", help= "Does not correct files, only warns"}]

[tool.poe.tasks.format]
help = "Format code (with ruff)"
cmd = 'ruff format ${check:+ --diff}'
args=[{name = "check", type="boolean", help= "Does not correct files, only warns"}]

[tool.poe.tasks.sort]
help = "Sort imports (with ruff)"
cmd = 'ruff check --select I --fix --show-fixes ${check:+ --no-fix}'
args=[{name = "check", type="boolean", help= "Does not correct files, only warns"}]

[tool.poe.tasks.type]
help = "Type check code (with mypy)"
cmd = "mypy src tests"

[tool.poe.tasks.tests]
help = "Run tests"
cmd = "pytest"

[tool.poe.tasks.test_notebooks]
help = "Run notebooks (to test)"
shell = 'uv run sphinx-build -T -Q -b html docs docs/_build/html; [ $? -eq 0 ] && echo "No issues found in notebooks"'


[tool.poe.tasks.lock]
help = "Asserts that dependencies are locked"
cmd = "uv lock --check"

[tool.poe.tasks.cover]
help = "Run tests (and gather coverage)"
cmd = "coverage run"

[tool.poe.tasks.report]
help = "Generate coverage report. Will use data from a previous cover command."
cmd = "coverage report"

[tool.poe.tasks.coverage]
help = "Run coverage *and* generate report"
sequence = ["cover", "report"]

[tool.poe.tasks.clean_notebooks]
help = "Clear all metadata from notebooks"
args=[{name = "check", type="boolean", help= "Does not correct files, only warns"}]
control.expr = "check"

  [[tool.poe.tasks.clean_notebooks.switch]]
  case = "True"
  cmd = 'nb-clean check docs/'

  [[tool.poe.tasks.clean_notebooks.switch]]
  cmd = 'nb-clean clean docs/'