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.pyscript extracts list of strictly typed modules from Home Assistantsetup.cfg.- Then it runs
stubgenwhich is shipped withmypyto generate typing stubs. - New versions are generated and published automatically every 12 hours.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file homeassistant_stubs-2023.1.7.tar.gz.
File metadata
- Download URL: homeassistant_stubs-2023.1.7.tar.gz
- Upload date:
- Size: 627.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.2 CPython/3.9.16 Linux/5.15.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1ae73e892d2bc0e72db6aabbbca215b6c590389952a549e4f87a56e79fac6df5
|
|
| MD5 |
827e1eafc4baf62d5fd90f13a6f94e37
|
|
| BLAKE2b-256 |
5ae4ba3eda080a8062f754308606596aa279b5b015037e4224a8d716f55c06d9
|
File details
Details for the file homeassistant_stubs-2023.1.7-py3-none-any.whl.
File metadata
- Download URL: homeassistant_stubs-2023.1.7-py3-none-any.whl
- Upload date:
- Size: 1.6 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.3.2 CPython/3.9.16 Linux/5.15.0-1031-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d1a89d036395202c791bf851f03094c81e62cc1050b05c5941d7d3b30693062b
|
|
| MD5 |
d3eefec3dd393e01015cf8ef5d9e7ecb
|
|
| BLAKE2b-256 |
e2462241cfa949e0d1e25487b096f68c49e5521fbf76b1a584fefa4d13f54010
|
