juham-visualcrossing 0.0.1__tar.gz → 0.0.2__tar.gz

{juham_visualcrossing-0.0.1/juham_visualcrossing.egg-info → juham_visualcrossing-0.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: juham_visualcrossing
-Version: 0.0.1
+Version: 0.0.2
 Summary: A Weather forecast  plugin extending `juham` applications
 Author-email: J Meskanen <juham.api@gmail.com>
 Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
@@ -40,7 +40,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Requires-Dist: juham>=0.0.7
+Requires-Dist: juham>=0.0.12
 Requires-Dist: pytz>=2024.1
 Requires-Dist: importlib-metadata
 Provides-Extra: dev

juham_visualcrossing-0.0.2/juham_visualcrossing/py.typed

@@ -0,0 +1 @@
+

{juham_visualcrossing-0.0.1 → juham_visualcrossing-0.0.2}/juham_visualcrossing/visualcrossing.py

@@ -1,8 +1,9 @@
 from datetime import datetime, timedelta, timezone
 import json
+from typing import Any, Dict, Optional, cast
+from typing_extensions import override  # for python 3.9 compatibility
 
-from typing import Any
-from juham.base import Base
+from juham.base import Base, MqttMsg, JMqtt
 from juham.web import RCloud, RCloudThread
 
 
@@ -11,13 +12,13 @@ class VisualCrossingThread(RCloudThread):
     site."""
 
     # class attributes
-    _forecast_topic = ""
-    _base_url = ""
-    _api_key = ""
-    _location = ""
+    _forecast_topic: str = ""
+    _base_url: str = ""
+    _api_key: str = ""
+    _location: str = ""
     _interval: float = 12 * 3600
 
-    def __init__(self, client=None):
+    def __init__(self, client: Optional[JMqtt] = None):
         """Construct with the given mqtt client. Acquires data from the visual
         crossing web service and publishes the forecast data to
         forecast_topic.
@@ -26,13 +27,14 @@ class VisualCrossingThread(RCloudThread):
             client (object, optional): MQTT client. Defaults to None.
         """
         super().__init__(client)
-        self.mqtt_client = client
+        self.mqtt_client: Optional[JMqtt] = client
 
+    @override
     def update_interval(self) -> float:
         return self._interval
 
-    # @override
-    def make_url(self) -> str:
+    @override
+    def make_weburl(self) -> str:
         if not self._api_key:
             self.error("Uninitialized api_key {self.get_class_id()}: {self._api_key}")
             return ""
@@ -63,8 +65,8 @@ class VisualCrossingThread(RCloudThread):
         self._api_key = api_key
         self._location = location
 
-    # @override
-    def process_data(self, data: Any):
+    @override
+    def process_data(self, data: Any) -> None:
         self.info("VisualCrossing process_data()")
         data = data.json()
         forecast = []
@@ -112,24 +114,35 @@ class VisualCrossing(RCloud):
     update_interval.
     """
 
-    workerThreadId = VisualCrossingThread.get_class_id()
-    forecast_topic = Base.mqtt_root_topic + "/forecast"
-    base_url = "https://weather.visualcrossing.com/VisualCrossingWebServices/rest/services/timeline/"
-    update_interval = 12 * 3600
-    api_key = "SE9W7EHP775N7NDNW8ANM2MZN"
-    location = "lahti,finland"
+    workerThreadId: str = VisualCrossingThread.get_class_id()
+    base_url: str = (
+        "https://weather.visualcrossing.com/VisualCrossingWebServices/rest/services/timeline/"
+    )
+    update_interval: float = 12 * 3600
+    api_key: str = "SE9W7EHP775N7NDNW8ANM2MZN"
+    location: str = "lahti,finland"
 
-    def __init__(self, name="visualcrossing"):
+    def __init__(self, name="visualcrossing") -> None:
+        """Constructs VisualCrossing automation object for acquiring and publishing
+        forecast data.
+
+        Args:
+            name (str, optional): name of the object. Defaults to "visualcrossing".
+        """
         super().__init__(name)
-        self.debug(f"VisualCrossing created")
+        self.worker: Optional[VisualCrossingThread] = None
+        self.forecast_topic: str = self.make_topic_name("forecast")
+        self.debug(f"VisualCrossing with name {name} created")
 
-    def on_connect(self, client, userdata, flags, rc):
+    @override
+    def on_connect(self, client: object, userdata: Any, flags: int, rc: int) -> None:
         super().on_connect(client, userdata, flags, rc)
         if rc == 0:
             self.subscribe(self.forecast_topic)
             self.debug(f"VisualCrossing subscribed to topic {self.forecast_topic}")
 
-    def on_message(self, client, userdata, msg):
+    @override
+    def on_message(self, client: object, userdata: Any, msg: MqttMsg) -> None:
         if msg.topic == self.forecast_topic:
             em = json.loads(msg.payload.decode())
             self.on_forecast(em)
@@ -144,10 +157,13 @@ class VisualCrossing(RCloud):
         """
         self.debug(f"VisualCrossing: got mqtt message {em}")
 
-    # @override
-    def run(self):
+    @override
+    def run(self) -> None:
         # create, initialize and start the asynchronous thread for acquiring forecast
-        self.worker = Base.instantiate(VisualCrossing.workerThreadId)
+
+        self.worker = cast(
+            VisualCrossingThread, Base.instantiate(VisualCrossing.workerThreadId)
+        )
         self.worker.init(
             self.forecast_topic,
             self.base_url,
@@ -155,14 +171,13 @@ class VisualCrossing(RCloud):
             self.api_key,
             self.location,
         )
-        self.debug(f"VisualCrossing.run(): base_url is {self.base_url}")
-        self.debug(f"VisualCrossing.run(): interval is {self.update_interval}")
-        self.debug(f"VisualCrossing.run(): api_key is {self.api_key}")
-        self.debug(f"VisualCrossing.run(): location is {self.location}")
+        self.debug(
+            f"VisualCrossing run: {self.base_url}, {self.update_interval}s, location is {self.location}"
+        )
         super().run()
 
-    # @override
-    def to_dict(self):
+    @override
+    def to_dict(self) -> dict:
         data = super().to_dict()
         data["_visualcrossing"] = {
             "topic": self.forecast_topic,
@@ -172,8 +187,8 @@ class VisualCrossing(RCloud):
         }
         return data
 
-    # @override
-    def from_dict(self, data):
+    @override
+    def from_dict(self, data) -> None:
         super().from_dict(data)
         if "_visualcrossing" in data:
             for key, value in data["_visualcrossing"].items():

{juham_visualcrossing-0.0.1 → juham_visualcrossing-0.0.2/juham_visualcrossing.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: juham_visualcrossing
-Version: 0.0.1
+Version: 0.0.2
 Summary: A Weather forecast  plugin extending `juham` applications
 Author-email: J Meskanen <juham.api@gmail.com>
 Maintainer-email: "J. Meskanen" <juham.api@gmail.com>
@@ -40,7 +40,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python :: 3.8
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Requires-Dist: juham>=0.0.7
+Requires-Dist: juham>=0.0.12
 Requires-Dist: pytz>=2024.1
 Requires-Dist: importlib-metadata
 Provides-Extra: dev

{juham_visualcrossing-0.0.1 → juham_visualcrossing-0.0.2}/juham_visualcrossing.egg-info/SOURCES.txt

@@ -7,6 +7,7 @@ docs/source/CONTRIBUTING.rst
 docs/source/LICENSE.rst
 docs/source/README.rst
 juham_visualcrossing/__init__.py
+juham_visualcrossing/py.typed
 juham_visualcrossing/visualcrossing.py
 juham_visualcrossing.egg-info/PKG-INFO
 juham_visualcrossing.egg-info/SOURCES.txt

{juham_visualcrossing-0.0.1 → juham_visualcrossing-0.0.2}/juham_visualcrossing.egg-info/requires.txt

@@ -1,4 +1,4 @@
-juham>=0.0.7
+juham>=0.0.12
 pytz>=2024.1
 importlib-metadata
 

{juham_visualcrossing-0.0.1 → juham_visualcrossing-0.0.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "juham_visualcrossing"
-version = "0.0.1"
+version = "0.0.2"
 description = "A Weather forecast  plugin extending `juham` applications"
 readme = {file = "docs/source/README.rst", content-type = "text/markdown"}
 requires-python = ">=3.8"
@@ -28,7 +28,7 @@ classifiers = [
 ]
 
 dependencies = [
-  "juham >= 0.0.7",
+  "juham >= 0.0.12",
   "pytz >= 2024.1",
   "importlib-metadata"
 ]
@@ -53,5 +53,5 @@ visualcrossing_plugin = "juham_visualcrossing:VisualCrossing"
 
 
 [tool.mypy]
-files = ["juham_visualcrossing/"]
+files = ["juham_visualcrossing"]
 ignore_missing_imports = true

{juham_visualcrossing-0.0.1 → juham_visualcrossing-0.0.2}/tests/test_visualcrossing.py

@@ -1,6 +1,6 @@
 import unittest
 
-from juham_visualcrossing import VisualCrossing
+from juham_visualcrossing.visualcrossing import VisualCrossing
 
 
 class TestVisualCrossing(unittest.TestCase):