Skip to main content
Archived

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

PEP 484 stubs for Home Assistant Core

CI PyPI version

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 --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 setup.cfg.
  • 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 2022.6.6

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 2022.6.6
File Size Uploaded
homeassistant-stubs-2022.6.6.tar.gz 470.5 kB Details

Built distribution (wheel)

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

Total release size: 1.7 MB

Release files / homeassistant-stubs-2022.6.6.tar.gz

Download URL homeassistant-stubs-2022.6.6.tar.gz
Size 470.5 kB
Tags Source
SHA-256 checksum
How to use checksums
bf097e614e7faea93e119129f6d61163c07403c76ce1857da458b6f4ab5b84c3
BLAKE2b-256 checksum
How to use checksums
554500986a9a5759a676b3362ea8f2baf97b39724259ed978adca78a67668b13
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.9.13 Linux/5.13.0-1025-azure

Release files / homeassistant_stubs-2022.6.6-py3-none-any.whl

Download URL homeassistant_stubs-2022.6.6-py3-none-any.whl
Size 1.2 MB
Tags Python 3
SHA-256 checksum
How to use checksums
0068e092f482e0d5ccc11d6971cc677baf3e623340cbda75c0fcb2a64956cfc6
BLAKE2b-256 checksum
How to use checksums
e662e114f0dd2461655ead57bb3cc7712a158f6308d5c123ea94e789f72bb529
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.9.13 Linux/5.13.0-1025-azure

Release history Release notifications | RSS feed

This release

2022.6.6 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