cdsetool 0.2.10__tar.gz → 0.2.12__tar.gz

{cdsetool-0.2.10/src/cdsetool.egg-info → cdsetool-0.2.12}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.1
 Name: cdsetool
-Version: 0.2.10
+Version: 0.2.12
 Summary: Tools & CLI for interacting with CDSE product APIs
 Author-email: Jacob Vejby <javej@sdfi.dk>
-Project-URL: Homepage, https://github.com/SDFIdk/CDSETool
-Project-URL: Bug Tracker, https://github.com/SDFIdk/CDSETool/issues
+Project-URL: Homepage, https://github.com/CDSETool/CDSETool
+Project-URL: Bug Tracker, https://github.com/CDSETool/CDSETool/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: typer<0.13,>=0.9
-Requires-Dist: rich<13.8,>=13.6
-Requires-Dist: requests<2.33.0,>=2.28.1
+Requires-Dist: typer<1,>=0.9
+Requires-Dist: rich<14,>=13.6
+Requires-Dist: requests<3,>=2.28.1
 Requires-Dist: pyjwt[crypto]~=2.8.0
 Requires-Dist: geopandas>=0.13.2
 Provides-Extra: test
 Requires-Dist: black==24.4.2; extra == "test"
-Requires-Dist: pylint==3.2.2; extra == "test"
-Requires-Dist: pytest==8.2.0; extra == "test"
+Requires-Dist: pylint==3.2.6; extra == "test"
+Requires-Dist: pytest==8.3.2; extra == "test"
 Requires-Dist: pytest-cov==5.0.0; extra == "test"
 Requires-Dist: requests-mock==1.12.1; extra == "test"
 Requires-Dist: pytest-mock==3.14.0; extra == "test"
@@ -96,7 +96,7 @@ cdsetool download Sentinel2 PATH/TO/DIR --concurrency 4 --search-term startDate=
 Install `cdsetool` using pip:
 
 ```bash
-pip install cdsetool==0.2.10
+pip install cdsetool==0.2.12
 ```
 
 ## Usage

{cdsetool-0.2.10 → cdsetool-0.2.12}/README.md

@@ -71,7 +71,7 @@ cdsetool download Sentinel2 PATH/TO/DIR --concurrency 4 --search-term startDate=
 Install `cdsetool` using pip:
 
 ```bash
-pip install cdsetool==0.2.10
+pip install cdsetool==0.2.12
 ```
 
 ## Usage

{cdsetool-0.2.10 → cdsetool-0.2.12}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "cdsetool"
-version = "0.2.10"
+version = "0.2.12"
 authors = [
   { name="Jacob Vejby", email="javej@sdfi.dk" },
 ]
@@ -16,25 +16,25 @@ classifiers = [
   "Operating System :: OS Independent",
 ]
 dependencies = [
-  "typer >= 0.9,< 0.13",
-  "rich >= 13.6,< 13.8",
-  "requests >= 2.28.1,< 2.33.0",
+  "typer >= 0.9,< 1",
+  "rich >= 13.6,< 14",
+  "requests >= 2.28.1,< 3",
   "pyjwt[crypto] ~= 2.8.0",
   "geopandas >= 0.13.2",
 ]
 [project.optional-dependencies]
 test = [
     "black==24.4.2",
-    "pylint==3.2.2",
-    "pytest==8.2.0",
+    "pylint==3.2.6",
+    "pytest==8.3.2",
     "pytest-cov==5.0.0",
     "requests-mock==1.12.1",
     "pytest-mock==3.14.0",
 ]
 
 [project.urls]
-"Homepage" = "https://github.com/SDFIdk/CDSETool"
-"Bug Tracker" = "https://github.com/SDFIdk/CDSETool/issues"
+"Homepage" = "https://github.com/CDSETool/CDSETool"
+"Bug Tracker" = "https://github.com/CDSETool/CDSETool/issues"
 
 [project.scripts]
 cdsetool = "cdsetool:cli.main"
@@ -46,6 +46,17 @@ max-locals = 20
 max-line-length = "88"
 disable="fixme"
 
