diff options
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-homeassistant-stubs.spec | 190 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 192 insertions, 0 deletions
@@ -0,0 +1 @@ +/homeassistant_stubs-2023.4.2.tar.gz diff --git a/python-homeassistant-stubs.spec b/python-homeassistant-stubs.spec new file mode 100644 index 0000000..6861e3f --- /dev/null +++ b/python-homeassistant-stubs.spec @@ -0,0 +1,190 @@ +%global _empty_manifest_terminate_build 0 +Name: python-homeassistant-stubs +Version: 2023.4.2 +Release: 1 +Summary: PEP 484 typing stubs for Home Assistant Core +License: MIT +URL: https://github.com/KapJI/homeassistant-stubs +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/6b/6f/06907856c399097a585819877f81ab436882b241e9af5606dad207e637f4/homeassistant_stubs-2023.4.2.tar.gz +BuildArch: noarch + +Requires: python3-homeassistant + +%description +[](https://github.com/KapJI/homeassistant-stubs/actions/workflows/ci.yaml) +[](https://pypi.org/project/homeassistant-stubs/) + +# PEP 484 stubs for Home Assistant Core + +This is unofficial stub-only package generated from [Home Assistant Core](https://github.com/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](https://python-poetry.org/) for managing dependencies: + +```shell +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]](https://github.com/home-assistant/core/pull/28866), +[[2]](https://github.com/home-assistant/core/pull/47796)). +The reason is that [PEP 561](https://www.python.org/dev/peps/pep-0561/#packaging-type-information) +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. + + +%package -n python3-homeassistant-stubs +Summary: PEP 484 typing stubs for Home Assistant Core +Provides: python-homeassistant-stubs +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-homeassistant-stubs +[](https://github.com/KapJI/homeassistant-stubs/actions/workflows/ci.yaml) +[](https://pypi.org/project/homeassistant-stubs/) + +# PEP 484 stubs for Home Assistant Core + +This is unofficial stub-only package generated from [Home Assistant Core](https://github.com/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](https://python-poetry.org/) for managing dependencies: + +```shell +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]](https://github.com/home-assistant/core/pull/28866), +[[2]](https://github.com/home-assistant/core/pull/47796)). +The reason is that [PEP 561](https://www.python.org/dev/peps/pep-0561/#packaging-type-information) +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. + + +%package help +Summary: Development documents and examples for homeassistant-stubs +Provides: python3-homeassistant-stubs-doc +%description help +[](https://github.com/KapJI/homeassistant-stubs/actions/workflows/ci.yaml) +[](https://pypi.org/project/homeassistant-stubs/) + +# PEP 484 stubs for Home Assistant Core + +This is unofficial stub-only package generated from [Home Assistant Core](https://github.com/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](https://python-poetry.org/) for managing dependencies: + +```shell +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]](https://github.com/home-assistant/core/pull/28866), +[[2]](https://github.com/home-assistant/core/pull/47796)). +The reason is that [PEP 561](https://www.python.org/dev/peps/pep-0561/#packaging-type-information) +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. + + +%prep +%autosetup -n homeassistant-stubs-2023.4.2 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-homeassistant-stubs -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Wed Apr 12 2023 Python_Bot <Python_Bot@openeuler.org> - 2023.4.2-1 +- Package Spec generated @@ -0,0 +1 @@ +0cb98709702c7f7605723c778fe11811 homeassistant_stubs-2023.4.2.tar.gz |