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

Uploaded Source

Built Distribution

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.5.0b7.tar.gz
Algorithm Hash digest
SHA256 92203b372834f6456efdc0e1dc8b91e4f937544d2d3270d3ea579d02be8283bf
MD5 faf1382ed0902f241702697d2754c2c4
BLAKE2b-256 1a59cf60c87f496ded67f94d945521c3b9484a6345b2d506f7daa2728018b0e8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.5.0b7-py3-none-any.whl
Algorithm Hash digest
SHA256 f7d2e0f8b725deac8b7c4ab26c5358823cf2db48f62211fe0f325c3074fa1fba
MD5 8e4c207f2a1a77e073364259f64c4a79
BLAKE2b-256 adf31af2b0f5082c01850b26083844c2dde263b075704b2aa15949d7e4d9d39b

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