freva-client 2502.0.0__py3-none-any.whl → 2506.0.0__py3-none-any.whl

freva_client/utils/auth_utils.py

@@ -0,0 +1,240 @@
+"""Helper functions for authentication."""
+
+import json
+import os
+import socket
+import sys
+import time
+from pathlib import Path
+from typing import Literal, Optional, TypedDict, Union, cast
+
+from appdirs import user_cache_dir
+
+TOKEN_EXPIRY_BUFFER = 60  # seconds
+TOKEN_ENV_VAR = "FREVA_TOKEN_FILE"
+
+
+class Token(TypedDict):
+    """Token information."""
+
+    access_token: str
+    token_type: str
+    expires: int
+    refresh_token: str
+    refresh_expires: int
+    scope: str
+
+
+def get_default_token_file() -> Path:
+    """Get the location of the default token file."""
+    path_str = os.getenv(TOKEN_ENV_VAR, "").strip()
+
+    path = Path(
+        path_str or os.path.join(user_cache_dir("freva"), "auth-token.json")
+    )
+    path.parent.mkdir(exist_ok=True, parents=True)
+    return path
+
+
+def is_job_env() -> bool:
+    """Detect whether we are running in a batch or job-managed environment.
+
+    Returns
+    -------
+    bool
+        True if common batch or workload manager environment variables are present.
+    """
+
+    job_env_vars = [
+        # Slurm, PBS, Moab
+        "SLURM_JOB_ID",
+        "SLURM_NODELIST",
+        "PBS_JOBID",
+        "PBS_ENVIRONMENT",
+        "PBS_NODEFILE",
+        # SGE
+        "JOB_ID",
+        "SGE_TASK_ID",
+        "PE_HOSTFILE",
+        # LSF
+        "LSB_JOBID",
+        "LSB_HOSTS",
+        # OAR
+        "OAR_JOB_ID",
+        "OAR_NODEFILE",
+        # MPI
+        "OMPI_COMM_WORLD_SIZE",
+        "PMI_RANK",
+        "MPI_LOCALRANKID",
+        # Kubernetes
+        "KUBERNETES_SERVICE_HOST",
+        "KUBERNETES_PORT",
+        # FREVA BATCH MODE
+        "FREVA_BATCH_JOB",
+        # JHUB SESSION
+        "JUPYTERHUB_USER",
+    ]
+    return any(var in os.environ for var in job_env_vars)
+
+
+def is_jupyter_notebook() -> bool:
+    """Check if running in a Jupyter notebook.
+
+    Returns
+    -------
+    bool
+        True if inside a Jupyter notebook or Jupyter kernel.
+    """
+    try:
+        from IPython import get_ipython
+
+        return get_ipython() is not None  # pragma: no cover
+    except Exception:
+        return False
+
+
+def is_interactive_shell() -> bool:
+    """Check whether we are running in an interactive terminal.
+
+    Returns
+    -------
+    bool
+        True if stdin and stdout are TTYs.
+    """
+    return sys.stdin.isatty() and sys.stdout.isatty()
+
+
+def is_interactive_auth_possible() -> bool:
+    """Decide if an interactive browser-based auth flow is possible.
+
+    Returns
+    -------
+    bool
+        True if not in a batch/job/JupyterHub context and either in a TTY or
+        local Jupyter.
+    """
+    return (is_interactive_shell() or is_jupyter_notebook()) and not (
+        is_job_env()
+    )
+
+
+def resolve_token_path(custom_path: Optional[Union[str, Path]] = None) -> Path:
+    """Resolve the path to the token file.
+
+    Parameters
+    ----------
+    custom_path : str or None
+        Optional path override.
+
+    Returns
+    -------
+    Path
+        The resolved path to the token file.
+    """
+    if custom_path:
+        return Path(custom_path).expanduser().absolute()
+    path = get_default_token_file()
+    return path.expanduser().absolute()
+
+
+def load_token(path: Optional[Union[str, Path]]) -> Optional[Token]:
+    """Load a token dictionary from the given file path.
+
+    Parameters
+    ----------
+    path : Path or None
+        Path to the token file.
+
+    Returns
+    -------
+    dict or None
+        Parsed token dict or None if load fails.
+    """
+    path = resolve_token_path(path)
+    try:
+        token: Token = json.loads(path.read_text())
+        return token
+    except Exception:
+        return None
+
+
+def is_token_valid(
+    token: Optional[Token], token_type: Literal["access_token", "refresh_token"]
+) -> bool:
+    """Check if a refresh token is available.
+
+    Parameters
+    ----------
+    token : dict
+        Token dictionary.
+    typken_type: str
+        What type of token to check for.
+
+    Returns
+    -------
+    bool
+        True if a refresh token is present.
+    """
+    exp = cast(
+        Literal["refresh_expires", "expires"],
+        {
+            "refresh_token": "refresh_expires",
+            "access_token": "expires",
+        }[token_type],
+    )
+    return cast(
+        bool,
+        (
+            token
+            and token_type in token
+            and exp in token
+            and (time.time() + TOKEN_EXPIRY_BUFFER < token[exp])
+        ),
+    )
+
+
+def choose_token_strategy(
+    token: Optional[Token] = None, token_file: Optional[Path] = None
+) -> Literal["use_token", "refresh_token", "browser_auth", "fail"]:
+    """Decide what action to take based on token state and environment.
+
+    Parameters
+    ----------
+    token : dict|None, default: None
+        Token dictionary or None if no token file found.
+    token_file: Path|None, default: None
+        Path to the file holding token information.
+
+    Returns
+    -------
+    str
+        One of:
+        - "use_token"       : Access token is valid and usable.
+        - "refresh_token"   : Refresh token should be used to get new access token.
+        - "browser_auth"    : Interactive login via browser is allowed.
+        - "fail"            : No way to log in in current environment.
+    """
+    if is_token_valid(token, "access_token"):
+        return "use_token"
+    if is_token_valid(token, "refresh_token"):
+        return "refresh_token"
+    if is_interactive_auth_possible():
+        return "browser_auth"
+    return "fail"
+
+
+def wait_for_port(host: str, port: int, timeout: float = 5.0) -> None:
+    """Wait until a TCP port starts accepting connections."""
+    deadline = time.time() + timeout
+    while time.time() < deadline:
+        with socket.socket(socket.AF_INET, socket.SOCK_STREAM) as sock:
+            sock.settimeout(0.5)
+            try:
+                if sock.connect_ex((host, port)) == 0:
+                    return
+            except OSError:
+                pass
+        time.sleep(0.05)
+    raise TimeoutError(
+        f"Port {port} on {host} did not open within {timeout} seconds."
+    )

