pyproject.toml

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

[project]
name = "homeassistant"
version = "2025.8.0.dev0"
license = "Apache-2.0"
license-files = ["LICENSE*", "homeassistant/backports/LICENSE*"]
description = "Open-source home automation platform running on Python 3."
readme = "README.rst"
authors = [
  { name = "The Home Assistant Authors", email = "hello@home-assistant.io" },
]
keywords = ["home", "automation"]
classifiers = [
  "Development Status :: 5 - Production/Stable",
  "Intended Audience :: End Users/Desktop",
  "Intended Audience :: Developers",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3.13",
  "Topic :: Home Automation",
]
requires-python = ">=3.13.2"
dependencies = [
  "aiodns==3.5.0",
  # Integrations may depend on hassio integration without listing it to
  # change behavior based on presence of supervisor. Deprecated with #127228
  # Lib can be removed with 2025.11
  "aiohasupervisor==0.3.1",
  "aiohttp==3.12.13",
  "aiohttp_cors==0.8.1",
  "aiohttp-fast-zlib==0.3.0",
  "aiohttp-asyncmdnsresolver==0.1.1",
  "aiozoneinfo==0.2.3",
  "annotatedyaml==0.4.5",
  "astral==2.2",
  "async-interrupt==1.2.2",
  "attrs==25.3.0",
  "atomicwrites-homeassistant==1.4.1",
  "audioop-lts==0.2.1",
  "awesomeversion==25.5.0",
  "bcrypt==4.3.0",
  "certifi>=2021.5.30",
  "ciso8601==2.3.2",
  "cronsim==2.6",
  "fnv-hash-fast==1.5.0",
  # hass-nabucasa is imported by helpers which don't depend on the cloud
  # integration
  "hass-nabucasa==0.105.0",
  # When bumping httpx, please check the version pins of
  # httpcore, anyio, and h11 in gen_requirements_all
  "httpx==0.28.1",
  "home-assistant-bluetooth==1.13.1",
  "ifaddr==0.2.0",
  "Jinja2==3.1.6",
  "lru-dict==1.3.0",
  "PyJWT==2.10.1",
  # PyJWT has loose dependency. We want the latest one.
  "cryptography==45.0.3",
  "Pillow==11.3.0",
  "propcache==0.3.2",
  "pyOpenSSL==25.1.0",
  "orjson==3.10.18",
  "packaging>=23.1",
  "psutil-home-assistant==0.0.1",
  "python-slugify==8.0.4",
  "PyYAML==6.0.2",
  "requests==2.32.4",
  "securetar==2025.2.1",
  "SQLAlchemy==2.0.41",
  "standard-aifc==3.13.0",
  "standard-telnetlib==3.13.0",
  "typing-extensions>=4.14.0,<5.0",
  "ulid-transform==1.4.0",
  "urllib3>=2.0",
  "uv==0.7.1",
  "voluptuous==0.15.2",
  "voluptuous-serialize==2.6.0",
  "voluptuous-openapi==0.1.0",
  "yarl==1.20.1",
  "webrtc-models==0.3.0",
  "zeroconf==0.147.0",
]

[project.urls]
"Homepage" = "https://www.home-assistant.io/"
"Source Code" = "https://github.com/home-assistant/core"
"Bug Reports" = "https://github.com/home-assistant/core/issues"
"Docs: Dev" = "https://developers.home-assistant.io/"
"Discord" = "https://www.home-assistant.io/join-chat/"
"Forum" = "https://community.home-assistant.io/"

[project.scripts]
hass = "homeassistant.__main__:main"

[tool.setuptools]
include-package-data = true

[tool.setuptools.packages.find]
include = ["homeassistant*"]

[tool.pylint.MAIN]
py-version = "3.13"
# Use a conservative default here; 2 should speed up most setups and not hurt
# any too bad. Override on command line as appropriate.
jobs = 2
init-hook = """\
    from pathlib import Path; \
    import sys; \

    from pylint.config import find_default_config_files; \

    sys.path.append( \
        str(Path(next(find_default_config_files())).parent.joinpath('pylint/plugins'))
    ) \
    """
load-plugins = [
  "pylint.extensions.code_style",
  "pylint.extensions.typing",
  "hass_async_load_fixtures",
  "hass_decorator",
  "hass_enforce_class_module",
  "hass_enforce_sorted_platforms",
  "hass_enforce_super_call",
  "hass_enforce_type_hints",
  "hass_inheritance",
  "hass_imports",
  "hass_logger",
  "pylint_per_file_ignores",
]
persistent = false
extension-pkg-allow-list = [
  "av.audio.stream",
  "av.logging",
  "av.stream",
  "ciso8601",
  "orjson",
  "cv2",
]
fail-on = ["I"]

[tool.pylint.BASIC]
class-const-naming-style = "any"

