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-2025.11.0b6.tar.gz (1.2 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-2025.11.0b6-py3-none-any.whl (3.4 MB view details)

Uploaded Python 3

File details

Details for the file homeassistant_stubs-2025.11.0b6.tar.gz.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.11.0b6.tar.gz
Algorithm Hash digest
SHA256 895ab8de40a2fbabe2e02e5c429e23297ad9b316517d82658d4bb5a75f4afeed
MD5 0091900c92405f2c33044abe5e5c9441
BLAKE2b-256 b17b62fe8a4e6bcb7102db06e31218bbe598c6441ea1e0f4dbb948f83f802177

See more details on using hashes here.

File details

Details for the file homeassistant_stubs-2025.11.0b6-py3-none-any.whl.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.11.0b6-py3-none-any.whl
Algorithm Hash digest
SHA256 9eb641494d6938c8c5d8b54031cf0d2a090b0af19fd09268923d2638c6757379
MD5 0302ba2249e45f7dac1b735664671487
BLAKE2b-256 bab62c4cefd4e5755d24be9dc16a82d47ed337512c68fe1876714229e69fb5a2

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