freva_client/utils/databrowser_utils.py

@@ -141,13 +141,18 @@ class Config:
     @property
     def zarr_loader_url(self) -> str:
         """Define the url for getting zarr files."""
-        return f"{self.databrowser_url}/load/{self.flavour}/"
+        return f"{self.databrowser_url}/load/{self.flavour}"
 
     @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}"
 
+    @property
+    def stac_url(self) -> str:
+        """Define the url for creating stac catalogue."""
+        return f"{self.databrowser_url}/stac-catalogue/{self.flavour}/{self.uniq_key}"
+
     @property
     def metadata_url(self) -> str:
         """Define the endpoint for the metadata search."""
@@ -325,13 +330,13 @@ class UserDataHandler:
         self, path: Union[os.PathLike[str], xr.Dataset]
     ) -> Dict[str, Union[str, List[str], Dict[str, str]]]:
         """Get metadata from a path or xarray dataset."""
-
+        time_coder = xr.coders.CFDatetimeCoder(use_cftime=True)
         try:
             dset = (
                 path
                 if isinstance(path, xr.Dataset)
                 else xr.open_mfdataset(
-                    str(path), parallel=False, use_cftime=True, lock=False
+                    str(path), parallel=False, decode_times=time_coder, lock=False
                 )
             )
             time_freq = dset.attrs.get("frequency", "")