[tool.pylint."MESSAGES CONTROL"]
# Reasons disabled:
# format - handled by ruff
# locally-disabled - it spams too much
# duplicate-code - unavoidable
# cyclic-import - doesn't test if both import on load
# abstract-class-little-used - prevents from setting right foundation
# unused-argument - generic callbacks and setup methods create a lot of warnings
# too-many-* - are not enforced for the sake of readability
# too-few-* - same as too-many-*
# abstract-method - with intro of async there are always methods missing
# inconsistent-return-statements - doesn't handle raise
# too-many-ancestors - it's too strict.
# wrong-import-order - isort guards this
# possibly-used-before-assignment - too many errors / not necessarily issues
# ---
# Pylint CodeStyle plugin
# consider-using-namedtuple-or-dataclass - too opinionated
# consider-using-assignment-expr - decision to use := better left to devs
disable = [
  "format",
  "abstract-method",
  "cyclic-import",
  "duplicate-code",
  "inconsistent-return-statements",
  "locally-disabled",
  "not-context-manager",
  "too-few-public-methods",
  "too-many-ancestors",
  "too-many-arguments",
  "too-many-instance-attributes",
  "too-many-lines",
  "too-many-locals",
  "too-many-public-methods",
  "too-many-boolean-expressions",
  "too-many-positional-arguments",
  "wrong-import-order",
  "consider-using-namedtuple-or-dataclass",
  "consider-using-assignment-expr",
  "possibly-used-before-assignment",

  # Handled by ruff
  # Ref: <https://github.com/astral-sh/ruff/issues/970>
  "await-outside-async",    # PLE1142
  "bad-str-strip-call",     # PLE1310
  "bad-string-format-type", # PLE1307
  "bidirectional-unicode",  # PLE2502
  "continue-in-finally",    # PLE0116
  "duplicate-bases",        # PLE0241
  "misplaced-bare-raise",   # PLE0704
  "format-needs-mapping",   # F502
  "function-redefined",     # F811
  # Needed because ruff does not understand type of __all__ generated by a function
  # "invalid-all-format", # PLE0605
  "invalid-all-object",                 # PLE0604
  "invalid-character-backspace",        # PLE2510
  "invalid-character-esc",              # PLE2513
  "invalid-character-nul",              # PLE2514
  "invalid-character-sub",              # PLE2512
  "invalid-character-zero-width-space", # PLE2515
  "logging-too-few-args",               # PLE1206
  "logging-too-many-args",              # PLE1205
  "missing-format-string-key",          # F524
  "mixed-format-string",                # F506
  "no-method-argument",                 # N805
  "no-self-argument",                   # N805
  "nonexistent-operator",               # B002
  "nonlocal-without-binding",           # PLE0117
  "not-in-loop",                        # F701, F702
  "notimplemented-raised",              # F901
  "return-in-init",                     # PLE0101
  "return-outside-function",            # F706
  "syntax-error",                       # E999
  "too-few-format-args",                # F524
  "too-many-format-args",               # F522
  "too-many-star-expressions",          # F622
  "truncated-format-string",            # F501
  "undefined-all-variable",             # F822
  "undefined-variable",                 # F821
  "used-prior-global-declaration",      # PLE0118
  "yield-inside-async-function",        # PLE1700
  "yield-outside-function",             # F704
  "anomalous-backslash-in-string",      # W605
  "assert-on-string-literal",           # PLW0129
  "assert-on-tuple",                    # F631
  "bad-format-string",                  # W1302, F
  "bad-format-string-key",              # W1300, F
  "bare-except",                        # E722
  "binary-op-exception",                # PLW0711
  "cell-var-from-loop",                 # B023
  # "dangerous-default-value", # B006, ruff catches new occurrences, needs more work
  "duplicate-except",                     # B014
  "duplicate-key",                        # F601
  "duplicate-string-formatting-argument", # F
  "duplicate-value",                      # F
  "eval-used",                            # S307
  "exec-used",                            # S102
  "expression-not-assigned",              # B018
  "f-string-without-interpolation",       # F541
  "forgotten-debug-statement",            # T100
  "format-string-without-interpolation",  # F
  # "global-statement", # PLW0603, ruff catches new occurrences, needs more work
  "global-variable-not-assigned",      # PLW0602
  "implicit-str-concat",               # ISC001
  "import-outside-toplevel",           # PLC0415
  "import-self",                       # PLW0406
  "inconsistent-quotes",               # Q000
  "invalid-envvar-default",            # PLW1508
  "keyword-arg-before-vararg",         # B026
  "logging-format-interpolation",      # G
  "logging-fstring-interpolation",     # G
  "logging-not-lazy",                  # G
  "misplaced-future",                  # F404
  "named-expr-without-context",        # PLW0131
  "nested-min-max",                    # PLW3301
  "pointless-statement",               # B018
  "raise-missing-from",                # B904
  "redefined-builtin",                 # A001
  "try-except-raise",                  # TRY302
  "unused-argument",                   # ARG001, we don't use it
  "unused-format-string-argument",     #F507
  "unused-format-string-key",          # F504
  "unused-import",                     # F401
  "unused-variable",                   # F841
  "useless-else-on-loop",              # PLW0120
  "wildcard-import",                   # F403
  "bad-classmethod-argument",          # N804
  "consider-iterating-dictionary",     # SIM118
  "empty-docstring",                   # D419
  "invalid-name",                      # N815
  "line-too-long",                     # E501, disabled globally
  "missing-class-docstring",           # D101
  "missing-final-newline",             # W292
  "missing-function-docstring",        # D103
  "missing-module-docstring",          # D100
  "multiple-imports",                  #E401
  "singleton-comparison",              # E711, E712
  "subprocess-run-check",              # PLW1510
  "superfluous-parens",                # UP034
  "ungrouped-imports",                 # I001
  "unidiomatic-typecheck",             # E721
  "unnecessary-direct-lambda-call",    # PLC3002
  "unnecessary-lambda-assignment",     # PLC3001
  "unnecessary-pass",                  # PIE790
  "unneeded-not",                      # SIM208
  "useless-import-alias",              # PLC0414
  "wrong-import-order",                # I001
  "wrong-import-position",             # E402
  "comparison-of-constants",           # PLR0133
  "comparison-with-itself",            # PLR0124
  "consider-alternative-union-syntax", # UP007
  "consider-merging-isinstance",       # PLR1701
  "consider-using-alias",              # UP006
  "consider-using-dict-comprehension", # C402
  "consider-using-generator",          # C417
  "consider-using-get",                # SIM401
  "consider-using-set-comprehension",  # C401
  "consider-using-sys-exit",           # PLR1722
  "consider-using-ternary",            # SIM108
  "literal-comparison",                # F632
  "property-with-parameters",          # PLR0206
  "super-with-arguments",              # UP008
  "too-many-branches",                 # PLR0912
  "too-many-return-statements",        # PLR0911
  "too-many-statements",               # PLR0915
  "trailing-comma-tuple",              # COM818
  "unnecessary-comprehension",         # C416
  "use-a-generator",                   # C417
  "use-dict-literal",                  # C406
  "use-list-literal",                  # C405
  "useless-object-inheritance",        # UP004
  "useless-return",                    # PLR1711
  "no-else-break",                     # RET508
  "no-else-continue",                  # RET507
  "no-else-raise",                     # RET506
  "no-else-return",                    # RET505
  "broad-except",                      # BLE001
  "protected-access",                  # SLF001
  "broad-exception-raised",            # TRY002
  "consider-using-f-string",           # PLC0209
  # "no-self-use", # PLR6301  # Optional plugin, not enabled

  # Handled by mypy
  # Ref: <https://github.com/antonagestam/pylint-mypy-overlap>
  "abstract-class-instantiated",
  "arguments-differ",
  "assigning-non-slot",
  "assignment-from-no-return",
  "assignment-from-none",
  "bad-exception-cause",
  "bad-format-character",
  "bad-reversed-sequence",
  "bad-super-call",
  "bad-thread-instantiation",
  "catching-non-exception",
  "comparison-with-callable",
  "deprecated-class",
  "dict-iter-missing-items",
  "format-combined-specification",
  "global-variable-undefined",
  "import-error",
  "inconsistent-mro",
  "inherit-non-class",
  "init-is-generator",
  "invalid-class-object",
  "invalid-enum-extension",
  "invalid-envvar-value",
  "invalid-format-returned",
  "invalid-hash-returned",
  "invalid-metaclass",
  "invalid-overridden-method",
  "invalid-repr-returned",
  "invalid-sequence-index",
  "invalid-slice-index",
  "invalid-slots-object",
  "invalid-slots",
  "invalid-star-assignment-target",
  "invalid-str-returned",
  "invalid-unary-operand-type",
  "invalid-unicode-codec",
  "isinstance-second-argument-not-valid-type",
  "method-hidden",
  "misplaced-format-function",
  "missing-format-argument-key",
  "missing-format-attribute",
  "missing-kwoa",
  "no-member",
  "no-value-for-parameter",
  "non-iterator-returned",
  "non-str-assignment-to-dunder-name",
  "nonlocal-and-global",
  "not-a-mapping",
  "not-an-iterable",
  "not-async-context-manager",
  "not-callable",
  "not-context-manager",
  "overridden-final-method",
  "raising-bad-type",
  "raising-non-exception",
  "redundant-keyword-arg",
  "relative-beyond-top-level",
  "self-cls-assignment",
  "signature-differs",
  "star-needs-assignment-target",
  "subclassed-final-class",
  "super-without-brackets",
  "too-many-function-args",
  "typevar-double-variance",
  "typevar-name-mismatch",
  "unbalanced-dict-unpacking",
  "unbalanced-tuple-unpacking",
  "unexpected-keyword-arg",
  "unhashable-member",
  "unpacking-non-sequence",
  "unsubscriptable-object",
  "unsupported-assignment-operation",
  "unsupported-binary-operation",
  "unsupported-delete-operation",
  "unsupported-membership-test",
  "used-before-assignment",
  "using-final-decorator-in-unsupported-version",
  "wrong-exception-operation",
]
enable = [
  #"useless-suppression",  # temporarily every now and then to clean them up
  "use-symbolic-message-instead",
]
per-file-ignores = [
  # redefined-outer-name: Tests reference fixtures in the test function
  # use-implicit-booleaness-not-comparison: Tests need to validate that a list
  # or a dict is returned
  "/tests/:redefined-outer-name,use-implicit-booleaness-not-comparison",
]