+[tool.pyright]
+exclude = ["**/__pycache__", ".venv"]
+
+# Can be strict too, see more fine-grained settings at:
+# https://github.com/microsoft/pyright/blob/main/docs/configuration.md#diagnostic-settings-defaults
+typeCheckingMode = "standard"
+
+executionEnvironments = [
+  { root = "./" }
+]
+
 [tool.pytest.ini_options]
 addopts = [
     "--import-mode=importlib",

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool/_processing.py

@@ -2,11 +2,18 @@
 This module provides functions for processing data concurrently
 """
 
-from concurrent.futures import wait, FIRST_COMPLETED
+from concurrent.futures import Future, wait, FIRST_COMPLETED
 from concurrent.futures import ThreadPoolExecutor
+from typing import Callable, Generator, Iterable, List, Union
 
+from cdsetool.query import FeatureQuery
 
-def _concurrent_process(fun, iterable, workers=4):
+
+def _concurrent_process(
+    fun: Callable[[FeatureQuery], Union[str, None]],
+    iterable: Iterable,
+    workers: int = 4,
+) -> Generator[Union[str, None], None, None]:
     """
     Process items in an iterable concurrently
 
@@ -26,17 +33,17 @@ def _concurrent_process(fun, iterable, workers=4):
     iterator = iter(iterable)
 
     with ThreadPoolExecutor(max_workers=workers) as executor:
-        futures = []
+        futures: List[Future[Union[str, None]]] = []  # pylint: disable=E1136
 
         # Pluck an item from the iterable and submit it to the executor.
         # If the iterable is exhausted, this function is a no-op.
-        def submit_item():
+        def submit_item() -> None:
             item = next(iterator, None)
             if item is not None:
                 futures.append(executor.submit(fun, item))
 
         # Fill the futures list up to the low water mark
-        def fill_futures():
+        def fill_futures() -> None:
             for _ in range(low_water_mark - len(futures)):
                 submit_item()
 
@@ -47,8 +54,8 @@ def _concurrent_process(fun, iterable, workers=4):
         while futures:
 
             # Wait for the first future(s) to complete
-            done, futures = wait(futures, return_when=FIRST_COMPLETED)
-            futures = list(futures)
+            done, not_done = wait(futures, return_when=FIRST_COMPLETED)
+            futures = list(not_done)
 
             for future in done:
                 yield future.result()

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool/cli.py

@@ -5,21 +5,21 @@ Command line interface
 import os
 import sys
 import json as JSON
-from typing import List, Optional
+from typing import Dict, List, Optional
 from typing_extensions import Annotated
 import typer
 from cdsetool.query import describe_collection, query_features
 from cdsetool.monitor import StatusMonitor
 from cdsetool.download import download_features
 
-app = typer.Typer()
+app = typer.Typer(no_args_is_help=True)
 
-query_app = typer.Typer()
+query_app = typer.Typer(no_args_is_help=True)
 app.add_typer(query_app, name="query")
 
 
 @query_app.command("search-terms")
-def query_search_terms(collection: str):
+def query_search_terms(collection: str) -> None:
     """
     List the available search terms for a collection
     """
@@ -51,13 +51,12 @@ def query_search(
         ),
     ] = None,
     json: Annotated[bool, typer.Option(help="Output JSON")] = False,
-):
+) -> None:
     """
     Search for features matching the search terms
     """
     search_term = search_term or []
-    search_term = _to_dict(search_term)
-    features = query_features(collection, search_term)
+    features = query_features(collection, _to_dict(search_term))
 
     for feature in features:
         if json:
@@ -84,7 +83,7 @@ def download(
             + "Pass multiple times for multiple search terms"
         ),
     ] = None,
-):
+) -> None:
     """
     Download all features matching the search terms
     """
