pyproject.toml

# License: MIT
# Copyright © 2024 Frequenz Energy-as-a-Service GmbH

[build-system]
requires = [
  "setuptools == 68.1.0",
  "setuptools_scm[toml] == 7.1.0",
  "setuptools-betterproto == 0.2.0",
]
build-backend = "setuptools.build_meta"

[project]
name = "frequenz-microgrid-betterproto"
description = "Bindings to the microgrid API generated using betterproto"
readme = "README.md"
license = { text = "MIT" }
keywords = [
  "api",
  "betterproto",
  "bindings",
  "frequenz",
  "grpc",
  "lib",
  "library",
  "microgrid",
  "proto",
  "protobuf",
  "python",
  "rpc",
]
classifiers = [
  "Development Status :: 3 - Alpha",
  "Intended Audience :: Developers",
  "License :: OSI Approved :: MIT License",
  "Programming Language :: Python :: 3",
  "Programming Language :: Python :: 3 :: Only",
  "Topic :: Software Development :: Libraries",
  "Typing :: Typed",
]
requires-python = ">= 3.11, < 4"
dependencies = ["betterproto == 2.0.0b6", "typing-extensions >= 4.5.0, < 5"]
dynamic = ["version"]

[[project.authors]]
name = "Frequenz Energy-as-a-Service GmbH"
email = "floss@frequenz.com"

[project.optional-dependencies]
dev-flake8 = [
  "flake8 == 7.1.0",
  "flake8-docstrings == 1.7.0",
  "flake8-pyproject == 1.2.3",  # For reading the flake8 config from pyproject.toml
  "pydoclint == 0.5.3",
  "pydocstyle == 6.3.0",
]
dev-formatting = ["black == 24.4.2", "isort == 5.13.2"]
dev-mkdocs = [
  "black == 24.4.2",
  "Markdown == 3.6",
  "mike == 2.1.2",
  "mkdocs-gen-files == 0.5.0",
  "mkdocs-literate-nav == 0.6.1",
  "mkdocs-macros-plugin == 1.0.5",
  "mkdocs-material == 9.5.27",
  "mkdocstrings[python] == 0.25.1",
  "mkdocstrings-python == 1.10.5",
  "frequenz-repo-config[lib] == 0.9.2",
]
dev-mypy = [
  "mypy == 1.10.1",
  "types-Markdown == 3.6.0.20240316",
  # For checking the noxfile, docs/ script, and tests
  "frequenz-microgrid-betterproto[dev-mkdocs,dev-noxfile,dev-pytest]",
]
dev-noxfile = ["nox == 2024.4.15", "frequenz-repo-config[lib] == 0.9.2"]
dev-pylint = [
  "pylint == 3.2.5",
  # For checking the noxfile, docs/ script, and tests
  "frequenz-microgrid-betterproto[dev-mkdocs,dev-noxfile,dev-pytest]",
]
dev-pytest = [
  "pytest == 8.2.2",
  "frequenz-repo-config[extra-lint-examples] == 0.9.2",
  "pytest-mock == 3.14.0",
  "pytest-asyncio == 0.23.7",
]
dev = [
  "frequenz-microgrid-betterproto[dev-mkdocs,dev-flake8,dev-formatting,dev-mkdocs,dev-mypy,dev-noxfile,dev-pylint,dev-pytest]",
]

[project.urls]
Documentation = "https://frequenz-floss.github.io/frequenz-microgrid-betterproto-python/"
Changelog = "https://github.com/frequenz-floss/frequenz-microgrid-betterproto-python/releases"
Issues = "https://github.com/frequenz-floss/frequenz-microgrid-betterproto-python/issues"
Repository = "https://github.com/frequenz-floss/frequenz-microgrid-betterproto-python"
Support = "https://github.com/frequenz-floss/frequenz-microgrid-betterproto-python/discussions/categories/support"

[tool.black]
line-length = 88
target-version = ['py311']
include = '\.pyi?$'

[tool.isort]
profile = "black"
line_length = 88
src_paths = ["benchmarks", "docs/_scripts", "examples", "tests"]

[tool.flake8]
# We give some flexibility to go over 88, there are cases like long URLs or
# code in documenation that have extra indentation. Black will still take care
# of making everything that can be 88 wide, 88 wide.
max-line-length = 100
extend-ignore = [
  "E203", # Whitespace before ':' (conflicts with black)
  "W503", # Line break before binary operator (conflicts with black)
]
# pydoclint options
style = "google"
check-return-types = false
check-yield-types = false
arg-type-hints-in-docstring = false
arg-type-hints-in-signature = true
allow-init-docstring = true

[tool.pylint.similarities]
ignore-comments = ['yes']
ignore-docstrings = ['yes']
ignore-imports = ['no']
min-similarity-lines = 40

[tool.pylint.messages_control]
disable = [
  "too-few-public-methods",
  "too-many-return-statements",
  # disabled because it conflicts with isort
  "wrong-import-order",
  "ungrouped-imports",
  # pylint's unsubscriptable check is buggy and is not needed because
  # it is a type-check, for which we already have mypy.
  "unsubscriptable-object",
  # Checked by flake8
  "line-too-long",
  "redefined-outer-name",
  "unnecessary-lambda-assignment",
  "unused-import",
  "unused-variable",
]

[tool.pytest.ini_options]
testpaths = ["tests"]
asyncio_mode = "auto"
required_plugins = ["pytest-asyncio", "pytest-mock"]

[tool.mypy]
explicit_package_bases = true
namespace_packages = true
# This option disables mypy cache, and it is sometimes useful to enable it if
# you are getting weird intermittent error, or error in the CI but not locally
# (or vice versa). In particular errors saying that type: ignore is not
# used but getting the original ignored error when removing the type: ignore.
# See for example: https://github.com/python/mypy/issues/2960
#no_incremental = true
# We can't check the generated files because they fail with an error like:
# error: Argument 1 to "grpc_method" of "MicrogridBase" has incompatible type "[Message] | None"; expected "[Message]"
# This error seems valid, as the method doesn't accept a None, and a issue with
# betterproto generated code that we need to report.
#packages = ["frequenz.microgrid.betterproto"]
files = ["tests"]
strict = true

[[tool.mypy.overrides]]
module = ["mkdocs_macros.*"]
ignore_missing_imports = true

[tool.setuptools_scm]
version_scheme = "post-release"

[tool.setuptools_betterproto]
proto_path = "frequenz-api-microgrid/proto"
out_path = "src/frequenz/microgrid/betterproto"
include_paths = [
  "frequenz-api-microgrid/submodules/api-common-protos",
  "frequenz-api-microgrid/submodules/frequenz-api-common/proto",
]