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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

homeassistant_stubs-2025.4.0b1-py3-none-any.whl (3.1 MB view details)

Uploaded Python 3

File details

Details for the file homeassistant_stubs-2025.4.0b1.tar.gz.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.4.0b1.tar.gz
Algorithm Hash digest
SHA256 72181112030aa9419f44ab7f6954098e21dadeb3e2d64242ccc13dbd2f76c9f8
MD5 686ebf5dad0ef2ce8f1fb3ca41839bc7
BLAKE2b-256 40e386c75b3b5f3768d6cfee1eaebc106eb4c61562a11c60617b42e1aec05946

See more details on using hashes here.

File details

Details for the file homeassistant_stubs-2025.4.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.4.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 bf863837c69683cf191cac745faf65e0cf5b5111918de1e4c7f1954214106fb7
MD5 917c2b13a9e856843499a3b1c7e8f42b
BLAKE2b-256 053ab3b60d2093550c280f021045d4964e749a856f96917352ef379a1a8dcbcc

See more details on using hashes here.

Supported by

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