freva-client 2508.0.0__py3-none-any.whl → 2509.0.0__py3-none-any.whl

freva_client/utils/databrowser_utils.py

@@ -40,15 +40,50 @@ class Config:
         self,
         host: Optional[str] = None,
         uniq_key: Literal["file", "uri"] = "file",
-        flavour: str = "freva",
+        flavour: Optional[str] = None,
     ) -> None:
         self.databrowser_url = f"{self.get_api_url(host)}/databrowser"
         self.auth_url = f"{self.get_api_url(host)}/auth/v2"
+        self.get_api_main_url = self.get_api_url(host)
         self.uniq_key = uniq_key
-        self._flavour = flavour
+        self.flavour = self.get_flavour(flavour)
 
-    def _read_ini(self, path: Path) -> str:
-        """Read an ini file."""
+    @cached_property
+    def validate_server(self) -> bool:
+        """Ping the databrowser to check if it is reachable."""
+        try:
+            res = requests.get(f"{self.get_api_main_url}/ping", timeout=15)
+            return res.status_code == 200
+        except Exception as e:
+            raise ValueError(
+                f"Could not connect to {self.databrowser_url}: {e}"
+            ) from None
+
+    def get_flavour(self, flavour: Optional[str]) -> str:
+        """Get the current flavour."""
+        if flavour:
+            return flavour
+        else:
+            try:
+                config_flavour = self._get_databrowser_params_from_config().get(
+                    "flavour", ""
+                )
+                return config_flavour or "freva"
+            except ValueError:
+                return "freva"
+
+    def _read_ini(self, path: Path) -> Dict[str, str]:
+        """Read an ini file.
+
+        Parameters
+        ----------
+        path : Path
+            Path to the ini configuration file.
+        Returns
+        -------
+        Dict[str, str]
+            Dictionary with the configuration.
+        """
         ini_parser = ConfigParser(interpolation=ExtendedInterpolation())
         ini_parser.read_string(path.read_text())
         config = ini_parser["evaluation_system"]
@@ -59,41 +94,99 @@ class Config:
         port = port or config.get("databrowser.port", "")
         if port:
             host = f"{host}:{port}"
-        return f"{scheme}://{host}"
+        host = f"{scheme}://{host}"
+        flavour = config.get("databrowser.default_flavour", "")
+        return {
+            "host": host,
+            "flavour": flavour,
+        }
 
-    def _read_toml(self, path: Path) -> str:
-        """Read a new style toml config file."""
+    def _read_toml(self, path: Path) -> Dict[str, str]:
+        """Read a new style toml config file.
+
+        Parameters
+        ----------
+        path : Path
+            Path to the toml configuration file.
+        Returns
+        -------
+        Dict[str, str]
+            Dictionary with the configuration.
+        """
         try:
             config = tomli.loads(path.read_text()).get("freva", {})
-            scheme, host = self._split_url(cast(str, config["host"]))
+            scheme, host = self._split_url(cast(str, config.get("host", "")))
+            flavour = config.get("default_flavour", "")
         except (tomli.TOMLDecodeError, KeyError):
-            return ""
+            return {}
         host, _, port = host.partition(":")
         if port:
             host = f"{host}:{port}"
-        return f"{scheme}://{host}"
+        host = f"{scheme}://{host}"
+        return {
+            "host": host,
+            "flavour": flavour,
+        }
 
-    def _read_config(self, path: Path, file_type: Literal["toml", "ini"]) -> str:
-        """Read the configuration."""
+    def _read_config(
+            self, path: Path, file_type: Literal["toml", "ini"]
+    ) -> Dict[str, str]:
+        """Read the configuration.
+
+        Parameters
+        ----------
+        path : Path
+            Path to the configuration file.
+        file_type : Literal["toml", "ini"]
+            Type of the configuration file.
+        Returns
+        -------
+        Dict[str, str]
+            Dictionary with the configuration.
+        """
         data_types = {"toml": self._read_toml, "ini": self._read_ini}
         try:
             return data_types[file_type](path)
         except KeyError:
             pass
-        return ""
+        return {}
+
+    @cached_property
+    def _get_headers(self) -> Optional[Dict[str, str]]:
+        """Get the headers for requests."""
+        from freva_client.auth import Auth
+
+        from .auth_utils import load_token
+        auth = Auth()
+        token = auth._auth_token or load_token(auth.token_file)
+        if token and "access_token" in token:
+            return {"Authorization": f"Bearer {token['access_token']}"}
+        return None
 
     @cached_property
     def overview(self) -> Dict[str, Any]:
