pyproject.toml

#
### project ##########################################################################
# last checked/updated: 2024-09-10
#

[project]
  name = "ramses_rf"
  dynamic = ["version"]
  description = "A stateful RAMSES-II protocol decoder & analyser."
  readme = "README.md"
  authors = [{name = "David Bonnes", email = "zxdavb@bonnes.me"}]
  maintainers = [{name = "David Bonnes", email = "zxdavb@bonnes.me"}]
  dependencies = [
    "colorlog>=6.8.2",
    "paho-mqtt>=1.6.1,<2.0.0",
    "pyserial-asyncio-fast>=0.13",
    "voluptuous>=0.15.2",
  ]
  requires-python = ">=3.11"  # e.g. @enum.verify(enum.EnumCheck)
  license = "MIT"

  keywords = [
    "evohome",
    "honeywell",
    "resideo",
    "round thermostat",
    "ramses",
    "sundial",
    "chronotherm",
    "hometronics",
    "airios",
    "itho",
    "nuaire",
    "orcon",
  ]
  classifiers = [
    "Topic :: Home Automation",
  ]

#
[project.urls]
  "Homepage" = "https://github.com/zxdavb/ramses_rf"
  "Bug Tracker" = "https://github.com/zxdavb/ramses_rf/issues"
  "Wiki" = "https://github.com/zxdavb/ramses_rf/wiki"

#
[project.scripts]
  client = "ramses_cli.client:main"

#
### build-system #####################################################################

[build-system]
  requires = ["hatchling"]
  build-backend = "hatchling.build"

[tool.hatch.build]
  sources = ["src"]
  artifacts = ["misc/ser2net.yaml",]

[tool.hatch.build.targets.wheel]
  packages = ["src/ramses_rf", "src/ramses_tx", "src/ramses_cli"]

[tool.hatch.version]
  path = "src/ramses_rf/version.py"


#
### pytest ###########################################################################

[tool.pytest.ini_options]
  asyncio_default_fixture_loop_scope = "function"
  asyncio_mode = "auto"

  norecursedirs = "deprecated/*"


#
### mypy #############################################################################

[tool.mypy]
  files = [
    "client.py",
    "src",
    "tests"
  ]
  exclude = [
    "src/ramses_cli/client.py",
    "src/ramses_cli/utils",
    "tests/deprecated",
    "tests/wip",
  ]

  # ### Import discovery...
  # - https://mypy.readthedocs.io/en/stable/command_line.html#import-discovery

  # ignore_missing_imports = true  # only used per-module
  # follow_imports = normal  # avoid skip/silent, prefer normal (default) over error

  # ### Strict typing (--strict) if all following are set to true (excl. zxdavb)
  #  - https://mypy.readthedocs.io/en/stable/existing_code.html#introduce-stricter-options

  # # Config file & Configuring warning
  #  - https://mypy.readthedocs.io/en/stable/command_line.html#config-file

  # Start off with these
  warn_unused_configs = true
  warn_redundant_casts = true  # from: Configuring warning
  warn_unused_ignores = true  # from: Configuring warning

  # # Miscellaneous strictness flags
  #  - https://mypy.readthedocs.io/en/stable/command_line.html#miscellaneous-strictness-flags

  # Getting these passing should be easy
  extra_checks = true  # now incl.: strict_concatenate = true
  strict_equality = true

  # Strongly recommend enabling this one as soon as you can
  check_untyped_defs = true

  # allow_redefinition = false  # default is false
  no_implicit_reexport = true  # added by zxdavb

  # # Disallow dynamic typing...
  #  - https://mypy.readthedocs.io/en/stable/command_line.html#disallow-dynamic-typing

  # These shouldn't be too much additional work, but may be tricky to
  # get passing if you use a lot of untyped libraries
  disallow_subclassing_any = true
  disallow_untyped_decorators = true  # from: Untyped definitions and calls
  disallow_any_generics = true

  # disallow_any_explicit = true  # TODO: added by zxdavb

  # # Untyped definitions and calls
  #  - https://mypy.readthedocs.io/en/stable/command_line.html#untyped-definitions-and-calls

  # These next few are various gradations of forcing use of type annotations
  disallow_untyped_calls = true
  disallow_incomplete_defs = true
  disallow_untyped_defs = true

  # disallow-untyped-decorators = true  # added by zxdavb

  # This one isn't too hard to get passing, but return on investment is lower
  # no_implicit_reexport = true  # 242  # from: Miscellaneous strictness flags

  # # Configuring warnings
  #  - https://mypy.readthedocs.io/en/stable/command_line.html#configuring-warnings

  # This one can be tricky to get passing if you use a lot of untyped libraries
  warn_return_any = true

  disallow_any_unimported = true  # from: Disallow dynamic typing
  warn_no_return = true
  warn_unreachable = true

  # # None and Optional handling
  #  - https://mypy.readthedocs.io/en/stable/command_line.html#none-and-optional-handling

  no_implicit_optional = true


#
[[tool.mypy.overrides]]
  module = "ramses_tx.parsers"

  disallow_any_generics = false  # 89 - will be lots of work

[[tool.mypy.overrides]]
  module = "ramses_rf.entity_base.*"

  disallow_any_generics = false     # 14
  no_implicit_optional = false      # 12

  disable_error_code = [
    "arg-type",  #     13 (but a can of worms)
    "unreachable",  #  13 (but a can of worms)
  ]

[[tool.mypy.overrides]]
  module = "ramses_rf.device.*"

  disable_error_code = [
    "assignment",  #   18 - doable
    "return-value",  # 64
    "type-arg",  #     10 - doable
    "unreachable",  #  14
  ]

[[tool.mypy.overrides]]
  module = "ramses_rf.system.zones"

  disable_error_code = [
    "assignment",  #    6
    "unreachable",  #  10
  ]

[[tool.mypy.overrides]]
  module = "tests.*"

  disable_error_code = [
    "arg-type",  #     30
    "type-arg",  #     22
  ]

[[tool.mypy.overrides]]
  module = "tests_rf.*"

  disable_error_code = [
    "arg-type",  #     54
    "type-arg",  #     11
  ]

[[tool.mypy.overrides]]
  module = [
    "ramses_cli.*",
    "ramses_rf.*",
    "ramses_tx.parsers",
    "tests",
  ]

  disallow_any_explicit = false


#
## ruff ##############################################################################

[tool.ruff]
  exclude = ["tests/deprecated/*.py"]
  src = ["src", "tests"]
  target-version = "py312"


[tool.ruff.lint]
  select = [
    "ASYNC",  # flake8-async
    "B",  #     flake8-bugbear
    "E",  #     pycodestyle
    "F",  #     Pyflakes
    "I",  #     isort
    "SIM",  #   flake8-simplify
    "UP",  #    pyupgrade
  ]
  ignore = ["ASYNC109", "ASYNC110", "B011", "E501", "SIM102", "SIM114", "UP040"]

  # B011   - Do not call assert False since python -O removes these calls
  # E501   - Line too long
  # SIM102 - Use a single `if` statement instead of nested `if` statements
  # SIM114 - Combine `if` branches using logical `or` operator
  # UP040  - Type alias uses `TypeAlias` annotation instead of the `type` keyword


[tool.ruff.lint.flake8-import-conventions.extend-aliases]
  voluptuous = "vol"


[tool.ruff.lint.isort]
  combine-as-imports = true
  force-sort-within-sections = false
  split-on-trailing-comma = false


[tool.ruff.lint.per-file-ignores]
  "tests/*" = ["ASYNC"]