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 2023.1.0b5

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 2023.1.0b5
File Size Uploaded
homeassistant-stubs-2023.1.0b5.tar.gz 629.1 kB Details

Built distribution (wheel)

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

Total release size: 2.2 MB

Release files / homeassistant-stubs-2023.1.0b5.tar.gz

Download URL homeassistant-stubs-2023.1.0b5.tar.gz
Size 629.1 kB
Tags Source
SHA-256 checksum
How to use checksums
d24a9168e9ca7cadcdf955a37748836001d052f0f2b9db1c35627256750ff4c5
BLAKE2b-256 checksum
How to use checksums
503f9f325c88d395786515059ce05a99e6d92c70772e878710a903cd2ed95cae
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.0 CPython/3.9.16 Linux/5.15.0-1024-azure

Release files / homeassistant_stubs-2023.1.0b5-py3-none-any.whl

Download URL homeassistant_stubs-2023.1.0b5-py3-none-any.whl
Size 1.6 MB
Tags Python 3
SHA-256 checksum
How to use checksums
3f44748e2d7f11a52e8f65ad954af885766dd20335b3e4f99b3ca13868d9da09
BLAKE2b-256 checksum
How to use checksums
a08717dece2760fbc5b266f99c3eb680c4339ada705dcfeeb118172ae77058cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.2.0 CPython/3.9.16 Linux/5.15.0-1024-azure

Release history Release notifications | RSS feed

This release

2023.1.0b5 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