-        """Get an overview of the all databrowser flavours and search keys."""
+        """Get an overview of all databrowser flavours
+        and search keys including custom flavours."""
+        headers = self._get_headers
         try:
-            res = requests.get(f"{self.databrowser_url}/overview", timeout=15)
+            res = requests.get(
+                f"{self.databrowser_url}/overview",
+                headers=headers,
+                timeout=15
+            )
+            data = cast(Dict[str, Any], res.json())
+            if not headers:
+                data["Note"] = (
+                    "Displaying only global flavours. "
+                    "Authenticate to see custom user flavours as well."
+                )
+            return data
         except requests.exceptions.ConnectionError:
             raise ValueError(
                 f"Could not connect to {self.databrowser_url}"
             ) from None
-        return cast(Dict[str, Any], res.json())
 
-    def _get_databrowser_host_from_config(self) -> str:
+    def _get_databrowser_params_from_config(self) -> Dict[str, str]:
         """Get the config file order."""
 
         eval_conf = self.get_dirs(user=False) / "evaluation_system.conf"
@@ -111,26 +204,20 @@ class Config:
         }
         for config_path, config_type in paths.items():
             if config_path.is_file():
-                host = self._read_config(config_path, config_type)
+                config_data = self._read_config(config_path, config_type)
+                host = config_data.get("host", "")
+                flavour = config_data.get("flavour", "")
                 if host:
-                    return host
+                    return {
+                        "host": host,
+                        "flavour": flavour
+                    }
         raise ValueError(
             "No databrowser host configured, please use a"
             " configuration defining a databrowser host or"
             " set a host name using the `host` key"
         )
 
-    @cached_property
-    def flavour(self) -> str:
-        """Get the flavour."""
-        flavours = self.overview.get("flavours", [])
-        if self._flavour not in flavours:
-            raise ValueError(
-                f"Search {self._flavour} not available, select from"
-                f" {','.join(flavours)}"
-            )
-        return self._flavour
-
     @property
     def search_url(self) -> str:
         """Define the data search endpoint."""
@@ -172,7 +259,7 @@ class Config:
 
     def get_api_url(self, url: Optional[str]) -> str:
         """Construct the databrowser url from a given hostname."""
-        url = url or self._get_databrowser_host_from_config()
+        url = url or self._get_databrowser_params_from_config().get("host", "")
         scheme, hostname = self._split_url(url)
         hostname, _, port = hostname.partition(":")
         if port:
@@ -207,7 +294,6 @@ class Config:
 
 class UserDataHandler:
     """Class for processing user data.
-
     This class is used for processing user data and extracting metadata
     from the data files.
     """

{freva_client-2508.0.0.data → freva_client-2509.0.0.data}/data/share/freva/freva.toml

@@ -17,3 +17,8 @@
 ## You can set a port by separating <hostname:port>
 ## for example freva.example.org:7777
 # host = ""
+
+##
+## The default flavour to use when accessing freva. You can simply list
+## the flavours you want to use and choose one as default.
+# default_flavour = "cmip6"