[tool.pylint.REPORTS]
score = false

[tool.pylint.TYPECHECK]
ignored-classes = [
  "_CountingAttr", # for attrs
]
mixin-class-rgx = ".*[Mm]ix[Ii]n"

[tool.pylint.FORMAT]
expected-line-ending-format = "LF"

[tool.pylint.EXCEPTIONS]
overgeneral-exceptions = [
  "builtins.BaseException",
  "builtins.Exception",
  # "homeassistant.exceptions.HomeAssistantError",  # too many issues
]

[tool.pylint.TYPING]
runtime-typing = false

[tool.pylint.CODE_STYLE]
max-line-length-suggestions = 72

[tool.pytest.ini_options]
testpaths = ["tests"]
norecursedirs = [".git", "testing_config"]
log_format = "%(asctime)s.%(msecs)03d %(levelname)-8s %(threadName)s %(name)s:%(filename)s:%(lineno)s %(message)s"
log_date_format = "%Y-%m-%d %H:%M:%S"
asyncio_mode = "auto"
asyncio_default_fixture_loop_scope = "function"
filterwarnings = [
  "error::sqlalchemy.exc.SAWarning",
  "error:usefixtures\\(\\) in .* without arguments has no effect:UserWarning", # pytest

  # -- HomeAssistant - aiohttp
  # Overwrite web.Application to pass a custom default argument to _make_request
  "ignore:Inheritance class HomeAssistantApplication from web.Application is discouraged:DeprecationWarning",
  # Hass wraps `ClientSession.close` to emit a warning if the session is closed accidentally
  "ignore:Setting custom ClientSession.close attribute is discouraged:DeprecationWarning:homeassistant.helpers.aiohttp_client",
  # Modify app state for testing
  "ignore:Changing state of started or joined application is deprecated:DeprecationWarning:tests.components.http.test_ban",

  # -- Tests
  # Ignore custom pytest marks
  "ignore:Unknown pytest.mark.disable_autouse_fixture:pytest.PytestUnknownMarkWarning:tests.components.met",
  "ignore:Unknown pytest.mark.dataset:pytest.PytestUnknownMarkWarning:tests.components.screenlogic",

  # -- DeprecationWarning already fixed in our codebase
  # https://github.com/kurtmckee/feedparser/pull/389 - 6.0.11
  "ignore:.*a temporary mapping .* from `updated_parsed` to `published_parsed` if `updated_parsed` doesn't exist:DeprecationWarning:feedparser.util",

  # -- design choice 3rd party
  # https://github.com/gwww/elkm1/blob/2.2.11/elkm1_lib/util.py#L8-L19
  "ignore:ssl.TLSVersion.TLSv1 is deprecated:DeprecationWarning:elkm1_lib.util",
  # https://github.com/bachya/regenmaschine/blob/2024.03.0/regenmaschine/client.py#L52
  "ignore:ssl.TLSVersion.SSLv3 is deprecated:DeprecationWarning:regenmaschine.client",

  # -- Setuptools DeprecationWarnings
  # https://github.com/googleapis/google-cloud-python/issues/11184
  # https://github.com/zopefoundation/meta/issues/194
  # https://github.com/Azure/azure-sdk-for-python
  "ignore:Deprecated call to `pkg_resources.declare_namespace\\(('azure'|'google.*'|'pywinusb'|'repoze'|'xbox'|'zope')\\)`:DeprecationWarning:pkg_resources",

  # -- tracked upstream / open PRs
  # https://github.com/hacf-fr/meteofrance-api/pull/688 - v1.4.0 - 2025-03-26
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:meteofrance_api.model.forecast",

  # -- fixed, waiting for release / update
  # https://github.com/DataDog/datadogpy/pull/290 - >=0.23.0
  "ignore:.*invalid escape sequence:SyntaxWarning:.*datadog.dogstatsd.base",
  # https://github.com/DataDog/datadogpy/pull/566/files - >=0.37.0
  "ignore:pkg_resources is deprecated as an API:UserWarning:datadog.util.compat",
  # https://github.com/httplib2/httplib2/pull/226 - >=0.21.0
  "ignore:ssl.PROTOCOL_TLS is deprecated:DeprecationWarning:httplib2",
  # https://github.com/vacanza/python-holidays/discussions/1800 - >1.0.0
  "ignore::DeprecationWarning:holidays",
  # https://github.com/ReactiveX/RxPY/pull/716 - >4.0.4
  "ignore:datetime.*utcfromtimestamp\\(\\) is deprecated and scheduled for removal:DeprecationWarning:reactivex.internal.constants",
  # https://github.com/postlund/pyatv/issues/2645 - >0.16.0
  # https://github.com/postlund/pyatv/pull/2664
  "ignore:Protobuf gencode .* exactly one major version older than the runtime version 6.* at pyatv:UserWarning:google.protobuf.runtime_version",
  # https://github.com/rytilahti/python-miio/pull/1809 - >=0.6.0.dev0
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:miio.protocol",
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:miio.miioprotocol",
  # https://github.com/rytilahti/python-miio/pull/1993 - >0.6.0.dev0
  "ignore:functools.partial will be a method descriptor in future Python versions; wrap it in enum.member\\(\\) if you want to preserve the old behavior:FutureWarning:miio.miot_device",
  # https://github.com/okunishinishi/python-stringcase/commit/6a5c5bbd3fe5337862abc7fd0853a0f36e18b2e1 - >1.2.0
  "ignore:.*invalid escape sequence:SyntaxWarning:.*stringcase",
  # https://github.com/xchwarze/samsung-tv-ws-api/pull/151 - >2.7.2 - 2024-12-06  # wrong stacklevel in aiohttp
  "ignore:verify_ssl is deprecated, use ssl=False instead:DeprecationWarning:aiohttp.client",

  # -- other
  # Locale changes might take some time to resolve upstream
  # https://github.com/Squachen/micloud/blob/v_0.6/micloud/micloud.py#L35 - v0.6 - 2022-12-08
  "ignore:'locale.getdefaultlocale' is deprecated and slated for removal in Python 3.15:DeprecationWarning:micloud.micloud",
  # https://pypi.org/project/agent-py/ - v0.0.24 - 2024-11-07
  "ignore:with timeout\\(\\) is deprecated:DeprecationWarning:agent.a",
  # https://github.com/MatsNl/pyatag/issues/11 - v0.3.7.1 - 2023-10-09
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:pyatag.gateway",
  # https://github.com/lidatong/dataclasses-json/issues/328
  # https://github.com/lidatong/dataclasses-json/pull/351
  "ignore:The 'default' argument to fields is deprecated. Use 'dump_default' instead:DeprecationWarning:dataclasses_json.mm",
  # https://pypi.org/project/emulated-roku/ - v0.3.0 - 2023-12-19
  # https://github.com/martonperei/emulated_roku
  "ignore:loop argument is deprecated:DeprecationWarning:emulated_roku",
  # https://pypi.org/project/foobot_async/ - v1.0.1 - 2024-08-16
  "ignore:with timeout\\(\\) is deprecated:DeprecationWarning:foobot_async",
  # https://pypi.org/project/pyeconet/ - v0.1.28 - 2025-02-15
  # https://github.com/w1ll1am23/pyeconet/blob/v0.1.28/src/pyeconet/api.py#L38
  "ignore:ssl.PROTOCOL_TLS is deprecated:DeprecationWarning:pyeconet.api",
  # https://github.com/thecynic/pylutron - v0.2.18 - 2025-04-15
  "ignore:setDaemon\\(\\) is deprecated, set the daemon attribute instead:DeprecationWarning:pylutron",
  # https://pypi.org/project/PyMetEireann/ - v2024.11.0 - 2024-11-23
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:meteireann",
  # https://github.com/pschmitt/pynuki/blob/1.6.3/pynuki/utils.py#L21 - v1.6.3 - 2024-02-24
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:pynuki.utils",
  # https://github.com/lextudio/pysnmp/blob/v7.1.21/pysnmp/smi/compiler.py#L23-L31 - v7.1.21 - 2025-06-19
  "ignore:smiV1Relaxed is deprecated. Please use smi_v1_relaxed instead:DeprecationWarning:pysnmp.smi.compiler",
  "ignore:getReadersFromUrls is deprecated. Please use get_readers_from_urls instead:DeprecationWarning:pysnmp.smi.compiler",
  # https://github.com/Python-roborock/python-roborock/issues/305 - 2.19.0 - 2025-05-13
  "ignore:Callback API version 1 is deprecated, update to latest version:DeprecationWarning:roborock.cloud_api",
  # https://github.com/briis/pyweatherflowudp/blob/v1.4.5/pyweatherflowudp/const.py#L20 - v1.4.5 - 2023-10-10
  "ignore:This function will be removed in future versions of pint:DeprecationWarning:pyweatherflowudp.const",
  # New in aiohttp - v3.9.0
  "ignore:It is recommended to use web.AppKey instances for keys:UserWarning:(homeassistant|tests|aiohttp_cors)",
  # - SyntaxWarnings
  # https://pypi.org/project/aprslib/ - v0.7.2 - 2022-07-10
  "ignore:.*invalid escape sequence:SyntaxWarning:.*aprslib.parsing.common",
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:aprslib.parsing.common",
  # https://pypi.org/project/panasonic-viera/ - v0.4.2 - 2024-04-24
  # https://github.com/florianholzapfel/panasonic-viera/blob/0.4.2/panasonic_viera/__init__.py#L789
  "ignore:.*invalid escape sequence:SyntaxWarning:.*panasonic_viera",
  # https://pypi.org/project/pyblackbird/ - v0.6 - 2023-03-15
  # https://github.com/koolsb/pyblackbird/pull/9 -> closed
  "ignore:.*invalid escape sequence:SyntaxWarning:.*pyblackbird",
  # https://pypi.org/project/pyws66i/ - v1.1 - 2022-04-05
  "ignore:.*invalid escape sequence:SyntaxWarning:.*pyws66i",
  # https://pypi.org/project/sanix/ - v1.0.6 - 2024-05-01
  # https://github.com/tomaszsluszniak/sanix_py/blob/v1.0.6/sanix/__init__.py#L42
  "ignore:.*invalid escape sequence:SyntaxWarning:.*sanix",
  # https://pypi.org/project/sleekxmppfs/ - v1.4.1 - 2022-08-18
  "ignore:.*invalid escape sequence:SyntaxWarning:.*sleekxmppfs.thirdparty.mini_dateutil", # codespell:ignore thirdparty
  # - pkg_resources
  # https://pypi.org/project/aiomusiccast/ - v0.14.8 - 2023-03-20
  "ignore:pkg_resources is deprecated as an API:UserWarning:aiomusiccast",
  # https://github.com/eavanvalkenburg/pysiaalarm/blob/v3.1.1/src/pysiaalarm/data/data.py#L7 - v3.1.1 - 2023-04-17
  "ignore:pkg_resources is deprecated as an API:UserWarning:pysiaalarm.data.data",
  # https://pypi.org/project/pybotvac/ - v0.0.28 - 2025-06-11
  "ignore:pkg_resources is deprecated as an API:UserWarning:pybotvac.version",
  # https://github.com/home-assistant-ecosystem/python-mystrom/blob/2.2.0/pymystrom/__init__.py#L10 - v2.2.0 - 2023-05-21
  "ignore:pkg_resources is deprecated as an API:UserWarning:pymystrom",
  # - SyntaxWarning - is with literal
  # https://github.com/majuss/lupupy/pull/15 - >0.3.2
  # https://pypi.org/project/opuslib/ - v3.0.1 - 2018-01-16
  # https://pypi.org/project/plumlightpad/ - v0.0.11 - 2018-10-16
  # https://pypi.org/project/pyiss/ - v1.0.1 - 2016-12-19
  "ignore:\"is.*\" with '.*' literal:SyntaxWarning:importlib._bootstrap",

  # -- New in Python 3.13
  # https://github.com/kurtmckee/feedparser/pull/389 - >6.0.11
  # https://github.com/kurtmckee/feedparser/issues/481
  "ignore:'count' is passed as positional argument:DeprecationWarning:feedparser.html",
  # https://github.com/youknowone/python-deadlib - Backports for aifc, telnetlib
  "ignore:aifc was removed in Python 3.13.*'standard-aifc':DeprecationWarning:speech_recognition",
  "ignore:telnetlib was removed in Python 3.13.*'standard-telnetlib':DeprecationWarning:homeassistant.components.hddtemp.sensor",
  "ignore:telnetlib was removed in Python 3.13.*'standard-telnetlib':DeprecationWarning:ndms2_client.connection",
  "ignore:telnetlib was removed in Python 3.13.*'standard-telnetlib':DeprecationWarning:plumlightpad.lightpad",
  "ignore:telnetlib was removed in Python 3.13.*'standard-telnetlib':DeprecationWarning:pyws66i",

  # -- Websockets 14.1
  # https://websockets.readthedocs.io/en/stable/howto/upgrade.html
  "ignore:websockets.legacy is deprecated:DeprecationWarning:websockets.legacy",
  # https://github.com/bluecurrent/HomeAssistantAPI/pull/19 - >=1.2.4
  "ignore:websockets.client.connect is deprecated:DeprecationWarning:bluecurrent_api.websocket",
  "ignore:websockets.client.WebSocketClientProtocol is deprecated:DeprecationWarning:bluecurrent_api.websocket",
  "ignore:websockets.exceptions.InvalidStatusCode is deprecated:DeprecationWarning:bluecurrent_api.websocket",
  # https://github.com/graphql-python/gql/pull/543 - >=4.0.0a0
  "ignore:websockets.client.WebSocketClientProtocol is deprecated:DeprecationWarning:gql.transport.websockets_base",

  # -- unmaintained projects, last release about 2+ years
  # https://pypi.org/project/aiomodernforms/ - v0.1.8 - 2021-06-27
  "ignore:with timeout\\(\\) is deprecated:DeprecationWarning:aiomodernforms.modernforms",
  # https://pypi.org/project/directv/ - v0.4.0 - 2020-09-12
  "ignore:with timeout\\(\\) is deprecated:DeprecationWarning:directv.directv",
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:directv.models",
  # https://pypi.org/project/enocean/ - v0.50.1 (installed) -> v0.60.1 - 2021-06-18
  "ignore:It looks like you're using an HTML parser to parse an XML document:UserWarning:enocean.protocol.eep",
  # https://pypi.org/project/influxdb/ - v5.3.2 - 2024-04-18 (archived)
  "ignore:datetime.*utcfromtimestamp\\(\\) is deprecated and scheduled for removal:DeprecationWarning:influxdb.line_protocol",
  # https://pypi.org/project/lark-parser/ - v0.12.0 - 2021-08-30 -> moved to `lark`
  # https://pypi.org/project/commentjson/ - v0.9.0 - 2020-10-05
  # https://github.com/vaidik/commentjson/issues/51
  # https://github.com/vaidik/commentjson/pull/52
  # Fixed upstream, commentjson depends on old version and seems to be unmaintained
  "ignore:module '(sre_parse|sre_constants)' is deprecate:DeprecationWarning:lark.utils",
  # https://pypi.org/project/lomond/ - v0.3.3 - 2018-09-21
  "ignore:ssl.PROTOCOL_TLS is deprecated:DeprecationWarning:lomond.session",
  # https://pypi.org/project/oauth2client/ - v4.1.3 - 2018-09-07 (archived)
  "ignore:datetime.*utcnow\\(\\) is deprecated and scheduled for removal:DeprecationWarning:oauth2client.client",
  # https://pypi.org/project/pilight/ - v0.1.1 - 2016-10-19
  "ignore:pkg_resources is deprecated as an API:UserWarning:pilight",
  # https://pypi.org/project/plumlightpad/ - v0.0.11 - 2018-10-16
  "ignore:.*invalid escape sequence:SyntaxWarning:.*plumlightpad.plumdiscovery",
  # https://pypi.org/project/pure-python-adb/ - v0.3.0.dev0 - 2020-08-05
  "ignore:.*invalid escape sequence:SyntaxWarning:.*ppadb",
  # https://pypi.org/project/pydub/ - v0.25.1 - 2021-03-10
  "ignore:.*invalid escape sequence:SyntaxWarning:.*pydub.utils",
  # https://pypi.org/project/PyPasser/ - v0.0.5 - 2021-10-21
  "ignore:.*invalid escape sequence:SyntaxWarning:.*pypasser.utils",
  # https://pypi.org/project/pyqwikswitch/ - v0.94 - 2019-08-19
  "ignore:client.loop property is deprecated:DeprecationWarning:pyqwikswitch.async_",
  "ignore:with timeout\\(\\) is deprecated:DeprecationWarning:pyqwikswitch.async_",
  # https://pypi.org/project/rxv/ - v0.7.0 - 2021-10-10
  "ignore:defusedxml.cElementTree is deprecated, import from defusedxml.ElementTree instead:DeprecationWarning:rxv.ssdp",
]

