Skip to main content

PEP 484 typing stubs for Home Assistant Core

Project description

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

homeassistant-stubs-2022.8.0b2.tar.gz (503.9 kB view details)

Uploaded Source

Built Distribution

homeassistant_stubs-2022.8.0b2-py3-none-any.whl (1.3 MB view details)

Uploaded Python 3

File details

Details for the file homeassistant-stubs-2022.8.0b2.tar.gz.

File metadata

  • Download URL: homeassistant-stubs-2022.8.0b2.tar.gz
  • Upload date:
  • Size: 503.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.5 CPython/3.9.13 Linux/5.15.0-1014-azure

File hashes

Hashes for homeassistant-stubs-2022.8.0b2.tar.gz
Algorithm Hash digest
SHA256 cc3b5353510e85d1b2ca81734b1145c4004af9098bb20eca4876045ef19bdafd
MD5 595dfd9ad271fc4ab8eae0423711b5d8
BLAKE2b-256 4291de21730486ac07c7390d5ad6a6956ec6df77b0063bbb14ac3c4e8b9a17a8

See more details on using hashes here.

File details

Details for the file homeassistant_stubs-2022.8.0b2-py3-none-any.whl.

File metadata

File hashes

Hashes for homeassistant_stubs-2022.8.0b2-py3-none-any.whl
Algorithm Hash digest
SHA256 4d76f8ea9d8a3baef9519020b2034bd53870edadbb180994a7e3c00811e9df87
MD5 22d577e54cb652b328c257cf487eeee9
BLAKE2b-256 521588d1797d2f3f3d75bad07407e6845e780deedab4b44288b0dad3aeef5914

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page