@@ -93,8 +92,7 @@ def download(
         sys.exit(1)
 
     search_term = search_term or []
-    search_term = _to_dict(search_term)
-    features = query_features(collection, search_term)
+    features = query_features(collection, _to_dict(search_term))
 
     list(
         download_features(
@@ -116,9 +114,13 @@ def main():
     app()
 
 
-def _to_dict(term_list: List[str]):
+def _to_dict(term_list: List[str]) -> Dict[str, str]:
     search_terms = {}
     for item in term_list:
         key, value = item.split("=")
         search_terms[key] = value
     return search_terms
+
+
+if __name__ == "__main__":
+    main()

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool/credentials.py

@@ -6,6 +6,8 @@ the Copernicus Identity and Access Management (IAM) system.
 from datetime import datetime, timedelta
 import netrc
 import threading
+from typing import Any, Dict, List, Union
+
 import requests
 import jwt
 from requests.adapters import HTTPAdapter
@@ -79,27 +81,27 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
 
     def __init__(
         self,
-        username=None,
-        password=None,
-        openid_configuration_endpoint=None,
-        proxies=None,
-    ):
-        self.__username = username
-        self.__password = password
-
-        self.__proxies = proxies
+        username: Union[str, None] = None,
+        password: Union[str, None] = None,
+        openid_configuration_endpoint: Union[str, None] = None,
+        proxies: Union[Dict[str, str], None] = None,
+    ) -> None:
+        self.__username: Union[str, None] = username
+        self.__password: Union[str, None] = password
+
+        self.__proxies: Union[Dict[str, str], None] = proxies
         self.__openid_conf = None
         self.__jwks = None
-        self.__openid_configuration_endpoint = (
+        self.__openid_configuration_endpoint: str = (
             openid_configuration_endpoint
             or "https://identity.dataspace.copernicus.eu"
             + "/auth/realms/CDSE/.well-known/openid-configuration"
         )
 
-        self.__access_token = None
-        self.__refresh_token = None
-        self.__access_token_expires = datetime.now() - timedelta(hours=8)
-        self.__refresh_token_expires = self.__access_token_expires
+        self.__access_token: Union[str, None] = None
+        self.__refresh_token: Union[str, None] = None
+        self.__access_token_expires: datetime = datetime.now() - timedelta(hours=8)
+        self.__refresh_token_expires: datetime = self.__access_token_expires
 
         self.__lock = threading.Lock()
 
@@ -108,14 +110,19 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
 
         self.__ensure_tokens()
 
-    def get_session(self):
+    def get_session(self) -> requests.Session:
         """
         Returns a session with the credentials set as the Authorization header
         """
         return self.make_session(self, True, self.RETRIES, self.__proxies)
 
     @staticmethod
-    def make_session(caller, authorization, max_retries, proxies):
+    def make_session(
+        caller,
+        authorization: bool,
+        max_retries: Retry,
+        proxies: Union[Dict[str, str], None],
+    ) -> requests.Session:
         """
         Creates a new session. Authorization is only available from callers
         that are subclasses of Credentials.
@@ -133,14 +140,14 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
             session.headers.update({"Authorization": f"Bearer {token}"})
         return session
 
-    def __token_exchange(self, data):
+    def __token_exchange(self, data: Dict[str, str]) -> timedelta:
         # Make a session that will retry post, respecting the retry-after
         # header when we get a 503 and a few other temporary failures.
         session = self.make_session(
             caller=self,
             authorization=False,
             max_retries=Retry(
-                total=2,
+                total=15,
                 backoff_factor=0.5,
                 allowed_methods=None,
                 raise_on_status=False,
@@ -154,7 +161,7 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
             raise InvalidCredentialsException(
                 "Unable to exchange token with "
                 + f"username: {self.__username} and "
-                + f"password: {len(self.__password) * '*'}"
+                + f"password: {len(self.__password or '') * '*'}"
             )
 
         if response.status_code != 200:
@@ -166,7 +173,7 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
         self.__refresh_token = response["refresh_token"]
         return timedelta(seconds=response["refresh_expires_in"])
 
-    def __ensure_tokens(self):
+    def __ensure_tokens(self) -> None:
         with self.__lock:
             refresh_expire_delta = None
             if self.__access_token_expires < datetime.now():
@@ -184,6 +191,10 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
                         "client_id": "cdse-public",
                     }
                 refresh_expire_delta = self.__token_exchange(data)
+            if not self.__access_token:
+                raise InvalidCredentialsException(
+                    "Internal error: access token not available"
+                )
             try:
                 key = self.__jwk_client.get_signing_key_from_jwt(self.__access_token)
             except jwt.PyJWKClientConnectionError as e:
@@ -203,16 +214,15 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
                     datetime.fromtimestamp(data["iat"]) + refresh_expire_delta
                 )
 
-    def __read_credentials(self):
-        try:
-            self.__username, _, self.__password = netrc.netrc().authenticators(
-                self.__token_endpoint
-            )
-        except Exception as exc:
-            raise NoCredentialsException("No credentials found") from exc
+    def __read_credentials(self) -> None:
+        rv = netrc.netrc().authenticators(self.__token_endpoint)
+        if isinstance(rv, tuple):
+            self.__username, _, self.__password = rv
+        else:
+            raise NoCredentialsException("No credentials found")
 
     @property
-    def __openid_configuration(self):
+    def __openid_configuration(self) -> Dict[str, Any]:
         if self.__openid_conf:
             return self.__openid_conf
 
@@ -228,19 +238,19 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
         return self.__openid_conf
 
     @property
-    def __token_endpoint(self):
+    def __token_endpoint(self) -> str:
         return self.__openid_configuration["token_endpoint"]
 
     @property
-    def __jwks_uri(self):
+    def __jwks_uri(self) -> str:
         return self.__openid_configuration["jwks_uri"]
 
     @property
-    def __id_token_signing_algos(self):
+    def __id_token_signing_algos(self) -> List[str]:
         return self.__openid_configuration["id_token_signing_alg_values_supported"]
 
     @property
-    def __jwk_client(self):
+    def __jwk_client(self) -> jwt.PyJWKClient:
         if self.__jwks:
             return self.__jwks
 
@@ -249,7 +259,9 @@ class Credentials:  # pylint: disable=too-few-public-methods disable=too-many-in
         return self.__jwks
 
 
-def validate_credentials(username=None, password=None):
+def validate_credentials(
+    username: Union[str, None] = None, password: Union[str, None] = None
+) -> bool:
     """
     This function validates CDSE credentials and returns a bool.
     If credentials are none, .netrc will be validated

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool/download.py

@@ -10,6 +10,9 @@ import random
 import tempfile
 import time
 import shutil
+from typing import Any, Dict, Generator, Union
+
+from requests import Session
 from requests.exceptions import ChunkedEncodingError
 from urllib3.exceptions import ProtocolError
 from cdsetool._processing import _concurrent_process
@@ -19,10 +22,13 @@ from cdsetool.credentials import (
     TokenExpiredSignatureError,
 )
 from cdsetool.logger import NoopLogger
-from cdsetool.monitor import NoopMonitor
+from cdsetool.monitor import NoopMonitor, StatusMonitor
+from cdsetool.query import FeatureQuery
 
 
-def download_feature(feature, path, options=None):
+def download_feature(
+    feature, path: str, options: Union[Dict[str, Any], None] = None
+) -> Union[str, None]:
     """
     Download a single feature
 
@@ -32,6 +38,7 @@ def download_feature(feature, path, options=None):
     log = _get_logger(options)
     url = _get_feature_url(feature)
     title = feature.get("properties").get("title")
+    temp_dir_usr = _get_temp_dir(options)
 
     if not url or not title:
         log.debug(f"Bad URL ('{url}') or title ('{title}')")
@@ -52,19 +59,25 @@ def download_feature(feature, path, options=None):
             # Always get a new session, credentials might have expired.
             try:
                 session = _get_credentials(options).get_session()
-            except (TokenClientConnectionError, TokenExpiredSignatureError) as e:
-                log.warning(e)
+            except TokenClientConnectionError:
+                log.warning("Token client connection failed, retrying..")
+                continue
+            except TokenExpiredSignatureError:
+                log.warning("Token signature expired, retrying..")
                 continue
             url = _follow_redirect(url, session)
-            with session.get(url, stream=True) as response:
+            name_dir_prefix = filename.replace(".zip", "____")
+            with session.get(url, stream=True) as response, tempfile.TemporaryDirectory(
+                prefix=name_dir_prefix, dir=temp_dir_usr
+            ) as temp_dir:
                 if response.status_code != 200:
                     log.warning(f"Status code {response.status_code}, retrying..")
                     time.sleep(60 * (1 + (random.random() / 4)))
                     continue
 
                 status.set_filesize(int(response.headers["Content-Length"]))
-
-                with tempfile.NamedTemporaryFile() as file:
+                tmp_file = os.path.join(temp_dir, "download.zip")
+                with open(tmp_file, "wb") as file:
                     # Server might not send all bytes specified by the
                     # Content-Length header before closing connection.
                     # Log as a warning and try again.
@@ -79,14 +92,16 @@ def download_feature(feature, path, options=None):
                     ) as e:
                         log.warning(e)
                         continue
-                    shutil.copy(file.name, result_path)
-
+                # Close file before copy so all buffers are flushed.
+                shutil.copy(tmp_file, result_path)
                 return filename
     log.error(f"Failed to download {filename}")
     return None
 
 
-def download_features(features, path, options=None):
+def download_features(
+    features: FeatureQuery, path: str, options: Union[Dict[str, Any], None] = None
+) -> Generator[Union[str, None], None, None]:
     """
     Generator function that downloads all features in a result set
 
@@ -100,7 +115,7 @@ def download_features(features, path, options=None):
     options["monitor"] = _get_monitor(options)
     options["monitor"].start()
 
-    def _download_feature(feature):
+    def _download_feature(feature) -> Union[str, None]:
         return download_feature(feature, path, options)
 
     yield from _concurrent_process(
@@ -110,11 +125,11 @@ def download_features(features, path, options=None):
     options["monitor"].stop()
 
 
-def _get_feature_url(feature):
+def _get_feature_url(feature) -> str:
     return feature.get("properties").get("services").get("download").get("url")
 
 
-def _follow_redirect(url, session):
+def _follow_redirect(url: str, session: Session) -> str:
     response = session.head(url, allow_redirects=False)
     while response.status_code in range(300, 400):
         url = response.headers["Location"]
@@ -123,15 +138,19 @@ def _follow_redirect(url, session):
     return url
 
 
-def _get_logger(options):
+def _get_logger(options: Dict) -> NoopLogger:
     return options.get("logger") or NoopLogger()
 
 
-def _get_monitor(options):
+def _get_monitor(options: Dict) -> Union[StatusMonitor, NoopMonitor]:
     return options.get("monitor") or NoopMonitor()
 
 
-def _get_credentials(options):
+def _get_credentials(options: Dict) -> Credentials:
     return options.get("credentials") or Credentials(
         proxies=options.get("proxies", None)
     )
+
+
+def _get_temp_dir(options: Dict) -> Union[str, None]:
+    return options.get("tmpdir") or None

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool/logger.py

@@ -10,17 +10,22 @@ class NoopLogger:
     A logger that does nothing.
     """
 
-    def debug(self, *kwargs):
+    def debug(self, msg, *args, **kwargs):
         """
         Log a debug message.
         """
 
-    def info(self, *kwargs):
+    def error(self, msg, *args, **kwargs):
+        """
+        Log an error message.
+        """
+
+    def info(self, msg, *args, **kwargs):
         """
         Log an info message.
         """
 
-    def warning(self, *kwargs):
+    def warning(self, msg, *args, **kwargs):
         """
         Log a warning message.
         """

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool/monitor.py

@@ -14,12 +14,13 @@ import sys
 import os
 import signal
 import shutil
+from typing import List, Tuple, Union
 
 IS_IPYTHON = True
 
 try:
-    from IPython import get_ipython
-    from IPython.display import clear_output
+    from IPython import get_ipython  # type:ignore[reportMissingImports]
+    from IPython.display import clear_output  # type:ignore[reportMissingImports]
 
     if "IPKernelApp" not in get_ipython().config:
         IS_IPYTHON = False
@@ -46,16 +47,16 @@ class StatusMonitor(threading.Thread):
             status.add_progress(512)
     """
 
-    line_length = 80
+    line_length: int = 80
 
-    __is_running = True
-    __progress_lines = 0
+    __is_running: bool = True
+    __progress_lines: int = 0
 
-    __download_speed_deltas = []
+    __download_speed_deltas: List[int] = []
     __done = []
     __status = []
 
-    def start(self):
+    def start(self) -> None:
         """
         Start the monitor
         """
@@ -70,13 +71,13 @@ class StatusMonitor(threading.Thread):
 
         super().start()
 
-    def stop(self):
+    def stop(self) -> None:
         """
         Stop the monitor
         """
         self.__is_running = False
 
-    def status(self):
+    def status(self) -> "Status":
         """
         Returns a status bar for a single download
         """
@@ -84,14 +85,14 @@ class StatusMonitor(threading.Thread):
         self.__status.append(status)
         return status
 
-    def remove_status(self, status):
+    def remove_status(self, status: "Status") -> None:
         """
         Remove a status from the monitor, marking it as done
         """
         self.__done.append(status)
         self.__status.remove(status)
 
-    def run(self):
+    def run(self) -> None:
         """
         Main loop for the monitor, printing the status bars every second until stopped
         """
@@ -107,12 +108,12 @@ class StatusMonitor(threading.Thread):
         print("")
 
     @property
-    def __download_speed(self):
+    def __download_speed(self) -> float:
         if len(self.__download_speed_deltas) < 2:
             return 0
         return sum(self.__download_speed_deltas) / len(self.__download_speed_deltas)
 
-    def __track_download_speed(self):
+    def __track_download_speed(self) -> None:
         speed_t0 = self.__total_downloaded
         time.sleep(1)
         speed_t1 = self.__total_downloaded
@@ -120,13 +121,13 @@ class StatusMonitor(threading.Thread):
         if len(self.__download_speed_deltas) > 10:
             self.__download_speed_deltas.pop(0)
 
-    def __print_done_lines(self):
+    def __print_done_lines(self) -> None:
         for status in self.__done:
             print(status.done_line())
 
-    def __clear_progress_lines(self):
+    def __clear_progress_lines(self) -> None:
         if IS_IPYTHON:
-            clear_output(wait=True)
+            clear_output(wait=True)  # type:ignore[reportPossiblyUnboundVariable]
             return
 
         sys.stdout.write("\033[K")
@@ -139,7 +140,7 @@ class StatusMonitor(threading.Thread):
         print("")
         print("")
 
-    def __draw(self):
+    def __draw(self) -> None:
         self.__progress_lines = 1
 
         print(
@@ -149,7 +150,7 @@ class StatusMonitor(threading.Thread):
                     f"{len(self.__status)} files in progress",
                     f"{len(self.__done)} files done",
                     f"{bytes_to_human(self.__total_downloaded)} total downloaded",
-                    f"{bytes_to_human(self.__download_speed)}/s ]]",
+                    f"{bytes_to_human(int(self.__download_speed))}/s ]]",
                 ]
             )
         )
@@ -161,7 +162,7 @@ class StatusMonitor(threading.Thread):
             self.__progress_lines += 2
 
     @property
-    def __total_downloaded(self):
+    def __total_downloaded(self) -> int:
         return sum(status.downloaded for status in self.__status) + sum(
             status.size for status in self.__done
         )
@@ -179,23 +180,23 @@ class NoopMonitor:
     A monitor that does nothing
     """
 
-    def status(self):
+    def status(self) -> "Status":
         """
         Returns a status bar for a single download
         """
         return Status(self)
 
-    def remove_status(self, status):
+    def remove_status(self, status) -> None:
         """
         Remove a status from the monitor
         """
 
-    def start(self):
+    def start(self) -> None:
         """
         Start the monitor
         """
 
-    def stop(self):
+    def stop(self) -> None:
         """
         Stop the monitor
         """
@@ -212,12 +213,12 @@ class Status:
     A status bar for a single download
     """
 
-    __monitor = None
-    filename = None
-    size = 0
-    downloaded = 0
+    __monitor: Union[NoopMonitor, StatusMonitor, None] = None
+    filename: Union[str, None] = None
+    size: int = 0
+    downloaded: int = 0
 
-    def done_line(self):
+    def done_line(self) -> str:
         """
         Returns a line to print when the download is complete
         """
@@ -225,10 +226,16 @@ class Status:
             return f"{self.filename} skipped"
         return f"{self.filename} ({bytes_to_human(self.size)})"
 
-    def status_lines(self):
+    def status_lines(self) -> Tuple[str, str]:
         """
         Returns a tuple of lines to print for the status bar
         """
+        if (
+            not self.__monitor
+            or isinstance(self.__monitor, NoopMonitor)
+            or not self.filename
+        ):
+            return ("", "")
         line_length = self.__monitor.line_length
         if self.downloaded == 0:
             return (
@@ -250,35 +257,36 @@ class Status:
 
         return filename_line, progress_line
 
-    def add_progress(self, chunk_bytes):
+    def add_progress(self, chunk_bytes) -> None:
         """
         Add to the number of bytes downloaded
         """
         self.downloaded += chunk_bytes
 
-    def set_filename(self, filename):
+    def set_filename(self, filename: str) -> None:
         """
         Set the name of the file being downloaded
         """
         self.filename = filename
 
-    def set_filesize(self, size):
+    def set_filesize(self, size: int) -> None:
         """
         Set the size of the file being downloaded
         """
         self.size = size
 
-    def __init__(self, monitor):
+    def __init__(self, monitor) -> None:
         self.__monitor = monitor
 
     def __enter__(self):
         return self
 
-    def __exit__(self, exc_type, exc_val, exc_tb):
-        self.__monitor.remove_status(self)
+    def __exit__(self, exc_type, exc_val, exc_tb) -> None:
+        if self.__monitor:
+            self.__monitor.remove_status(self)
 
 
-def bytes_to_human(num_bytes):
+def bytes_to_human(num_bytes: int) -> str:
     """
     Convert a number of bytes to a human-readable string
     """

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool/query.py

@@ -4,6 +4,7 @@ Query the Copernicus Data Space Ecosystem OpenSearch API
 https://documentation.dataspace.copernicus.eu/APIs/OpenSearch.html
 """
 
+from typing import Any, Dict, Union
 from xml.etree import ElementTree
 from datetime import datetime, date
 import re
@@ -13,11 +14,11 @@ from cdsetool.credentials import Credentials
 
 
 class _FeatureIterator:
-    def __init__(self, feature_query):
+    def __init__(self, feature_query) -> None:
         self.index = 0
         self.feature_query = feature_query
 
-    def __len__(self):
+    def __len__(self) -> int:
         return len(self.feature_query)
 
     def __iter__(self):
@@ -40,9 +41,14 @@ class FeatureQuery:
     Queries the next batch when the current batch is exhausted.
     """
 
-    total_results = None
+    total_results: int = -1
 
-    def __init__(self, collection, search_terms, proxies=None):
+    def __init__(
+        self,
+        collection: str,
+        search_terms: Dict[str, Any],
+        proxies: Union[Dict[str, str], None] = None,
+    ) -> None:
         self.features = []
         self.proxies = proxies
         self.next_url = _query_url(
@@ -52,8 +58,8 @@ class FeatureQuery:
     def __iter__(self):
         return _FeatureIterator(self)
 
-    def __len__(self):
-        if self.total_results is None:
+    def __len__(self) -> int:
+        if self.total_results < 0:
             self.__fetch_features()
 
         return self.total_results
@@ -64,7 +70,7 @@ class FeatureQuery:
 
         return self.features[index]
 
-    def __fetch_features(self):
+    def __fetch_features(self) -> None:
         if self.next_url is None:
             return
         session = Credentials.make_session(
@@ -81,7 +87,7 @@ class FeatureQuery:
 
             self.__set_next_url(res)
 
-    def __set_next_url(self, res):
+    def __set_next_url(self, res) -> None:
         links = res.get("properties", {}).get("links") or []
         self.next_url = next(
             (link for link in links if link.get("rel") == "next"), {}
@@ -91,14 +97,18 @@ class FeatureQuery:
             self.next_url = self.next_url.replace("exactCount=1", "exactCount=0")
 
 
-def query_features(collection, search_terms, proxies=None):
+def query_features(
+    collection: str,
+    search_terms: Dict[str, Any],
+    proxies: Union[Dict[str, str], None] = None,
+) -> FeatureQuery:
     """
     Returns an iterator over the features matching the search terms
     """
     return FeatureQuery(collection, {"maxRecords": 2000, **search_terms}, proxies)
 
 
-def shape_to_wkt(shape):
+def shape_to_wkt(shape: str) -> str:
     """
     Convert a shapefile to a WKT string
     """
@@ -110,12 +120,11 @@ def shape_to_wkt(shape):
     )
 
 
-def geojson_to_wkt(geojson):
+def geojson_to_wkt(geojson_in: Union[str, Dict]) -> str:
     """
     Convert a geojson geometry to a WKT string
     """
-    if isinstance(geojson, str):
-        geojson = json.loads(geojson)
+    geojson = json.loads(geojson_in) if isinstance(geojson_in, str) else geojson_in
 
     if geojson.get("type") == "Feature":
         geojson = geojson["geometry"]
@@ -134,7 +143,9 @@ def geojson_to_wkt(geojson):
     return f"POLYGON({paired_coord})"
 
 
-def describe_collection(collection, proxies=None):
+def describe_collection(
+    collection: str, proxies: Union[Dict[str, str], None] = None
+) -> Dict[str, Any]:
     """
     Get a list of valid options for a given collection in key value pairs
     """
@@ -145,6 +156,8 @@ def describe_collection(collection, proxies=None):
     )
 
     parameters = {}
+    if parameter_node_parent is None:
+        return parameters
     for parameter_node in parameter_node_parent:
         name = parameter_node.attrib.get("name")
         pattern = parameter_node.attrib.get("pattern")
@@ -163,7 +176,11 @@ def describe_collection(collection, proxies=None):
     return parameters
 
 
-def _query_url(collection, search_terms, proxies=None):
+def _query_url(
+    collection: str,
+    search_terms: Dict[str, Any],
+    proxies: Union[Dict[str, str], None] = None,
+) -> str:
     description = describe_collection(collection, proxies=proxies)
 
     query_list = []
@@ -178,7 +195,7 @@ def _query_url(collection, search_terms, proxies=None):
     )
 
 
-def _serialize_search_term(search_term):
+def _serialize_search_term(search_term: Any) -> str:
     if isinstance(search_term, list):
         return ",".join(search_term)
 
@@ -191,14 +208,14 @@ def _serialize_search_term(search_term):
     return str(search_term)
 
 
-def _validate_search_term(key, search_term, description):
+def _validate_search_term(key: str, search_term: str, description) -> None:
     _assert_valid_key(key, description)
     _assert_match_pattern(search_term, description.get(key).get("pattern"))
     _assert_min_inclusive(search_term, description.get(key).get("minInclusive"))
     _assert_max_inclusive(search_term, description.get(key).get("maxInclusive"))
 
 
-def _assert_valid_key(key, description):
+def _assert_valid_key(key: str, description: Dict[str, Any]) -> None:
     assert key in description.keys(), (
         f'search_term with name "{key}" '
         + "was not found for collection."
@@ -206,7 +223,7 @@ def _assert_valid_key(key, description):
     )
 
 
-def _assert_match_pattern(search_term, pattern):
+def _assert_match_pattern(search_term: str, pattern: Union[str, None]) -> None:
     if not pattern:
         return
 
@@ -215,7 +232,7 @@ def _assert_match_pattern(search_term, pattern):
     ), f"search_term {search_term} does not match pattern {pattern}"
 
 
-def _assert_min_inclusive(search_term, min_inclusive):
+def _assert_min_inclusive(search_term: str, min_inclusive: Union[str, None]) -> None:
     if not min_inclusive:
         return
 
@@ -224,7 +241,7 @@ def _assert_min_inclusive(search_term, min_inclusive):
     ), f"search_term {search_term} is less than min_inclusive {min_inclusive}"
 
 
-def _assert_max_inclusive(search_term, max_inclusive):
+def _assert_max_inclusive(search_term: str, max_inclusive: Union[str, None]) -> None:
     if not max_inclusive:
         return
 
@@ -233,12 +250,15 @@ def _assert_max_inclusive(search_term, max_inclusive):
     ), f"search_term {search_term} is greater than max_inclusive {max_inclusive}"
 
 
