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 2021.5.4

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

Built distribution (wheel)

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

Total release size: 369.9 kB

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

Download URL homeassistant-stubs-2021.5.4.tar.gz
Size 120.4 kB
Tags Source
SHA-256 checksum
How to use checksums
8744920c0675c0132601a356c7ce2c65b3b9126420dc74a6590105d04f75587c
BLAKE2b-256 checksum
How to use checksums
0ef035bf24011c672e410a0444cdf669cffcbf0b2809b119460e232fd43226f9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.8.10 Linux/5.4.0-1047-azure

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

Download URL homeassistant_stubs-2021.5.4-py3-none-any.whl
Size 249.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3fc6d7092d85f2f77c83f117bd7af040ce5428a82e68965e6ac60d30aa55a620
BLAKE2b-256 checksum
How to use checksums
b73fae900311ff16d3e9f692641a14e2a62cdf640c271a21c2cc6386b2d10067
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.1.5 CPython/3.8.10 Linux/5.4.0-1047-azure

Release history Release notifications | RSS feed

This release

2021.5.4 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