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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.5.0b9.tar.gz
Algorithm Hash digest
SHA256 c9274652b16c9f71e0401c8ebf970ed06403e65a7ffeb39e7c89cb83ffd2645b
MD5 f86800d7cbcdc4d444bdbb1ac0618938
BLAKE2b-256 3546cc5901a678139d0af92e13339797fa4789230388090beef4cca07b4d7409

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.5.0b9-py3-none-any.whl
Algorithm Hash digest
SHA256 782b61bb977760b958f22aab7b64ae958c82b74fc3e55d39c4496ea5b72dff7a
MD5 d9eb7349a87fc5ab6cc4a87a8c8a063c
BLAKE2b-256 bcdf78d31ba0f68085df8e19c6f7f41dbad22da7f51647cc20cf0f9bdc63208b

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