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

Uploaded Source

Built Distribution

homeassistant_stubs-2025.7.0b8-py3-none-any.whl (3.2 MB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.7.0b8.tar.gz
Algorithm Hash digest
SHA256 f9f63118c7a46a345f3af910c14ca954d36dbde3aeb20d55605e8481defc3a8c
MD5 e6c557c0a8938f5c465aa41a67e11a65
BLAKE2b-256 38703e9974b6ac1305ba8708b0cb4ef22570728af6136f4f6f12115db13d62f3

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.7.0b8-py3-none-any.whl
Algorithm Hash digest
SHA256 e0fdabab8318042a1ec6d4cdc507436cb97c4af1fb09b8486f9a0eb06ff241e9
MD5 41fc1525cc2aed1f03b0a8323e435a32
BLAKE2b-256 ce423221f9a086898e0749d20a596fc616bb3964a4f434ec709c533f5b662a11

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