Merge pull request #57 from ThomasBouche/hotfix/add_warning

add warnings for deprecated INDICATORS

Author: ThomasBouche

CHANGELOG.md

@@ -8,9 +8,10 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 ### Bugs
 
-* INDICATORS and INSTANT_INDICATORS attributes of WeatherForecast object where not always in sync with
+* `INDICATORS` and `INSTANT_INDICATORS` attributes of WeatherForecast object where not always in sync with
   the actual capabilities. Changed these attributes to properties that compute these lists dynamically
-  from the capabilities attribute. Changed their name to lowercase, since they are not constants anymore.
+  from the `capabilities` attribute. Changed their name to lowercase (`indicators`, `instant_indicators`), since they are not constants anymore.
+  (`DeprecationWarning` about use of `INDICATORS` and `INSTANT_INDICATORS`)
   See issue #54.
 
 ## [0.2.2] - November, 2025

README.md

@@ -75,7 +75,7 @@ logger = logging.getLogger("meteole")
 arome_client = AromeForecast(application_id=APPLICATION_ID)
 
 # Check indicators available
-print(arome_client.INDICATORS)
+print(arome_client.indicators)
 
 # Fetch weather data
 df_arome = arome_client.get_coverage(

src/meteole/forecast.py

@@ -10,6 +10,7 @@
 from functools import reduce
 from importlib.util import find_spec
 from typing import Any
+from warnings import warn
 
 import pandas as pd
 import xarray as xr
@@ -56,22 +57,6 @@ class WeatherForecast(ABC):
     DEFAULT_PRECISION: float = 0.01
     CLIENT_CLASS: type[BaseClient]
 
-    @property
-    def indicators(self) -> list[str]:
-        """Computes the list of all indicators from self.capabilities
-
-        Returns: List of all indicators
-        """
-        return self.capabilities["indicator"].unique().tolist()
-
-    @property
-    def instant_indicators(self) -> list[str]:
-        """Computes the list of instant indicators from self.capabilities
-
-        Returns: List of instant indicators
-        """
-        return self.capabilities[self.capabilities["interval"] == ""]["indicator"].unique().tolist()
-
     def __init__(
         self,
         client: BaseClient | None = None,
@@ -112,6 +97,48 @@ def __init__(
             # Try to instantiate it (can be user friendly)
             self._client = self.CLIENT_CLASS(**kwargs)
 
+    @property
+    def indicators(self) -> list[str]:
+        """Computes the list of all indicators from self.capabilities
+
+        Returns: List of all indicators
+        """
+        return self.capabilities["indicator"].unique().tolist()
+
+    @property
+    def instant_indicators(self) -> list[str]:
+        """Computes the list of instant indicators from self.capabilities
+
+        Returns: List of instant indicators
+        """
+        return self.capabilities[self.capabilities["interval"] == ""]["indicator"].unique().tolist()
+
+    @property
+    def INDICATORS(self) -> list[str]:
+        """Deprecated, will be removed in a future version, use indicators instead
+
+        Returns: List of all indicators
+        """
+        warn(
+            ("Deprecated, will be removed in a future version, use indicators instead"),
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.indicators
+
+    @property
+    def INSTANT_INDICATORS(self) -> list[str]:
+        """Deprecated, will be removed in a future version, use instant_indicators instead
+
+        Returns: List of instant indicators
+        """
+        warn(
+            ("Deprecated, will be removed in a future version, use instant_indicators instead"),
+            DeprecationWarning,
+            stacklevel=2,
+        )
+        return self.instant_indicators
+
     @property
     def capabilities(self) -> pd.DataFrame:
         """Getter method of the capabilities attribute.