Skip to main content

PEP 484 typing stubs for Home Assistant Core

Project description

CI PyPI version

PEP 484 stubs for Home Assistant Core

This is unofficial stub-only package generated from Home Assistant Core sources. You can use it to enable type checks against Home Assistant code in your custom component or AppDaemon app.

How to use

Add it to dev dependencies of your project. I recommend to use uv for managing dependencies:

uv add --dev homeassistant-stubs

Please note that only stubs from strictly typed modules are added in this package. This includes all core modules and some components. Generic components like sensor, light or media_player are already typed.

If your project imports not yet typed components, mypy will be unable to find that module. The best thing you can do to fix this is to submit PR to HA Core which adds type hints for these components. After that stubs for these components will become available in this package.

Motivation

Home Assistant maintainers don't want to distribute typing information with homeassistant package ([1], [2]). The reason is that PEP 561 says that py.typed marker is applied recursively and the whole package must support type checking. But many of the Home Assistant components are currently not type checked.

How it works

  • update_stubs.py script extracts list of strictly typed modules from Home Assistant configs.
  • Then it runs stubgen which is shipped with mypy to generate typing stubs.
  • New versions are generated and published automatically every 12 hours.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

homeassistant_stubs-2026.7.0b2.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

homeassistant_stubs-2026.7.0b2-py3-none-any.whl (4.0 MB view details)

Uploaded Python 3

File details

Details for the file homeassistant_stubs-2026.7.0b2.tar.gz.

File metadata

  • Download URL: homeassistant_stubs-2026.7.0b2.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for homeassistant_stubs-2026.7.0b2.tar.gz
Algorithm Hash digest
SHA256 3e7f873d16004b10fec1a7c252ff08956b4f2b144d7e0314268dfa0e1c5ff53c
MD5 2f794e8015dfb3e491ff57ef44302345
BLAKE2b-256 c83f7fcfe16ea4d203eef8ef4f8d03eb7f5ff5f5a8719def465aed17a499c2ba

See more details on using hashes here.

File details

Details for the file homeassistant_stubs-2026.7.0b2-py3-none-any.whl.

File metadata

  • Download URL: homeassistant_stubs-2026.7.0b2-py3-none-any.whl
  • Upload date:
  • Size: 4.0 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.25 {"installer":{"name":"uv","version":"0.11.25","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for homeassistant_stubs-2026.7.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 8e2b445803aa5411c355bce682b64e7085a80b7ce4fa2f4a5b322cb4454aa509
MD5 7be3f26e1ac8ab5c7d6fd026f81dbe92
BLAKE2b-256 4c4c0ace0ef9e7181eaf895f1cc19e0a8baf630b29115de728e2ba31f82f6c5a

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page