This project has been archived by its maintainers, and is no longer receiving any updates.
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.pyscript extracts list of strictly typed modules from Home Assistant configs.- Then it runs
stubgenwhich is shipped withmypyto generate typing stubs. - New versions are generated and published automatically every 12 hours.
1 maintainer
Metadata
1 maintainer
Release files for homeassistant-stubs 2023.12.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| homeassistant_stubs-2023.12.1.tar.gz | 794.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| homeassistant_stubs-2023.12.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 2.8 MB
Release files / homeassistant_stubs-2023.12.1.tar.gz
| Download URL | homeassistant_stubs-2023.12.1.tar.gz |
|---|---|
| Size | 794.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d104c938d733fee2ea45bcde8454f333a8cc190b03e14eddb628e11c246f51fe
|
|
BLAKE2b-256 checksum How to use checksums |
ff30d4340c9404428aea8fcd74d0c0de1f7a7cc2ae57728946414e3e4c6b03f1
|
| 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-1018-azure
|
Release files / homeassistant_stubs-2023.12.1-py3-none-any.whl
| Download URL | homeassistant_stubs-2023.12.1-py3-none-any.whl |
|---|---|
| Size | 2.0 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f5daf07a13ac27264fd456736b838e0405cced2da29344689e56963c5d283fd4
|
|
BLAKE2b-256 checksum How to use checksums |
3d9f5d565eadd194de89ce5fe1e1386611546b47914357683349a00c854adc04
|
| 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-1018-azure
|
