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.5.0b8.tar.gz (1.1 MB view details)

Uploaded Source

Built Distribution

File details

Details for the file homeassistant_stubs-2025.5.0b8.tar.gz.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.5.0b8.tar.gz
Algorithm Hash digest
SHA256 24074581f1e8043b149791c5c23af3fd426c5c2963fafa031c08ed3c9ecba907
MD5 69c1d050cc134af1c64196932a9b7cba
BLAKE2b-256 0443c623e2c6853042a4a6da72c3ff4624bce671ddb6be6fc1ce01c91e6b9703

See more details on using hashes here.

File details

Details for the file homeassistant_stubs-2025.5.0b8-py3-none-any.whl.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.5.0b8-py3-none-any.whl
Algorithm Hash digest
SHA256 08a7048536740b1cec05564ad8b6377fd2f5f0a1bc2ca30671906bcb9caf9525
MD5 f9b35c2a558524f38092bd361a6dfdfd
BLAKE2b-256 e0878db3289f2617e22290ac1c10cf620e425d7e52c5b972e72a5bf4f49185d8

See more details on using hashes here.

Supported by

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