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.10.1.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.10.1-py3-none-any.whl (3.3 MB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.10.1.tar.gz
Algorithm Hash digest
SHA256 5f5ff4eaa5bec119854599aaa64f8bcebb9908bf6df5652bef12cba4f5fad557
MD5 38d75047b7af844f5f1e90e8242c6782
BLAKE2b-256 c2c64a10f40eef5d9e2992eb43d37ec2a794f7ff56c7b51a6ee8edc070372a27

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for homeassistant_stubs-2025.10.1-py3-none-any.whl
Algorithm Hash digest
SHA256 000180e53ad1e2adf63963f4a0041590f6d2be36eb8de9ba34f85f6fa59478df
MD5 7b4d136ae8e1001f592d707d0a9b0589
BLAKE2b-256 1c9a66adfd978cbacfb9e42428121dd09439b0b03a4bd9e46e285bf855773592

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