{freva_client-2502.0.0.dist-info → freva_client-2506.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: freva-client
-Version: 2502.0.0
+Version: 2506.0.0
 Summary: Search for climate data based on key-value pairs
 Author-email: "DKRZ, Clint" <freva@dkrz.de>
 Requires-Python: >=3.8
@@ -19,7 +19,6 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: appdirs
 Requires-Dist: pyyaml
-Requires-Dist: authlib
 Requires-Dist: requests
 Requires-Dist: intake_esm
 Requires-Dist: rich

freva_client-2506.0.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+freva_client/__init__.py,sha256=l4En1aqpj7TMWuOdt6kCtQLwoOGPYx7qMrNqwCKKMpU,851
+freva_client/__main__.py,sha256=JVj12puT4o8JfhKLAggR2-NKCZa3wKwsYGi4HQ61DOQ,149
+freva_client/auth.py,sha256=o3s82ImfgFAkg61hcputU0rOSnfTuAJIfKwMYxlP0yM,10610
+freva_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+freva_client/query.py,sha256=cKgY2i3r-JriayMWLI8JqIn7F_TRasl4GPvZ_YVGWmw,40640
+freva_client/cli/__init__.py,sha256=NgTqBZGdozmTZtJduJUMrZj-opGw2KoT20tg6sc_xqo,149
+freva_client/cli/auth_cli.py,sha256=O4GPgGdCYnJz9rTUR27cSEy801Z91_ICGYaduIhkBfY,1801
+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=-KqROP0H12weHrK6tTgqzjjuRrleYPoPfP8N1n_lAGo,32196
+freva_client/utils/__init__.py,sha256=ySHn-3CZBwfZW2s0EpZ3INxUWOw1V4LOlKIxSLYr52U,1000
+freva_client/utils/auth_utils.py,sha256=QXT9gitISj22rrQ3I9DBg4LZz6t5oGbdG59ChUsu8io,6002
+freva_client/utils/databrowser_utils.py,sha256=9w9zu5Uc-QWCOXqMnwa1yv7gyHLIKN4STAjjXJkklgg,14440
+freva_client/utils/logger.py,sha256=xd_3jjbsD1UBWlZZe8OUtKLpG7lbLcH46yiJ_bftyKg,2464
+freva_client-2506.0.0.data/data/share/freva/freva.toml,sha256=64Rh4qvWc9TaGJMXMi8tZW14FnESt5Z24y17BfD2VyM,736
+freva_client-2506.0.0.dist-info/entry_points.txt,sha256=zGyEwHrH_kAGLsCXv00y7Qnp-WjXkUuIomHkfGMCxtA,53
+freva_client-2506.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+freva_client-2506.0.0.dist-info/METADATA,sha256=UZe4YEIaydXRaQ--r4dIc7cjaIL-gzk7wRQWeEB24rI,2503
+freva_client-2506.0.0.dist-info/RECORD,,

{freva_client-2502.0.0.dist-info → freva_client-2506.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: flit 3.11.0
+Generator: flit 3.12.0
 Root-Is-Purelib: true
 Tag: py3-none-any

freva_client-2502.0.0.dist-info/RECORD

@@ -1,19 +0,0 @@
-freva_client/__init__.py,sha256=T8gGhWl4PHUFdDJ0kLyxUZhTVwxzwMB6IUY0f6OOfcc,851
-freva_client/__main__.py,sha256=JVj12puT4o8JfhKLAggR2-NKCZa3wKwsYGi4HQ61DOQ,149
-freva_client/auth.py,sha256=o33EKI5CxMOBY0nWFLmZT-V6v2U9L1qGjLcE7y4PIoE,6814
-freva_client/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-freva_client/query.py,sha256=ZxGPkU9B5JROCMIQ_AmhTKLlVPOCE2ENs4p7o9Jxge0,34095
-freva_client/cli/__init__.py,sha256=NgTqBZGdozmTZtJduJUMrZj-opGw2KoT20tg6sc_xqo,149
-freva_client/cli/auth_cli.py,sha256=3sThrF0YUgSzdwzzc5ww_GJlzUDK3jx-gQG9Z0hneRk,1843
-freva_client/cli/cli_app.py,sha256=QH6cb9XZTx8S9L0chPWOVd9Jn4GD1hd3sENAhdzmLZU,887
-freva_client/cli/cli_parser.py,sha256=c-_WG56g6arLvnayb9SO1OeHt7AjBV4egI_vTEYee4I,5042
-freva_client/cli/cli_utils.py,sha256=Ev9UxM4S1ZDbZSAGHFe5dMjVGot75w3muNKH3P80bHY,842
-freva_client/cli/databrowser_cli.py,sha256=r_Tl1yxLBZPMqY8vmJiOAvF_envTtf6c6KwQKjwdAq8,24387
-freva_client/utils/__init__.py,sha256=ySHn-3CZBwfZW2s0EpZ3INxUWOw1V4LOlKIxSLYr52U,1000
-freva_client/utils/databrowser_utils.py,sha256=kGTYjeHWBOIEcLkFuXhZ7ai6_j_DUzVq7hq7HEOYaho,14179
-freva_client/utils/logger.py,sha256=xd_3jjbsD1UBWlZZe8OUtKLpG7lbLcH46yiJ_bftyKg,2464
-freva_client-2502.0.0.data/data/share/freva/freva.toml,sha256=64Rh4qvWc9TaGJMXMi8tZW14FnESt5Z24y17BfD2VyM,736
-freva_client-2502.0.0.dist-info/entry_points.txt,sha256=zGyEwHrH_kAGLsCXv00y7Qnp-WjXkUuIomHkfGMCxtA,53
-freva_client-2502.0.0.dist-info/WHEEL,sha256=_2ozNFCLWc93bK4WKHCO-eDUENDlo-dgc9cU3qokYO4,82
-freva_client-2502.0.0.dist-info/METADATA,sha256=G2VWBzP6OFpIOpCY-tPE2mipQVoYvaBF9gO-nrG-yEs,2526
-freva_client-2502.0.0.dist-info/RECORD,,