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.9.0.tar.gz (1.2 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.9.0-py3-none-any.whl (3.3 MB view details)

Uploaded Python 3

File details

Details for the file homeassistant_stubs-2025.9.0.tar.gz.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.9.0.tar.gz
Algorithm Hash digest
SHA256 db2257e144bb16593fff0dcaacf5cae3a8ee9b9ac43911136bc2266d70ab3bc9
MD5 04fb2aabc2dd2b56fd15d443cbbf2c5a
BLAKE2b-256 41ef4ddc294dcedbff95d902445a4532fb08a7aea1605f52733f09183c73aa01

See more details on using hashes here.

File details

Details for the file homeassistant_stubs-2025.9.0-py3-none-any.whl.

File metadata

File hashes

Hashes for homeassistant_stubs-2025.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 afa0ac127017af9c3de32a39c3645b349029eb8ac246778884edf9565bb228a9
MD5 4073236badbcea73d4c6d14697a233a4
BLAKE2b-256 8d8c03784d832458e02d400b3be1f48cf2a8905b6f90ce1e9c6f830e0c07ff95

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