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 --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 2023.3.0b2

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.3.0b2
File Size Uploaded
homeassistant_stubs-2023.3.0b2.tar.gz 662.3 kB Details

Built distribution (wheel)

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

Total release size: 2.3 MB

Release files / homeassistant_stubs-2023.3.0b2.tar.gz

Download URL homeassistant_stubs-2023.3.0b2.tar.gz
Size 662.3 kB
Tags Source
SHA-256 checksum
How to use checksums
f0ddbb31ead5632d3e8544581bd2ad82d1b159192a65c82a7879731811de37c1
BLAKE2b-256 checksum
How to use checksums
4cc7e690ecfe20aaa44f06874755c786515f812b22d4e975c6f757024428183d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.2 CPython/3.10.10 Linux/5.15.0-1033-azure

Release files / homeassistant_stubs-2023.3.0b2-py3-none-any.whl

Download URL homeassistant_stubs-2023.3.0b2-py3-none-any.whl
Size 1.7 MB
Tags Python 3
SHA-256 checksum
How to use checksums
49aaeb48a9e8947b6a3b19a2f7bb89169e108f283698c91dd29b3c0f76cce5d6
BLAKE2b-256 checksum
How to use checksums
85f13a72a48dcef38a264946bd20358e7191aaf78e05fe9bb2db5c30926c5da2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.3.2 CPython/3.10.10 Linux/5.15.0-1033-azure

Release history Release notifications | RSS feed

This release

2023.3.0b2 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