freva-client 2411.0.0__tar.gz → 2502.0.0__tar.gz

{freva_client-2411.0.0 → freva_client-2502.0.0}/PKG-INFO

@@ -1,11 +1,11 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: freva-client
-Version: 2411.0.0
+Version: 2502.0.0
 Summary: Search for climate data based on key-value pairs
 Author-email: "DKRZ, Clint" <freva@dkrz.de>
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Science/Research
@@ -16,6 +16,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: appdirs
 Requires-Dist: pyyaml
 Requires-Dist: authlib

{freva_client-2411.0.0 → freva_client-2502.0.0}/pyproject.toml

@@ -8,7 +8,7 @@ description = "Search for climate data based on key-value pairs"
 authors = [{name = "DKRZ, Clint", email = "freva@dkrz.de"}]
 readme = "README.md"
 classifiers = [
-               "Development Status :: 3 - Alpha",
+               "Development Status :: 4 - Beta",
                "Environment :: Console",
                "Intended Audience :: Developers",
                "Intended Audience :: Science/Research",
@@ -19,6 +19,7 @@ classifiers = [
                "Programming Language :: Python :: 3.10",
                "Programming Language :: Python :: 3.11",
                "Programming Language :: Python :: 3.12",
+               "Programming Language :: Python :: 3.13",
 ]
 requires-python = ">=3.8"
 dependencies = [
@@ -48,4 +49,4 @@ include = ["assets/*"]
 [tool.flit.external-data]
 directory = "assets"
 [package-data]
-freva_deployment = ["py.typed"]
+freva_client = ["py.typed"]

{freva_client-2411.0.0 → freva_client-2502.0.0}/src/freva_client/__init__.py

@@ -17,5 +17,5 @@ need to apply data analysis plugins, please visit the
 from .auth import authenticate
 from .query import databrowser
 
-__version__ = "2411.0.0"
+__version__ = "2502.0.0"
 __all__ = ["authenticate", "databrowser", "__version__"]

{freva_client-2411.0.0 → freva_client-2502.0.0}/src/freva_client/cli/auth_cli.py

@@ -5,6 +5,7 @@ from getpass import getuser
 from typing import Optional
 
 import typer
+
 from freva_client import authenticate
 from freva_client.utils import exception_handler, logger
 

{freva_client-2411.0.0 → freva_client-2502.0.0}/src/freva_client/cli/cli_app.py

@@ -4,6 +4,7 @@ import os
 from typing import Optional
 
 import typer
+
 from freva_client.utils import logger
 
 from .auth_cli import authenticate_cli

{freva_client-2411.0.0 → freva_client-2502.0.0}/src/freva_client/cli/cli_utils.py

@@ -3,9 +3,10 @@
 from typing import Dict, List
 
 import typer
+from rich import print as pprint
+
 from freva_client import __version__
 from freva_client.utils import logger
-from rich import print as pprint
 
 APP_NAME: str = "freva-client"
 

{freva_client-2411.0.0 → freva_client-2502.0.0}/src/freva_client/cli/databrowser_cli.py

@@ -11,6 +11,7 @@ from typing import Dict, List, Literal, Optional, Union, cast
 
 import typer
 import xarray as xr
+
 from freva_client import databrowser
 from freva_client.auth import Auth
 from freva_client.utils import exception_handler, logger
@@ -31,27 +32,27 @@ def _auth(url: str, token: Optional[str]) -> None:
 class UniqKeys(str, Enum):
     """Literal implementation for the cli."""
 
-    file: str = "file"
-    uri: str = "uri"
+    file = "file"
+    uri = "uri"
 
 
 class Flavours(str, Enum):
     """Literal implementation for the cli."""
 
-    freva: str = "freva"
-    cmip6: str = "cmip6"
-    cmip5: str = "cmip5"
-    cordex: str = "cordex"
-    nextgems: str = "nextgems"
-    user: str = "user"
+    freva = "freva"
+    cmip6 = "cmip6"
+    cmip5 = "cmip5"
+    cordex = "cordex"
+    nextgems = "nextgems"
+    user = "user"
 
 
 class TimeSelect(str, Enum):
     """Literal implementation for the cli."""
 
-    strict: str = "strict"
-    flexible: str = "flexible"
-    file: str = "file"
+    strict = "strict"
+    flexible = "flexible"
+    file = "file"
 
     @staticmethod
     def get_help() -> str:
@@ -187,7 +188,9 @@ def metadata_search(
     result = databrowser.metadata_search(
         *(facets or []),
         time=time or "",
-        time_select=cast(Literal["file", "flexible", "strict"], time_select.value),
+        time_select=cast(
+            Literal["file", "flexible", "strict"], time_select.value
+        ),
         flavour=cast(
             Literal["freva", "cmip6", "cmip5", "cordex", "nextgems", "user"],
             flavour.value,
@@ -461,7 +464,9 @@ def intake_catalogue(
             print(Path(temp_f.name).read_text())
 
 
-@databrowser_app.command(name="data-count", help="Count the databrowser search results")
+@databrowser_app.command(
+    name="data-count", help="Count the databrowser search results"
+)
 @exception_handler
 def count_values(
     search_keys: Optional[List[str]] = typer.Argument(
@@ -580,9 +585,13 @@ def count_values(
             databrowser(
                 *facets,
                 time=time or "",
-                time_select=cast(Literal["file", "flexible", "strict"], time_select),
+                time_select=cast(
+                    Literal["file", "flexible", "strict"], time_select
+                ),
                 flavour=cast(
-                    Literal["freva", "cmip6", "cmip5", "cordex", "nextgems", "user"],
+                    Literal[
+                        "freva", "cmip6", "cmip5", "cordex", "nextgems", "user"
+                    ],
                     flavour.value,
                 ),
                 host=host,
@@ -662,11 +671,13 @@ def user_data_add(
         action="add",
         userdata_items=cast(List[Union[str, xr.Dataset]], paths),
         metadata=facet_dict,
-        host=host
+        host=host,
     )
 
 
-@user_data_app.command(name="delete", help="Delete user data from the databrowser.")
+@user_data_app.command(
+    name="delete", help="Delete user data from the databrowser."
+)
 @exception_handler
 def user_data_delete(
     search_keys: List[str] = typer.Option(

{freva_client-2411.0.0 → freva_client-2502.0.0}/src/freva_client/query.py

@@ -1,6 +1,5 @@
 """Query climate data sets by using-key value pair search queries."""
 
-
 import sys
 from collections import defaultdict
 from fnmatch import fnmatch
@@ -246,7 +245,8 @@ class databrowser:
         self, facets: Tuple[str, ...], search_kw: Dict[str, List[str]]
     ) -> None:
         metadata = {
-            k: v[::2] for (k, v) in self._facet_search(extended_search=True).items()
+            k: v[::2]
+            for (k, v) in self._facet_search(extended_search=True).items()
         }
         primary_key = list(metadata.keys() or ["project"])[0]
         num_facets = 0
@@ -304,7 +304,9 @@ class databrowser:
 
         # Create a table-like structure for available flavors and search facets
         style = 'style="text-align: left"'
-        facet_heading = f"Available search facets for <em>{self._flavour}</em> flavour"
+        facet_heading = (
+            f"Available search facets for <em>{self._flavour}</em> flavour"
+        )
         html_repr = (
             "<table>"
             f"<tr><th colspan='2' {style}>{self.__class__.__name__}"
@@ -345,7 +347,9 @@ class databrowser:
         if self._stream_zarr:
             token = self._auth.check_authentication(auth_url=self._cfg.auth_url)
             url = self._cfg.zarr_loader_url
-            kwargs["headers"] = {"Authorization": f"Bearer {token['access_token']}"}
+            kwargs["headers"] = {
+                "Authorization": f"Bearer {token['access_token']}"
+            }
             kwargs["params"] = {"catalogue-type": "intake"}
         result = self._request("GET", url, **kwargs)
         if result is None:
@@ -357,7 +361,9 @@ class databrowser:
                 for content in result.iter_content(decode_unicode=False):
                     stream.write(content)
         except Exception as error:
-            raise ValueError(f"Couldn't write catalogue content: {error}") from None
+            raise ValueError(
+                f"Couldn't write catalogue content: {error}"
+            ) from None
 
     def intake_catalogue(self) -> intake_esm.core.esm_datastore:
         """Create an intake esm catalogue object from the search.
@@ -388,7 +394,10 @@ class databrowser:
         """
         with NamedTemporaryFile(suffix=".json") as temp_f:
             self._create_intake_catalogue_file(temp_f.name)
-            return intake.open_esm_datastore(temp_f.name)
+            return cast(
+                intake_esm.core.esm_datastore,
+                intake.open_esm_datastore(temp_f.name),
+            )
 
     @classmethod
     def count_values(
@@ -495,7 +504,9 @@ class databrowser:
         result = this._facet_search(extended_search=extended_search)
         counts = {}
         for facet, value_counts in result.items():
-            counts[facet] = dict(zip(value_counts[::2], map(int, value_counts[1::2])))
+            counts[facet] = dict(
+                zip(value_counts[::2], map(int, value_counts[1::2]))
+            )
         return counts
 
     @cached_property
@@ -520,7 +531,8 @@ class databrowser:
 
         """
         return {
-            k: v[::2] for (k, v) in self._facet_search(extended_search=True).items()
+            k: v[::2]
+            for (k, v) in self._facet_search(extended_search=True).items()
         }
 
     @classmethod
@@ -653,7 +665,9 @@ class databrowser:
         )
         return {
             k: v[::2]
-            for (k, v) in this._facet_search(extended_search=extended_search).items()
+            for (k, v) in this._facet_search(
+                extended_search=extended_search
+            ).items()
         }
 
     @classmethod
@@ -782,11 +796,11 @@ class databrowser:
             import xarray as xr
             token_info = authenticate(username="janedoe")
             filenames = (
-                "../freva-rest/src/databrowser_api/mock/data/model/regional/cordex/output/EUR-11/"
+                "../freva-rest/src/freva_rest/databrowser_api/mock/data/model/regional/cordex/output/EUR-11/"
                 "GERICS/NCC-NorESM1-M/rcp85/r1i1p1/GERICS-REMO2015/v1/3hr/pr/v20181212/*.nc"
             )
             filename1 = (
-                "../freva-rest/src/databrowser_api/mock/data/model/regional/cordex/output/EUR-11/"
+                "../freva-rest/src/freva_rest/databrowser_api/mock/data/model/regional/cordex/output/EUR-11/"
                 "CLMcom/MPI-M-MPI-ESM-LR/historical/r0i0p0/CLMcom-CCLM4-8-17/v1/fx/orog/v20140515/"
                 "orog_EUR-11_MPI-M-MPI-ESM-LR_historical_r1i1p1_CLMcom-CCLM4-8-17_v1_fx.nc"
             )
@@ -856,7 +870,7 @@ class databrowser:
         method: Literal["GET", "POST", "PUT", "PATCH", "DELETE"],
         url: str,
         data: Optional[Dict[str, Any]] = None,
-        **kwargs: Any
+        **kwargs: Any,
     ) -> Optional[requests.models.Response]:
         """Request method to handle CRUD operations (GET, POST, PUT, PATCH, DELETE)."""
         method_upper = method.upper()
@@ -864,8 +878,13 @@ class databrowser:
         params = kwargs.pop("params", {})
         stream = kwargs.pop("stream", False)
 
-        logger.debug("%s request to %s with data: %s and parameters: %s",
-                     method_upper, url, data, {**self._params, **params})
+        logger.debug(
+            "%s request to %s with data: %s and parameters: %s",
+            method_upper,
+            url,
+            data,
+            {**self._params, **params},
+        )
 
         try:
             req = requests.Request(
@@ -873,7 +892,7 @@ class databrowser:
                 url=url,
                 params={**self._params, **params},
                 json=None if method_upper in "GET" else data,
-                **kwargs
+                **kwargs,
             )
             with requests.Session() as session:
                 prepared = session.prepare_request(req)
@@ -883,8 +902,10 @@ class databrowser:
 
         except KeyboardInterrupt:
             pprint("[red][b]User interrupt: Exit[/red][/b]", file=sys.stderr)
-        except (requests.exceptions.ConnectionError,
-                requests.exceptions.HTTPError) as error:
+        except (
+            requests.exceptions.ConnectionError,
+            requests.exceptions.HTTPError,
+        ) as error:
             msg = f"{method_upper} request failed with {error}"
             if self._fail_on_error:
                 raise ValueError(msg) from None

{freva_client-2411.0.0 → freva_client-2502.0.0}/src/freva_client/utils/databrowser_utils.py

@@ -53,7 +53,7 @@ class Config:
         ini_parser.read_string(path.read_text())
         config = ini_parser["evaluation_system"]
         scheme, host = self._split_url(
-            config.get("databrowser.host") or config.get("solr.host")
+            config.get("databrowser.host", config.get("solr.host", ""))
         )
         host, _, port = (host or "").partition(":")
         port = port or config.get("databrowser.port", "")
@@ -88,7 +88,9 @@ class Config:
         try:
             res = requests.get(f"{self.databrowser_url}/overview", timeout=15)
         except requests.exceptions.ConnectionError:
-            raise ValueError(f"Could not connect to {self.databrowser_url}") from None
+            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:
@@ -103,7 +105,9 @@ class Config:
             Path(appdirs.user_config_dir("freva")) / "freva.toml": "toml",
             Path(self.get_dirs(user=True)) / "freva.toml": "toml",
             freva_config: "toml",
-            Path(os.environ.get("EVALUATION_SYSTEM_CONFIG_FILE") or eval_conf): "ini",
+            Path(
+                os.environ.get("EVALUATION_SYSTEM_CONFIG_FILE") or eval_conf
+            ): "ini",
         }
         for config_path, config_type in paths.items():
             if config_path.is_file():
@@ -130,7 +134,9 @@ class Config:
     @property
     def search_url(self) -> str:
         """Define the data search endpoint."""
-        return f"{self.databrowser_url}/data_search/{self.flavour}/{self.uniq_key}"
+        return (
+            f"{self.databrowser_url}/data-search/{self.flavour}/{self.uniq_key}"
+        )
 
     @property
     def zarr_loader_url(self) -> str:
@@ -140,13 +146,14 @@ class Config:
     @property
     def intake_url(self) -> str:
         """Define the url for creating intake catalogues."""
-        return f"{self.databrowser_url}/intake_catalogue/{self.flavour}/{self.uniq_key}"
+        return f"{self.databrowser_url}/intake-catalogue/{self.flavour}/{self.uniq_key}"
 
     @property
     def metadata_url(self) -> str:
         """Define the endpoint for the metadata search."""
         return (
-            f"{self.databrowser_url}/metadata_search/" f"{self.flavour}/{self.uniq_key}"
+            f"{self.databrowser_url}/metadata-search/"
+            f"{self.flavour}/{self.uniq_key}"
         )
 
     @staticmethod
@@ -166,7 +173,7 @@ class Config:
         if port:
             hostname = f"{hostname}:{port}"
         hostname = hostname.partition("/")[0]
-        return f"{scheme}://{hostname}/api"
+        return f"{scheme}://{hostname}/api/freva-nextgen"
 
     @staticmethod
     def get_dirs(user: bool = True) -> Path:
@@ -199,9 +206,12 @@ class UserDataHandler:
     This class is used for processing user data and extracting metadata
     from the data files.
     """
+
     def __init__(self, userdata_items: List[Union[str, xr.Dataset]]) -> None:
         self._suffixes = [".nc", ".nc4", ".grb", ".grib", ".zarr", "zar"]
-        self.user_metadata: List[Dict[str, Union[str, List[str], Dict[str, str]]]] = []
+        self.user_metadata: List[
+            Dict[str, Union[str, List[str], Dict[str, str]]]
+        ] = []
         self._metadata_collection: List[Dict[str, Union[str, List[str]]]] = []
         try:
             self._executor = concurrent.futures.ThreadPoolExecutor(
@@ -238,28 +248,37 @@ class UserDataHandler:
                 validated_xarray_datasets.append(data)
 
         if not validated_paths and not validated_xarray_datasets:
-            raise FileNotFoundError("No valid file paths or xarray datasets found.")
+            raise FileNotFoundError(
+                "No valid file paths or xarray datasets found."
+            )
         return {
             "validated_user_paths": validated_paths,
             "validated_user_xrdatasets": validated_xarray_datasets,
         }
 
-    def _process_user_data(self, userdata_items: List[Union[str, xr.Dataset]],
-                           ) -> None:
+    def _process_user_data(
+        self,
+        userdata_items: List[Union[str, xr.Dataset]],
+    ) -> None:
         """Process xarray datasets and file paths using thread pool."""
         futures = []
-        validated_userdata: Dict[str, Union[List[Path], List[xr.Dataset]]] = \
+        validated_userdata: Dict[str, Union[List[Path], List[xr.Dataset]]] = (
             self._validate_user_data(userdata_items)
+        )
         if validated_userdata["validated_user_xrdatasets"]:
             futures.append(
-                self._executor.submit(self._process_userdata_in_executor,
-                                      validated_userdata["validated_user_xrdatasets"])
+                self._executor.submit(
+                    self._process_userdata_in_executor,
+                    validated_userdata["validated_user_xrdatasets"],
+                )
             )
 
         if validated_userdata["validated_user_paths"]:
             futures.append(
-                self._executor.submit(self._process_userdata_in_executor,
-                                      validated_userdata["validated_user_paths"])
+                self._executor.submit(
+                    self._process_userdata_in_executor,
+                    validated_userdata["validated_user_paths"],
+                )
             )
         for future in futures:
             try:
@@ -309,11 +328,11 @@ class UserDataHandler:
 
         try:
             dset = (
-                path if isinstance(path, xr.Dataset)
-                else xr.open_mfdataset(str(path),
-                                       parallel=False,
-                                       use_cftime=True,
-                                       lock=False)
+                path
+                if isinstance(path, xr.Dataset)
+                else xr.open_mfdataset(
+                    str(path), parallel=False, use_cftime=True, lock=False
+                )
             )
             time_freq = dset.attrs.get("frequency", "")
             data_vars = list(map(str, dset.data_vars))
@@ -328,16 +347,26 @@ class UserDataHandler:
             return {}
         if len(times) > 0:
             try:
-                time_str = f"[{times[0].isoformat()}Z TO {times[-1].isoformat()}Z]"
-                dt = abs((times[1] - times[0]).total_seconds()) if len(times) > 1 else 0
+                time_str = (
+                    f"[{times[0].isoformat()}Z TO {times[-1].isoformat()}Z]"
+                )
+                dt = (
+                    abs((times[1] - times[0]).total_seconds())
+                    if len(times) > 1
+                    else 0
+                )
             except Exception as non_cftime:
-                logger.info("The time var is not based on the cftime: %s", non_cftime)
+                logger.info(
+                    "The time var is not based on the cftime: %s", non_cftime
+                )
                 time_str = (
                     f"[{np.datetime_as_string(times[0], unit='s')}Z TO "
                     f"{np.datetime_as_string(times[-1], unit='s')}Z]"
                 )
                 dt = (
-                    abs((times[1] - times[0]).astype("timedelta64[s]").astype(int))
+                    abs(
+                        (times[1] - times[0]).astype("timedelta64[s]").astype(int)
+                    )
                     if len(times) > 1
                     else 0
                 )
@@ -357,7 +386,9 @@ class UserDataHandler:
 
         _data: Dict[str, Union[str, List[str], Dict[str, str]]] = {}
         _data.setdefault("variable", variables[0])
-        _data.setdefault("time_frequency", self._get_time_frequency(dt, time_freq))
+        _data.setdefault(
+            "time_frequency", self._get_time_frequency(dt, time_freq)
+        )
         _data["time"] = time_str
         _data.setdefault("cmor_table", _data["time_frequency"])
         _data.setdefault("version", "")