python-tado 0.18.14__tar.gz → 0.18.16__tar.gz

{python_tado-0.18.14/python_tado.egg-info → python_tado-0.18.16}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: python-tado
-Version: 0.18.14
+Version: 0.18.16
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem
-Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>, FilBr <filippo.barba@protonmail.com>
+Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>, FilBr <filippo.barba@protonmail.com>, Erwin Douna <e.douna@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
         

python_tado-0.18.16/PyTado/__init__.py

@@ -0,0 +1,6 @@
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("python-tado")
+except PackageNotFoundError:
+    __version__ = "test"  # happens when running as pre-commit hook

{python_tado-0.18.14 → python_tado-0.18.16}/PyTado/http.py

@@ -19,6 +19,7 @@ from urllib.parse import urlencode
 
 import requests
 
+from PyTado import __version__
 from PyTado.const import CLIENT_ID_DEVICE
 from PyTado.exceptions import TadoException, TadoWrongCredentialsException
 from PyTado.logger import Logger
@@ -156,6 +157,7 @@ class Http:
         saved_refresh_token: str | None = None,
         http_session: requests.Session | None = None,
         debug: bool = False,
+        user_agent: str | None = None,
     ) -> None:
         """
         Initialize the HTTP client for interacting with the Tado API.
@@ -168,6 +170,8 @@ class Http:
             http_session (requests.Session | None): An optional pre-configured HTTP session.
                 If None, a new session will be created.
             debug (bool): If True, enables debug logging. Defaults to False.
+            user_agent (str | None): Optional user-agent header to use for the HTTP requests.
+                If None, a default user-agent PyTado/<PyTado-version> will be used.
 
         Returns:
             None
@@ -181,7 +185,7 @@ class Http:
         self._refresh_at = datetime.now(timezone.utc) + timedelta(minutes=10)
         self._session = http_session or self._create_session()
         self._session.hooks["response"].append(self._log_response)
-        self._headers = {"Referer": "https://app.tado.com/"}
+        self._headers = {"Referer": "https://app.tado.com/", "user-agent": user_agent or f"PyTado/{__version__}"}
 
         self._user_code: str | None = None
         self._device_verification_url: str | None = None
@@ -193,6 +197,8 @@ class Http:
         self._x_api: bool | None = None
         self._token_file_path = token_file_path
 
+        self._rate_limit: dict[str, str] = {}
+
         if (saved_refresh_token or self._load_token()) and self._refresh_token(
             refresh_token=saved_refresh_token, force_refresh=True
         ):
@@ -252,6 +258,11 @@ class Http:
         """
         return self._token_refresh
 
+    @property
+    def rate_limit(self) -> dict[str, str]:
+        """Retrieve the current rate limit information."""
+        return self._rate_limit
+
     def _create_session(self) -> requests.Session:
         session = requests.Session()
         session.hooks["response"].append(self._log_response)
@@ -314,6 +325,19 @@ class Http:
         if response.text is None or response.text == "":
             return {}
 
+        # Retrieve the headers to update the rate limit info
+        # They're stored in the object memory
+        if response.headers.get("RateLimit-Policy") is not None:
+            policy = response.headers["RateLimit-Policy"]
+            rate_limit = response.headers["RateLimit"]
+            # Example: RateLimit-Policy': '"perday";q=20000;w=86400'
+            # Rate limit is stored as follows: 'RateLimit': '"perday";r=15211'
+            self._rate_limit = {
+                "per-day": policy.split(";")[1].split("=")[1],
+                "window-seconds": policy.split(";")[2].split("=")[1],
+                "remaining": rate_limit.split(";")[1].split("=")[1],
+            }
+
         return response.json()
 
     def _configure_url(self, request: TadoRequest) -> str:

{python_tado-0.18.14 → python_tado-0.18.16}/PyTado/interface/api/my_tado.py

@@ -231,7 +231,7 @@ class Tado:
         request.command = f"zones/{zone:d}/schedule/activeTimetable"
         request.action = Action.CHANGE
         request.payload = {"id": timetable}