[tool.coverage.run]
source = ["homeassistant"]

[tool.coverage.report]
exclude_lines = [
  # Have to re-enable the standard pragma
  "pragma: no cover",
  # Don't complain about missing debug-only code:
  "def __repr__",
  # Don't complain if tests don't hit defensive assertion code:
  "raise AssertionError",
  "raise NotImplementedError",
  # TYPE_CHECKING and @overload blocks are never executed during pytest run
  "if TYPE_CHECKING:",
  "@overload",
]

[tool.ruff]
required-version = ">=0.11.0"

[tool.ruff.lint]
select = [
  "A001",   # Variable {name} is shadowing a Python builtin
  "ASYNC",  # flake8-async
  "B002",   # Python does not support the unary prefix increment
  "B005",   # Using .strip() with multi-character strings is misleading
  "B007",   # Loop control variable {name} not used within loop body
  "B009",   # Do not call getattr with a constant attribute value. It is not any safer than normal property access.
  "B014",   # Exception handler with duplicate exception
  "B015",   # Pointless comparison. Did you mean to assign a value? Otherwise, prepend assert or remove it.
  "B017",   # pytest.raises(BaseException) should be considered evil
  "B018",   # Found useless attribute access. Either assign it to a variable or remove it.
  "B023",   # Function definition does not bind loop variable {name}
  "B024",   # `{name}` is an abstract base class, but it has no abstract methods or properties
  "B026",   # Star-arg unpacking after a keyword argument is strongly discouraged
  "B032",   # Possible unintentional type annotation (using :). Did you mean to assign (using =)?
  "B035",   # Dictionary comprehension uses static key
  "B904",   # Use raise from to specify exception cause
  "B905",   # zip() without an explicit strict= parameter
  "BLE",
  "C",      # complexity
  "COM818", # Trailing comma on bare tuple prohibited
  "D",      # docstrings
  "DTZ003", # Use datetime.now(tz=) instead of datetime.utcnow()
  "DTZ004", # Use datetime.fromtimestamp(ts, tz=) instead of datetime.utcfromtimestamp(ts)
  "E",      # pycodestyle
  "F",      # pyflakes/autoflake
  "F541",   # f-string without any placeholders
  "FLY",    # flynt
  "FURB",   # refurb
  "G",      # flake8-logging-format
  "I",      # isort
  "INP",    # flake8-no-pep420
  "ISC",    # flake8-implicit-str-concat
  "ICN001", # import concentions; {name} should be imported as {asname}
  "LOG",    # flake8-logging
  "N804",   # First argument of a class method should be named cls
  "N805",   # First argument of a method should be named self
  "N815",   # Variable {name} in class scope should not be mixedCase
  "PERF",   # Perflint
  "PGH",    # pygrep-hooks
  "PIE",    # flake8-pie
  "PL",     # pylint
  "PT",     # flake8-pytest-style
  "PTH",    # flake8-pathlib
  "PYI",    # flake8-pyi
  "RET",    # flake8-return
  "RSE",    # flake8-raise
  "RUF005", # Consider iterable unpacking instead of concatenation
  "RUF006", # Store a reference to the return value of asyncio.create_task
  "RUF007", # Prefer itertools.pairwise() over zip() when iterating over successive pairs
  "RUF008", # Do not use mutable default values for dataclass attributes
  "RUF010", # Use explicit conversion flag
  "RUF013", # PEP 484 prohibits implicit Optional
  "RUF016", # Slice in indexed access to type {value_type} uses type {index_type} instead of an integer
  "RUF017", # Avoid quadratic list summation
  "RUF018", # Avoid assignment expressions in assert statements
  "RUF019", # Unnecessary key check before dictionary access
  "RUF020", # {never_like} | T is equivalent to T
  "RUF021", # Parenthesize a and b expressions when chaining and and or together, to make the precedence clear
  "RUF022", # Sort __all__
  "RUF023", # Sort __slots__
  "RUF024", # Do not pass mutable objects as values to dict.fromkeys
  "RUF026", # default_factory is a positional-only argument to defaultdict
  "RUF030", # print() call in assert statement is likely unintentional
  "RUF032", # Decimal() called with float literal argument
  "RUF033", # __post_init__ method with argument defaults
  "RUF034", # Useless if-else condition
  "RUF100", # Unused `noqa` directive
  "RUF101", # noqa directives that use redirected rule codes
  "RUF200", # Failed to parse pyproject.toml: {message}
  "S102",   # Use of exec detected
  "S103",   # bad-file-permissions
  "S108",   # hardcoded-temp-file
  "S306",   # suspicious-mktemp-usage
  "S307",   # suspicious-eval-usage
  "S313",   # suspicious-xmlc-element-tree-usage
  "S314",   # suspicious-xml-element-tree-usage
  "S315",   # suspicious-xml-expat-reader-usage
  "S316",   # suspicious-xml-expat-builder-usage
  "S317",   # suspicious-xml-sax-usage
  "S318",   # suspicious-xml-mini-dom-usage
  "S319",   # suspicious-xml-pull-dom-usage
  "S601",   # paramiko-call
  "S602",   # subprocess-popen-with-shell-equals-true
  "S604",   # call-with-shell-equals-true
  "S608",   # hardcoded-sql-expression
  "S609",   # unix-command-wildcard-injection
  "SIM",    # flake8-simplify
  "SLF",    # flake8-self
  "SLOT",   # flake8-slots
  "T100",   # Trace found: {name} used
  "T20",    # flake8-print
  "TC",     # flake8-type-checking
  "TID",    # Tidy imports
  "TRY",    # tryceratops
  "UP",     # pyupgrade
  "UP031",  # Use format specifiers instead of percent format
  "UP032",  # Use f-string instead of `format` call
  "W",      # pycodestyle
]

