Merge pull request #232 from plugwise/py_typed

Py typed as suggested in #231

Author: bouwew

.github/workflows/merge.yml

@@ -8,7 +8,7 @@ env:
   DEFAULT_PYTHON: 3.9
 
 # Only run on merges
-on: 
+on:
   pull_request:
     types: closed
     branches:
@@ -32,7 +32,7 @@ jobs:
         run: >-
           python setup.py sdist
       - name: Publish distribution 📦 to PyPI
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         with:
           password: ${{ secrets.pypi_token }}
           skip_existing: true

.github/workflows/verify.yml

@@ -4,7 +4,7 @@
 name: Latest commit
 
 env:
-  CACHE_VERSION: 5
+  CACHE_VERSION: 6
   DEFAULT_PYTHON: "3.9"
   PRE_COMMIT_HOME: ~/.cache/pre-commit
 
@@ -352,7 +352,7 @@ jobs:
         run: >-
           python setup.py sdist
       - name: Publish distribution 📦 to Test PyPI
-        uses: pypa/gh-action-pypi-publish@master
+        uses: pypa/gh-action-pypi-publish@release/v1
         continue-on-error: true
         with:
           password: ${{ secrets.testpypi_token }}

CHANGELOG.md

@@ -1,5 +1,7 @@
 # Changelog
 
+# v0.25.4: Add py.typed, fix typing as suggested in #231
+
 # v0.25.3: Bugfix for https://github.com/plugwise/plugwise-beta/issues/309
 
 # v0.25.2: Bugfix, code improvements

plugwise/__init__.py

@@ -1,6 +1,6 @@
 """Plugwise module."""
 
-__version__ = "0.25.3"
+__version__ = "0.25.4"
 
 from plugwise.smile import Smile
 from plugwise.stick import Stick

plugwise/smile.py

@@ -533,7 +533,7 @@ async def _update_domain_objects(self) -> None:
                     f"{self._endpoint}{DOMAIN_OBJECTS}",
                 )
 
-    async def async_update(self) -> list[GatewayData | dict[str, DeviceData]]:
+    async def async_update(self) -> tuple[GatewayData, dict[str, DeviceData]]:
         """Perform an incremental update for updating the various device states."""
         if self.smile_type != "power":
             await self._update_domain_objects()
@@ -573,7 +573,7 @@ async def async_update(self) -> list[GatewayData | dict[str, DeviceData]]:
             # Update for cooling
             self.update_for_cooling(dev_dict)
 
-        return [self.gw_data, self.gw_devices]
+        return (self.gw_data, self.gw_devices)
 
     async def _set_schedule_state_legacy(
         self, loc_id: str, name: str, status: str

py.typed

@@ -35,6 +35,7 @@ def readme():
     author_email="[email protected]",
     license="MIT",
     packages=find_packages(),
+    package_data={"plugwise": ["py.typed"]},
     install_requires=[
         "aiohttp",
         "async_timeout",