-        request.mode = Mode.PLAIN
+        request.mode = Mode.OBJECT
 
         self._http.request(request)
 
@@ -258,7 +258,7 @@ class Tado:
         request.command = f"zones/{zone:d}/schedule/timetables/{timetable:d}/blocks/{day}"
         request.action = Action.CHANGE
         request.payload = data
-        request.mode = Mode.PLAIN
+        request.mode = Mode.OBJECT
 
         return self._http.request(request)
 
@@ -526,6 +526,25 @@ class Tado:
 
         return self._http.request(request)
 
+    def get_eiq_consumption_overview(self, date=datetime.datetime.now().strftime("%Y-%m")):
+        """
+        Get consumption overview data for a specific month
+
+        Args:
+            date (str): The year-month to get the consumption overview for.
+
+        Returns:
+            dict: Consumption overview data for the specified month
+        """
+
+        request = TadoRequest()
+        request.command = "consumptionOverview"
+        request.action = Action.GET
+        request.endpoint = Endpoint.EIQ
+        request.params = {"month": f"{date}"}
+
+        return self._http.request(request)
+
     def set_eiq_meter_readings(self, date=datetime.datetime.now().strftime("%Y-%m-%d"), reading=0):
         """
         Send Meter Readings to Tado, date format is YYYY-MM-DD, reading is without decimals

{python_tado-0.18.14 → python_tado-0.18.16}/PyTado/interface/interface.py

@@ -55,6 +55,7 @@ class Tado:
         saved_refresh_token: str | None = None,
         http_session: requests.Session | None = None,
         debug: bool = False,
+        user_agent: str | None = None,
     ):
         """
         Initializes the interface class.
@@ -68,6 +69,8 @@ class Tado:
                                                               requests (can be used in unit tests).
                                                               Defaults to None.
             debug (bool, optional): Flag to enable or disable debug mode. Defaults to False.
