Skip to main content
Archived

This project has been archived by its maintainers, and is no longer receiving any updates.

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 Poetry for managing dependencies:

poetry add --group 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.

Metadata

Release files for homeassistant-stubs 2024.2.0b10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for homeassistant-stubs 2024.2.0b10
File Size Uploaded
homeassistant_stubs-2024.2.0b10.tar.gz 933.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for homeassistant-stubs 2024.2.0b10
File Interpreter ABI Platform
homeassistant_stubs-2024.2.0b10-py3-none-any.whl Python 3 none any Details

Total release size: 3.3 MB

Release files / homeassistant_stubs-2024.2.0b10.tar.gz

Download URL homeassistant_stubs-2024.2.0b10.tar.gz
Size 933.4 kB
Tags Source
SHA-256 checksum
How to use checksums
cabd0a322847e6d59fb42479fb2af76cdf402cb600ddc131b328a45904c829be
BLAKE2b-256 checksum
How to use checksums
dc8b9289d51e907636d44ec06b7b5f60130ee6121184d68bcd67a6f9c7fa3a63
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.2 CPython/3.11.7 Linux/6.2.0-1019-azure

Release files / homeassistant_stubs-2024.2.0b10-py3-none-any.whl

Download URL homeassistant_stubs-2024.2.0b10-py3-none-any.whl
Size 2.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
ba10e413240bc5f6174131612803b94a9550988e55976bd5a56878cef85a32da
BLAKE2b-256 checksum
How to use checksums
6aebb19c7ed45d14cfcc8eb357b9f7c511083158e354f51c332efe9ae1f3cbc9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.2 CPython/3.11.7 Linux/6.2.0-1019-azure

Release history Release notifications | RSS feed

This release

2024.2.0b10 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page