-_describe_docs = {}
+_describe_docs: Dict[str, bytes] = {}
 
 
-def _get_describe_doc(collection, proxies=None):
-    if _describe_docs.get(collection):
-        return _describe_docs.get(collection)
+def _get_describe_doc(
+    collection: str, proxies: Union[Dict[str, str], None] = None
+) -> bytes:
+    docs = _describe_docs.get(collection)
+    if docs:
+        return docs
     session = Credentials.make_session(None, False, Credentials.RETRIES, proxies)
     with session.get(
         "https://catalogue.dataspace.copernicus.eu"
@@ -252,4 +272,4 @@ def _get_describe_doc(collection, proxies=None):
         )
 
         _describe_docs[collection] = res.content
-    return _describe_docs.get(collection)
+        return res.content

{cdsetool-0.2.10 → cdsetool-0.2.12/src/cdsetool.egg-info}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.1
 Name: cdsetool
-Version: 0.2.10
+Version: 0.2.12
 Summary: Tools & CLI for interacting with CDSE product APIs
 Author-email: Jacob Vejby <javej@sdfi.dk>
-Project-URL: Homepage, https://github.com/SDFIdk/CDSETool
-Project-URL: Bug Tracker, https://github.com/SDFIdk/CDSETool/issues
+Project-URL: Homepage, https://github.com/CDSETool/CDSETool
+Project-URL: Bug Tracker, https://github.com/CDSETool/CDSETool/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
-Requires-Dist: typer<0.13,>=0.9
-Requires-Dist: rich<13.8,>=13.6
-Requires-Dist: requests<2.33.0,>=2.28.1
+Requires-Dist: typer<1,>=0.9
+Requires-Dist: rich<14,>=13.6
+Requires-Dist: requests<3,>=2.28.1
 Requires-Dist: pyjwt[crypto]~=2.8.0
 Requires-Dist: geopandas>=0.13.2
 Provides-Extra: test
 Requires-Dist: black==24.4.2; extra == "test"
