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-2026.6.0b2.tar.gz (1.4 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-2026.6.0b2-py3-none-any.whl (3.9 MB view details)

Uploaded Python 3

File details

Details for the file homeassistant_stubs-2026.6.0b2.tar.gz.

File metadata

  • Download URL: homeassistant_stubs-2026.6.0b2.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.18 {"installer":{"name":"uv","version":"0.11.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for homeassistant_stubs-2026.6.0b2.tar.gz
Algorithm Hash digest
SHA256 56b05b34ad4f653f436486482f1cb29e69fdeff93e613c8a594f32812bd14aa7
MD5 e1541ba3b87e355a93510bedb59c51ac
BLAKE2b-256 394180a71933c39b166bbd24b8b67f72e6eb22e0551bbd56ed399ca5a3a21c99

See more details on using hashes here.

File details

Details for the file homeassistant_stubs-2026.6.0b2-py3-none-any.whl.

File metadata

  • Download URL: homeassistant_stubs-2026.6.0b2-py3-none-any.whl
  • Upload date:
  • Size: 3.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.18 {"installer":{"name":"uv","version":"0.11.18","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for homeassistant_stubs-2026.6.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 2dea01b21d83c7f228a73a43d3fa6abea25e9138907ec61aa1d45f425c351a75
MD5 e8d267166dafd9a9f627160fa4b9b8af
BLAKE2b-256 f6cd2bec2203e711e4cf375366a3ccc48f9b9fedd8822c9540170da6758d8c13

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