ignore = [
  "ASYNC109", # Async function definition with a `timeout` parameter Use `asyncio.timeout` instead
  "ASYNC110", # Use `asyncio.Event` instead of awaiting `asyncio.sleep` in a `while` loop
  "D202",     # No blank lines allowed after function docstring
  "D203",     # 1 blank line required before class docstring
  "D213",     # Multi-line docstring summary should start at the second line
  "D406",     # Section name should end with a newline
  "D407",     # Section name underlining
  "E501",     # line too long

  "PLC1901", # {existing} can be simplified to {replacement} as an empty string is falsey; too many false positives
  "PLR0911", # Too many return statements ({returns} > {max_returns})
  "PLR0912", # Too many branches ({branches} > {max_branches})
  "PLR0913", # Too many arguments to function call ({c_args} > {max_args})
  "PLR0915", # Too many statements ({statements} > {max_statements})
  "PLR2004", # Magic value used in comparison, consider replacing {value} with a constant variable
  "PLW1641", # __eq__ without __hash__
  "PLW2901", # Outer {outer_kind} variable {name} overwritten by inner {inner_kind} target
  "PT011",   # pytest.raises({exception}) is too broad, set the `match` parameter or use a more specific exception
  "PT018",   # Assertion should be broken down into multiple parts
  "RUF001",  # String contains ambiguous unicode character.
  "RUF002",  # Docstring contains ambiguous unicode character.
  "RUF003",  # Comment contains ambiguous unicode character.
  "RUF015",  # Prefer next(...) over single element slice
  "SIM102",  # Use a single if statement instead of nested if statements
  "SIM103",  # Return the condition {condition} directly
  "SIM108",  # Use ternary operator {contents} instead of if-else-block
  "SIM115",  # Use context handler for opening files

  # Moving imports into type-checking blocks can mess with pytest.patch()
  "TC001", # Move application import {} into a type-checking block
  "TC002", # Move third-party import {} into a type-checking block
  "TC003", # Move standard library import {} into a type-checking block
  # Quotes for typing.cast generally not necessary, only for performance critical paths
  "TC006", # Add quotes to type expression in typing.cast()

  "TRY003", # Avoid specifying long messages outside the exception class
  "TRY400", # Use `logging.exception` instead of `logging.error`
  # Ignored due to performance: https://github.com/charliermarsh/ruff/issues/2923
  "UP038", # Use `X | Y` in `isinstance` call instead of `(X, Y)`
  "UP046", # Non PEP 695 generic class
  "UP047", # Non PEP 696 generic function
  "UP049", # Avoid private type parameter names

  # May conflict with the formatter, https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
  "W191",
  "E111",
  "E114",
  "E117",
  "D206",
  "D300",
  "Q",
  "COM812",
  "COM819",

  # Disabled because ruff does not understand type of __all__ generated by a function
  "PLE0605",
]