-Requires-Dist: pylint==3.2.2; extra == "test"
-Requires-Dist: pytest==8.2.0; extra == "test"
+Requires-Dist: pylint==3.2.6; extra == "test"
+Requires-Dist: pytest==8.3.2; extra == "test"
 Requires-Dist: pytest-cov==5.0.0; extra == "test"
 Requires-Dist: requests-mock==1.12.1; extra == "test"
 Requires-Dist: pytest-mock==3.14.0; extra == "test"
@@ -96,7 +96,7 @@ cdsetool download Sentinel2 PATH/TO/DIR --concurrency 4 --search-term startDate=
 Install `cdsetool` using pip:
 
 ```bash
-pip install cdsetool==0.2.10
+pip install cdsetool==0.2.12
 ```
 
 ## Usage

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool.egg-info/SOURCES.txt

@@ -8,6 +8,7 @@ src/cdsetool/credentials.py
 src/cdsetool/download.py
 src/cdsetool/logger.py
 src/cdsetool/monitor.py
+src/cdsetool/py.typed
 src/cdsetool/query.py
 src/cdsetool.egg-info/PKG-INFO
 src/cdsetool.egg-info/SOURCES.txt

{cdsetool-0.2.10 → cdsetool-0.2.12}/src/cdsetool.egg-info/requires.txt

@@ -1,13 +1,13 @@
-typer<0.13,>=0.9
-rich<13.8,>=13.6
-requests<2.33.0,>=2.28.1
+typer<1,>=0.9
+rich<14,>=13.6
+requests<3,>=2.28.1
 pyjwt[crypto]~=2.8.0
 geopandas>=0.13.2
 
 [test]
 black==24.4.2
-pylint==3.2.2
-pytest==8.2.0
+pylint==3.2.6
+pytest==8.3.2
 pytest-cov==5.0.0
 requests-mock==1.12.1
 pytest-mock==3.14.0