+            user_agent (str | None): Optional user-agent header to use for the HTTP requests.
+                If None, a default user-agent PyTado/<PyTado-version> will be used.
         """
 
         self._http = Http(
@@ -75,6 +78,7 @@ class Tado:
             saved_refresh_token=saved_refresh_token,
             http_session=http_session,
             debug=debug,
+            user_agent=user_agent,
         )
         self._api: API.Tado | API.TadoX | None = None
         self._debug = debug
@@ -90,6 +94,10 @@ class Tado:
         """Returns the URL for device verification."""
         return self._http.device_verification_url
 
+    def rate_limit_info(self) -> dict[str, str]:
+        """Retrieve the current rate limit information."""
+        return self._http.rate_limit
+
     def device_activation_status(self) -> DeviceActivationStatus:
         """Returns the status of the device activation."""
         return self._http.device_activation_status

{python_tado-0.18.14 → python_tado-0.18.16}/pyproject.toml

@@ -4,12 +4,13 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "python-tado"
-version = "0.18.14"
+version = "0.18.16"
 description = "PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem"
 authors = [
     { name = "Chris Jewell", email = "chrism0dwk@gmail.com" },
     { name = "w.malgadey", email = "w.malgadey@gmail.com" },
     { name = "FilBr", email = "filippo.barba@protonmail.com" },
+    { name = "Erwin Douna", email = "e.douna@gmail.com" },
 ]
 dependencies = ["requests"]
 requires-python = ">=3.11"

{python_tado-0.18.14 → python_tado-0.18.16/python_tado.egg-info}/PKG-INFO

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: python-tado
-Version: 0.18.14
+Version: 0.18.16
 Summary: PyTado from chrism0dwk, modfied by w.malgadey, diplix, michaelarnauts, LenhartStephan, splifter, syssi, andersonshatch, Yippy, p0thi, Coffee2CodeNL, chiefdragon, FilBr, nikilase, albertomontesg, Moritz-Schmidt, palazzem
-Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>, FilBr <filippo.barba@protonmail.com>
+Author-email: Chris Jewell <chrism0dwk@gmail.com>, "w.malgadey" <w.malgadey@gmail.com>, FilBr <filippo.barba@protonmail.com>, Erwin Douna <e.douna@gmail.com>
 License:                     GNU GENERAL PUBLIC LICENSE
                                Version 3, 29 June 2007
         

{python_tado-0.18.14 → python_tado-0.18.16}/tests/test_http.py

@@ -124,6 +124,27 @@ class TestHttp(unittest.TestCase):
         self.assertEqual(instance._id, 1234)
         self.assertEqual(instance.is_x_line, True)
 
+        @responses.activate
+        def test_user_agent(self):
+            """Test that the we set the correct user-agent."""
+            responses.replace(
+                responses.GET,
+                "https://my.tado.com/api/v2/homes/1234/",
+                json=json.loads(
+                    common.load_fixture(
+                        "home_1234/tadov2.my_api_v2_home_state.json"
+                    )
+                ),
+                match=[matchers.header_matcher({"user-agent": "MyCustomAgent/1.0"})],
+                status=200,
+            )
+
+            instance = Http(debug=True, user_agent="MyCustomAgent/1.0")
+            instance.device_activation()
+
+            # Verify that the login was successful
+            self.assertEqual(instance._id, 1234)
+
     @responses.activate
     def test_refresh_token_success(self):
         """Test that the refresh token is successfully updated."""

{python_tado-0.18.14 → python_tado-0.18.16}/tests/test_my_tado.py

@@ -30,6 +30,7 @@ class TadoTestCase(unittest.TestCase):
         self.http = Http()
         self.tado_client = Tado(self.http)
 
+
     def test_home_set_to_manual_mode(
         self,
     ):
@@ -95,3 +96,51 @@ class TadoTestCase(unittest.TestCase):
             assert self.tado_client._http.request.called
             assert running_times["lastUpdated"] == "2023-08-05T19:50:21Z"
             assert running_times["runningTimes"][0]["zones"][0]["id"] == 1
+
+    def get_eiq_consumption_overview(self):
+            """Test the get_eiq_consumption_overview method."""
+
+            with mock.patch(
+                "PyTado.http.Http.request",
+                return_value=json.loads(common.load_fixture("consumption_overview.json")),
+            ):
+                #consumption = self.tado_client.get_eiq_consumption_overview("2024", "03", "HUN")
+                consumption = self.tado_client.get_eiq_consumption_overview("2024-03")
+
+                # Verify API call was made
+                assert self.tado_client._http.request.called
+
+                # Verify summary data
+                assert consumption["summary"]["consumption"] == 10.575
+                assert consumption["summary"]["unit"] == "m3"
+                assert consumption["summary"]["tariff"]["unitPriceInCents"] == 9.18
+
+                # Verify monthly data
+                monthly = consumption["graphConsumption"]["monthlyAggregation"][
+                    "requestedMonth"
+                ]
+                assert monthly["startDate"] == "2025-04-01"
+                assert monthly["endDate"] == "2025-04-10"
+                assert monthly["totalConsumption"] == 10.575
+                assert monthly["totalCostInCents"] == 1024.18
+
+                # Verify consumption comparison
+                comparison = consumption["consumptionComparison"]["consumption"]
+                assert comparison["comparedToMonthBefore"]["trend"] == "DECREASE"
+                assert comparison["comparedToMonthBefore"]["percentage"] == 65
+                assert comparison["comparedToYearBefore"]["trend"] == "INCREASE"
+                assert comparison["comparedToYearBefore"]["percentage"] == 71
+
+                # Verify room breakdown
+                rooms = consumption["roomBreakdown"]["requestedMonth"]["perRoom"]
+                assert len(rooms) == 7  # Verify total number of rooms
+                assert rooms[0]["name"] == "Schlafzimmer"
+                assert rooms[0]["consumption"] == 4.102
+                assert rooms[0]["costInCents"] == 397.27
+
+                # Verify heating insights
+                insights = consumption["heatingInsights"]
+                assert insights["heatingHours"]["trend"] == "DECREASE"
+                assert insights["heatingHours"]["diff"] == 181
+                assert insights["outsideTemperature"]["diff"] == 1
+                assert insights["awayHours"]["diff"] == 37