[tool.ruff.lint.flake8-import-conventions.extend-aliases]
voluptuous = "vol"
"homeassistant.components.air_quality.PLATFORM_SCHEMA" = "AIR_QUALITY_PLATFORM_SCHEMA"
"homeassistant.components.alarm_control_panel.PLATFORM_SCHEMA" = "ALARM_CONTROL_PANEL_PLATFORM_SCHEMA"
"homeassistant.components.binary_sensor.PLATFORM_SCHEMA" = "BINARY_SENSOR_PLATFORM_SCHEMA"
"homeassistant.components.button.PLATFORM_SCHEMA" = "BUTTON_PLATFORM_SCHEMA"
"homeassistant.components.calendar.PLATFORM_SCHEMA" = "CALENDAR_PLATFORM_SCHEMA"
"homeassistant.components.camera.PLATFORM_SCHEMA" = "CAMERA_PLATFORM_SCHEMA"
"homeassistant.components.climate.PLATFORM_SCHEMA" = "CLIMATE_PLATFORM_SCHEMA"
"homeassistant.components.conversation.PLATFORM_SCHEMA" = "CONVERSATION_PLATFORM_SCHEMA"
"homeassistant.components.cover.PLATFORM_SCHEMA" = "COVER_PLATFORM_SCHEMA"
"homeassistant.components.date.PLATFORM_SCHEMA" = "DATE_PLATFORM_SCHEMA"
"homeassistant.components.datetime.PLATFORM_SCHEMA" = "DATETIME_PLATFORM_SCHEMA"
"homeassistant.components.device_tracker.PLATFORM_SCHEMA" = "DEVICE_TRACKER_PLATFORM_SCHEMA"
"homeassistant.components.event.PLATFORM_SCHEMA" = "EVENT_PLATFORM_SCHEMA"
"homeassistant.components.fan.PLATFORM_SCHEMA" = "FAN_PLATFORM_SCHEMA"
"homeassistant.components.geo_location.PLATFORM_SCHEMA" = "GEO_LOCATION_PLATFORM_SCHEMA"
"homeassistant.components.humidifier.PLATFORM_SCHEMA" = "HUMIDIFIER_PLATFORM_SCHEMA"
"homeassistant.components.image.PLATFORM_SCHEMA" = "IMAGE_PLATFORM_SCHEMA"
"homeassistant.components.image_processing.PLATFORM_SCHEMA" = "IMAGE_PROCESSING_PLATFORM_SCHEMA"
"homeassistant.components.lawn_mower.PLATFORM_SCHEMA" = "LAWN_MOWER_PLATFORM_SCHEMA"
"homeassistant.components.light.PLATFORM_SCHEMA" = "LIGHT_PLATFORM_SCHEMA"
"homeassistant.components.lock.PLATFORM_SCHEMA" = "LOCK_PLATFORM_SCHEMA"
"homeassistant.components.media_player.PLATFORM_SCHEMA" = "MEDIA_PLAYER_PLATFORM_SCHEMA"
"homeassistant.components.notify.PLATFORM_SCHEMA" = "NOTIFY_PLATFORM_SCHEMA"
"homeassistant.components.number.PLATFORM_SCHEMA" = "NUMBER_PLATFORM_SCHEMA"
"homeassistant.components.remote.PLATFORM_SCHEMA" = "REMOTE_PLATFORM_SCHEMA"
"homeassistant.components.scene.PLATFORM_SCHEMA" = "SCENE_PLATFORM_SCHEMA"
"homeassistant.components.select.PLATFORM_SCHEMA" = "SELECT_PLATFORM_SCHEMA"
"homeassistant.components.sensor.PLATFORM_SCHEMA" = "SENSOR_PLATFORM_SCHEMA"
"homeassistant.components.siren.PLATFORM_SCHEMA" = "SIREN_PLATFORM_SCHEMA"
"homeassistant.components.stt.PLATFORM_SCHEMA" = "STT_PLATFORM_SCHEMA"
"homeassistant.components.switch.PLATFORM_SCHEMA" = "SWITCH_PLATFORM_SCHEMA"
"homeassistant.components.text.PLATFORM_SCHEMA" = "TEXT_PLATFORM_SCHEMA"
"homeassistant.components.time.PLATFORM_SCHEMA" = "TIME_PLATFORM_SCHEMA"
"homeassistant.components.todo.PLATFORM_SCHEMA" = "TODO_PLATFORM_SCHEMA"
"homeassistant.components.tts.PLATFORM_SCHEMA" = "TTS_PLATFORM_SCHEMA"
"homeassistant.components.vacuum.PLATFORM_SCHEMA" = "VACUUM_PLATFORM_SCHEMA"
"homeassistant.components.valve.PLATFORM_SCHEMA" = "VALVE_PLATFORM_SCHEMA"
"homeassistant.components.update.PLATFORM_SCHEMA" = "UPDATE_PLATFORM_SCHEMA"
"homeassistant.components.wake_word.PLATFORM_SCHEMA" = "WAKE_WORD_PLATFORM_SCHEMA"
"homeassistant.components.water_heater.PLATFORM_SCHEMA" = "WATER_HEATER_PLATFORM_SCHEMA"
"homeassistant.components.weather.PLATFORM_SCHEMA" = "WEATHER_PLATFORM_SCHEMA"
"homeassistant.core.DOMAIN" = "HOMEASSISTANT_DOMAIN"
"homeassistant.helpers.area_registry" = "ar"
"homeassistant.helpers.category_registry" = "cr"
"homeassistant.helpers.config_validation" = "cv"
"homeassistant.helpers.device_registry" = "dr"
"homeassistant.helpers.entity_registry" = "er"
"homeassistant.helpers.floor_registry" = "fr"
"homeassistant.helpers.issue_registry" = "ir"
"homeassistant.helpers.label_registry" = "lr"
"homeassistant.util.color" = "color_util"
"homeassistant.util.dt" = "dt_util"
"homeassistant.util.json" = "json_util"
"homeassistant.util.location" = "location_util"
"homeassistant.util.logging" = "logging_util"
"homeassistant.util.network" = "network_util"
"homeassistant.util.ulid" = "ulid_util"
"homeassistant.util.uuid" = "uuid_util"
"homeassistant.util.yaml" = "yaml_util"

[tool.ruff.lint.flake8-pytest-style]
fixture-parentheses = false
mark-parentheses = false

[tool.ruff.lint.flake8-tidy-imports.banned-api]
"async_timeout".msg = "use asyncio.timeout instead"
"pytz".msg = "use zoneinfo instead"
"tests".msg = "You should not import tests"

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

[tool.ruff.lint.per-file-ignores]

# Allow for main entry & scripts to write to stdout
"homeassistant/__main__.py" = ["T201"]
"homeassistant/scripts/*" = ["T201"]
"script/*" = ["T20"]

# Allow relative imports within auth and within components
"homeassistant/auth/*/*" = ["TID252"]
"homeassistant/components/*/*/*" = ["TID252"]
"tests/components/*/*/*" = ["TID252"]

# Temporary
"homeassistant/**" = ["PTH"]
"tests/**" = ["PTH"]

[tool.ruff.lint.mccabe]
max-complexity = 25

[tool.ruff.lint.pydocstyle]
convention = "google"
property-decorators = ["propcache.api.cached_property"]