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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.5.0b6.tar.gz
Algorithm Hash digest
SHA256 3e504f5f9b1ea0aac8cbc64477e989538f30b94b7720420733703ec2fa360d2b
MD5 cbe91ec4ae4907c844f49e93c0ac68a4
BLAKE2b-256 7fe0b15ed0f286790bf934754b6565472e3c3068dc1339a776ae7376073e2a3a

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.5.0b6-py3-none-any.whl
Algorithm Hash digest
SHA256 e09c7d97616efe4da051248ce00facbe61b11fbac3cbd91005028a2e67af2551
MD5 f5dd710fddea65ffd0496e05df0e097b
BLAKE2b-256 396dc14850c9d5cbd00fd3704f2dcdf8883be6818e20c2187f9a869fcfd17a22

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