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.7.0b7.tar.gz (1.1 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.7.0b7-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

Details for the file homeassistant_stubs-2025.7.0b7.tar.gz.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.7.0b7.tar.gz
Algorithm Hash digest
SHA256 5da59c4fd769ac91fd55e0ff9f7f09e7b879711496a06c5c4e31b506e341920f
MD5 4a29cee2338c0890b10e605bd6c1df5f
BLAKE2b-256 120b6acf611ef3df13922c98fcbf9d95e65ff468de27ed409782d6e5a9060687

See more details on using hashes here.

File details

Details for the file homeassistant_stubs-2025.7.0b7-py3-none-any.whl.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.7.0b7-py3-none-any.whl
Algorithm Hash digest
SHA256 7189d321d5dfe2de702de1a7c7da75c791e0e0658e13d9d05924201bca54df4f
MD5 eed058a47ffcb7fa252cebe4a6d4056d
BLAKE2b-256 34e9db02eaef90f031a8c4000f963a3d89754f521f8e09bb6ada6f09e4bb4013

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