{freva_client-2508.0.0.dist-info → freva_client-2509.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: freva-client
-Version: 2508.0.0
+Version: 2509.0.0
 Summary: Search for climate data based on key-value pairs
 Author-email: "DKRZ, Clint" <freva@dkrz.de>
 Requires-Python: >=3.8

freva_client-2509.0.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+freva_client/__init__.py,sha256=6C-njQv12FgsYk2cWv2y3PPBZYfO99qPPeAFmyQhZyA,916
+freva_client/__main__.py,sha256=JVj12puT4o8JfhKLAggR2-NKCZa3wKwsYGi4HQ61DOQ,149
+freva_client/auth.py,sha256=yq_W8DjYA3W2b5HLKTplg5s_prJR9um9NV4uxHMIS2M,10897
+freva_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+freva_client/query.py,sha256=Dm6Wy9U8ofzZd4v50Sjhl4Guh7njrClSnNNV5_7UdM0,49433
+freva_client/cli/__init__.py,sha256=NgTqBZGdozmTZtJduJUMrZj-opGw2KoT20tg6sc_xqo,149
+freva_client/cli/auth_cli.py,sha256=lM6QNcewh9Cz7DtHO4Wu6iv7GapwplyjhDRfmIlzyJ0,1950
+freva_client/cli/cli_app.py,sha256=QH6cb9XZTx8S9L0chPWOVd9Jn4GD1hd3sENAhdzmLZU,887
+freva_client/cli/cli_parser.py,sha256=EyzvTr70TBCD0mO2P3mVNtuEeEbNk2OdrhKSEHuu6NE,5101
+freva_client/cli/cli_utils.py,sha256=9h2hlBQA-D3n-JlFIC1DSuzEEv73Bpu8lXLAqZBDaYI,1946
+freva_client/cli/databrowser_cli.py,sha256=LpK6NvHWsbHVeJvOHG_su0dh9FHkLxTmY4K8P75S8A0,39397
+freva_client/utils/__init__.py,sha256=ySHn-3CZBwfZW2s0EpZ3INxUWOw1V4LOlKIxSLYr52U,1000
+freva_client/utils/auth_utils.py,sha256=6didULriVK72D_Ptj8UV5wRrMl_w1C9vIoietpy3cG8,7206
+freva_client/utils/databrowser_utils.py,sha256=Hv39Q8Crd63l2U-lBJfppMn14BUm6ECY0ASsgP_8du8,17801
+freva_client/utils/logger.py,sha256=vjBbNb9KvyMriBPpgIoJjlQFCEj3DLqkJu8tYxfp2xI,2494
+freva_client-2509.0.0.data/data/share/freva/freva.toml,sha256=5xXWBqw0W6JyWfRMaSNnKDOGkDznx6NFaJvggh-cUPU,899
+freva_client-2509.0.0.dist-info/entry_points.txt,sha256=zGyEwHrH_kAGLsCXv00y7Qnp-WjXkUuIomHkfGMCxtA,53
+freva_client-2509.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+freva_client-2509.0.0.dist-info/METADATA,sha256=gf2-uq7wTLtweozJYjxkFXkBOh-d8b2s1ys15nYv_rc,2487
+freva_client-2509.0.0.dist-info/RECORD,,

freva_client-2508.0.0.dist-info/RECORD

@@ -1,20 +0,0 @@
-freva_client/__init__.py,sha256=Yh9B2N-5bZJgwcHOxXDMg5hEOgetBoU3TmbsE6IVLQk,851
-freva_client/__main__.py,sha256=JVj12puT4o8JfhKLAggR2-NKCZa3wKwsYGi4HQ61DOQ,149
-freva_client/auth.py,sha256=p1itCygbLgEaCFTPWgqoId3S9PteP1lrziULziKzPG4,10453
-freva_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-freva_client/query.py,sha256=SQx5c4lNwP7ZiP1u6uN7pbUyvdjv74s2vQ3kRAa_708,41906
-freva_client/cli/__init__.py,sha256=NgTqBZGdozmTZtJduJUMrZj-opGw2KoT20tg6sc_xqo,149
-freva_client/cli/auth_cli.py,sha256=hCgTxN930uTj5Z0NqItAyejiUI9E-1oSv_lWOVoHNUo,1780
-freva_client/cli/cli_app.py,sha256=QH6cb9XZTx8S9L0chPWOVd9Jn4GD1hd3sENAhdzmLZU,887
-freva_client/cli/cli_parser.py,sha256=EyzvTr70TBCD0mO2P3mVNtuEeEbNk2OdrhKSEHuu6NE,5101
-freva_client/cli/cli_utils.py,sha256=Ev9UxM4S1ZDbZSAGHFe5dMjVGot75w3muNKH3P80bHY,842
-freva_client/cli/databrowser_cli.py,sha256=eUd-lbSQaRyczLKQQLY_eKU3VRf6Zg5HaHMQbe2Ib5Q,32242
-freva_client/utils/__init__.py,sha256=ySHn-3CZBwfZW2s0EpZ3INxUWOw1V4LOlKIxSLYr52U,1000
-freva_client/utils/auth_utils.py,sha256=Tma8aPi32zhJ-z2o6gEe1LvpBFlkn-t__UgZONcuARY,6032
-freva_client/utils/databrowser_utils.py,sha256=X9M71mBfc8lauyLh3t1CCxhu_96Ya_NVkMNdxmWTsjE,15109
-freva_client/utils/logger.py,sha256=vjBbNb9KvyMriBPpgIoJjlQFCEj3DLqkJu8tYxfp2xI,2494
-freva_client-2508.0.0.data/data/share/freva/freva.toml,sha256=64Rh4qvWc9TaGJMXMi8tZW14FnESt5Z24y17BfD2VyM,736
-freva_client-2508.0.0.dist-info/entry_points.txt,sha256=zGyEwHrH_kAGLsCXv00y7Qnp-WjXkUuIomHkfGMCxtA,53
-freva_client-2508.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-freva_client-2508.0.0.dist-info/METADATA,sha256=8oAcxK-rhgUnBSSmUUsVcEJTNlzOcnWCkS91UaqhMqk,2487
-freva_client-2508.0.0.dist-info/RECORD,,