cloudnet-api-client 0.12.3__tar.gz → 0.12.5__tar.gz

{cloudnet_api_client-0.12.3 → cloudnet_api_client-0.12.5}/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.12.5 – 2025-09-03
+
+- Add "mobile" site type
+- Split `Location` to `MeanLocation` and `RawLocation`
+
+## 0.12.4 – 2025-08-26
+
+- Add `software` attribute to `ProductMetadata`
+- Fix hashability of `Product` in `ProductMetadata`
+- Add possible timeliness values
+- Use aware datetimes
+
 ## 0.12.3 – 2025-08-26
 
 - Fix owners type

{cloudnet_api_client-0.12.3 → cloudnet_api_client-0.12.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cloudnet-api-client
-Version: 0.12.3
+Version: 0.12.5
 Summary: Cloudnet API client
 Author-email: Simo Tukiainen <simo.tukiainen@fmi.fi>
 License-File: LICENSE
@@ -195,21 +195,25 @@ Parameters:
 
 Fetch all instruments.
 
+### `APIClient().instrument_ids()` &rarr; `frozenset[str]`
+
+Fetch all instrument identifiers.
+
 ### `APIClient().instrument()` &rarr; `ExtendedInstrument`
 
 Fetch a single instruments.
 
 Parameters:
 
-| name | type  |
-| ---- | ----- |
-| uuid | `str` |
+| name | type                 |
+| ---- | -------------------- |
+| uuid | `str` or `uuid.UUID` |
 
 ### `APIClient().models()` &rarr; `list[Model]`
 
 Fetch all models.
 
-### `APIClient().instrument()` &rarr; `Model`
+### `APIClient().model()` &rarr; `Model`
 
 Fetch a single model.
 

{cloudnet_api_client-0.12.3 → cloudnet_api_client-0.12.5}/README.md

@@ -166,21 +166,25 @@ Parameters:
 
 Fetch all instruments.
 
+### `APIClient().instrument_ids()` → `frozenset[str]`
+
+Fetch all instrument identifiers.
+
 ### `APIClient().instrument()` → `ExtendedInstrument`
 
 Fetch a single instruments.
 
 Parameters:
 
-| name | type  |
-| ---- | ----- |
-| uuid | `str` |
+| name | type                 |
+| ---- | -------------------- |
+| uuid | `str` or `uuid.UUID` |
 
 ### `APIClient().models()` → `list[Model]`
 
 Fetch all models.
 
-### `APIClient().instrument()` → `Model`
+### `APIClient().model()` → `Model`
 
 Fetch a single model.
 

{cloudnet_api_client-0.12.3 → cloudnet_api_client-0.12.5}/cloudnet_api_client/client.py

@@ -22,14 +22,17 @@ from cloudnet_api_client.containers import (
     STATUS,
     ExtendedInstrument,
     ExtendedProduct,
+    ExtendedProductMetadata,
     Instrument,
-    Location,
+    MeanLocation,
     Model,
     Product,
     ProductMetadata,
+    RawLocation,
     RawMetadata,
     RawModelMetadata,
     Site,
+    Software,
     VersionMetadata,
 )
 from cloudnet_api_client.dl import download_files
@@ -60,7 +63,7 @@ class APIClient:
         self,
         type: SITE_TYPE | list[SITE_TYPE] | None = None,
     ) -> list[Site]:
-        type = validate_type(type, SITE_TYPE)
+        type = _validate_type(type, SITE_TYPE)
         res = self._get("sites", {"type": type})
         return _build_objects(res, Site)
 
@@ -71,7 +74,7 @@ class APIClient:
     def products(
         self, type: PRODUCT_TYPE | list[PRODUCT_TYPE] | None = None
     ) -> list[Product]:
-        type = validate_type(type, PRODUCT_TYPE)
+        type = _validate_type(type, PRODUCT_TYPE)
         data = self._get("products")
         if type is not None:
             data = [obj for obj in data if any(t in obj["type"] for t in type)]
@@ -121,14 +124,18 @@ class APIClient:
     def file(
         self,
         uuid: str | UUID,
-    ) -> ProductMetadata:
+    ) -> ExtendedProductMetadata:
         file_res = self._get(f"files/{uuid}")[0]
         if file_res.get("instrument") is not None:
             instrument_uuid = file_res["instrument"]["uuid"]
             instrument_res = self._get(f"instrument-pids/{instrument_uuid}")[0]
         else:
             instrument_res = None
-        return _build_meta_objects([file_res], instrument_res)[0]
+        obj = _build_meta_objects([file_res], instrument_res)[0]
+        return ExtendedProductMetadata(
+            **_asdict_shallow(obj),
+            software=tuple(_build_objects(file_res["software"], Software)),
+        )
 
     def versions(self, uuid: str | UUID) -> list[VersionMetadata]:
         payload = {"properties": ["pid", "dvasId", "legacy", "size", "checksum"]}
@@ -271,12 +278,12 @@ class APIClient:
 
     def moving_site_mean_location(
         self, site_id: str, date: datetime.date | str
-    ) -> Location:
+    ) -> MeanLocation:
         if not isinstance(date, datetime.date):
             date = datetime.date.fromisoformat(date)
         payload = {"date": date}
         res = self._get(f"sites/{site_id}/locations", params=payload)[0]
-        return Location(
+        return MeanLocation(
             time=date,
             latitude=res["latitude"],
             longitude=res["longitude"],
@@ -284,13 +291,13 @@ class APIClient:
 
     def moving_site_locations(
         self, site_id: str, date: datetime.date | str
-    ) -> list[Location]:
+    ) -> list[RawLocation]:
         if not isinstance(date, datetime.date):
             date = datetime.date.fromisoformat(date)
         payload = {"date": date, "raw": "1"}
         locations = self._get(f"sites/{site_id}/locations", params=payload)
         return [
-            Location(
+            RawLocation(
                 time=_parse_datetime(location["date"]),
                 latitude=location["latitude"],
                 longitude=location["longitude"],
@@ -482,7 +489,9 @@ def _parse_datetime_param(
         }
         for fmt, unit in patterns:
             try:
-                start_date = datetime.datetime.strptime(dt, fmt)
+                start_date = datetime.datetime.strptime(dt, fmt).replace(
+                    tzinfo=datetime.timezone.utc
+                )
             except ValueError:
                 continue
             if unit == "years":
@@ -524,17 +533,12 @@ def _build_meta_objects(
     field_names = (
         {f.name for f in fields(ProductMetadata)}
         - CONVERTED
-        - {"product", "instrument", "model", "site"}
+        - {"product", "instrument", "model", "site", "software"}
     )
     return [
         ProductMetadata(
             **{_to_snake(k): v for k, v in obj.items() if _to_snake(k) in field_names},
-            product=Product(
-                id=obj["product"]["id"],
-                human_readable_name=obj["product"]["humanReadableName"],
-                type=obj["product"]["type"],
-                experimental=obj["product"]["experimental"],
-            ),
+            product=_build_object(obj["product"], Product),
             instrument=_create_instrument_object(instrument_meta or obj["instrument"])
             if instrument_meta or "instrument" in obj and obj["instrument"]
             else None,
@@ -664,9 +668,13 @@ def _make_session() -> requests.Session:
 
 def _parse_datetime(dt: str) -> datetime.datetime:
     try:
-        return datetime.datetime.strptime(dt, "%Y-%m-%dT%H:%M:%S.%fZ")
+        return datetime.datetime.strptime(dt, "%Y-%m-%dT%H:%M:%S.%fZ").replace(
+            tzinfo=datetime.timezone.utc
+        )
     except ValueError:
-        return datetime.datetime.strptime(dt, "%Y-%m-%dT%H:%M:%SZ")
+        return datetime.datetime.strptime(dt, "%Y-%m-%dT%H:%M:%SZ").replace(
+            tzinfo=datetime.timezone.utc
+        )
 
 
 def _check_params(params: dict, ignore: tuple = ()) -> None:
@@ -674,7 +682,11 @@ def _check_params(params: dict, ignore: tuple = ()) -> None:
         raise TypeError("At least one of the parameters must be set.")
 
 
-def validate_type(type, values) -> list | None:
+def _asdict_shallow(obj) -> dict:
+    return dict((field.name, getattr(obj, field.name)) for field in fields(obj))
+
+
+def _validate_type(type, values) -> list | None:
     if type is not None:
         if not isinstance(type, str | list):
             raise ValueError(f"Invalid type: {type}")

{cloudnet_api_client-0.12.3 → cloudnet_api_client-0.12.5}/cloudnet_api_client/containers.py

@@ -3,14 +3,22 @@ import uuid
 from dataclasses import dataclass
 from typing import Literal
 
-SITE_TYPE = Literal["cloudnet", "model", "hidden", "campaign"]
+SITE_TYPE = Literal["cloudnet", "model", "hidden", "campaign", "mobile"]
 PRODUCT_TYPE = Literal["instrument", "geophysical", "evaluation", "model"]
 STATUS = Literal["created", "uploaded", "processed", "invalid"]
+TIMELINESS = Literal["rrt", "nrt", "scheduled"]
 
 
 @dataclass(frozen=True, slots=True)
-class Location:
-    time: datetime.datetime | datetime.date
+class MeanLocation:
+    time: datetime.date
+    latitude: float
+    longitude: float
+
+
+@dataclass(frozen=True, slots=True)
+class RawLocation:
+    time: datetime.datetime
     latitude: float
     longitude: float
 
@@ -74,6 +82,14 @@ class Model:
     forecast_end: int | None
 
 
+@dataclass(frozen=True, slots=True)
+class Software:
+    id: str
+    version: str
+    title: str
+    url: str
+
+
 @dataclass(frozen=True, slots=True)
 class Metadata:
     uuid: uuid.UUID
@@ -111,12 +127,17 @@ class ProductMetadata(Metadata):
     dvas_id: str | None
     error_level: str | None
     coverage: float
-    timeliness: str
+    timeliness: TIMELINESS
     format: str
     start_time: datetime.datetime | None
     stop_time: datetime.datetime | None
 
 
+@dataclass(frozen=True, slots=True)
+class ExtendedProductMetadata(ProductMetadata):
+    software: tuple[Software, ...]
+
+
 @dataclass(frozen=True, slots=True)
 class VersionMetadata:
     uuid: uuid.UUID

cloudnet_api_client-0.12.5/cloudnet_api_client/version.py

@@ -0,0 +1 @@
+__version__ = "0.12.5"

{cloudnet_api_client-0.12.3 → cloudnet_api_client-0.12.5}/tests/test_client.py

@@ -13,10 +13,11 @@ from cloudnet_api_client.containers import (
     ExtendedInstrument,
     ExtendedProduct,
     Instrument,
-    Location,
+    MeanLocation,
     Model,
     Product,
     ProductMetadata,
+    RawLocation,
     RawMetadata,
     Site,
     VersionMetadata,
@@ -128,7 +129,7 @@ class TestSites:
 
     def test_moving_site_mean_location(self, client: APIClient):
         location = client.moving_site_mean_location("boaty", "2022-01-01")
-        assert isinstance(location, Location)
+        assert isinstance(location, MeanLocation)
         assert location.time == datetime.date(2022, 1, 1)
         assert round(location.latitude) == 60
         assert round(location.longitude) == 25
@@ -136,12 +137,22 @@ class TestSites:
     def test_moving_site_locations(self, client: APIClient):
         locations = client.moving_site_locations("boaty", "2022-01-01")
         assert isinstance(locations, list)
-        assert all(isinstance(loc, Location) for loc in locations)
+        assert all(isinstance(loc, RawLocation) for loc in locations)
+        assert all(loc.time.date().isoformat() == "2022-01-01" for loc in locations)
 
     def test_invalid_site_id(self, client: APIClient):
         with pytest.raises(CloudnetAPIError):
             client.site("invalid-site-id")
 
+    def test_sites_are_hashable(self, client: APIClient):
+        sites = client.sites()
+        for site in sites:
+            hash(site)
+
+    def test_site_is_hashable(self, client: APIClient):
+        site = client.site("bucharest")
+        hash(site)
+
 
 class TestProducts:
     def test_products_route(self, client: APIClient):
@@ -200,6 +211,15 @@ class TestProducts:
         with pytest.raises(CloudnetAPIError):
             client.product("invalid-product-id")
 
+    def test_products_are_hashable(self, client: APIClient):
+        products = client.products()
+        for product in products:
+            hash(product)
+
+    def test_product_is_hashable(self, client: APIClient):
+        product = client.product("categorize")
+        hash(product)
+
 
 class TestModels:
     def test_models_route(self, client: APIClient):
@@ -216,6 +236,15 @@ class TestModels:
         with pytest.raises(CloudnetAPIError):
             client.model("invalid-model-id")
 
+    def test_models_are_hashable(self, client: APIClient):
+        models = client.models()
+        for model in models:
+            hash(model)
+
+    def test_model_is_hashable(self, client: APIClient):
+        model = client.model("arpege-12-23")
+        hash(model)
+
 
 class TestInstruments:
     def test_instruments_route(self, client: APIClient):
@@ -241,6 +270,15 @@ class TestInstruments:
         with pytest.raises(CloudnetAPIError):
             client.instrument("invalid-instrument-id")
 
+    def test_instruments_are_hashable(self, client: APIClient):
+        instruments = client.instruments()
+        for instrument in instruments:
+            hash(instrument)
+
+    def test_instrument_is_hashable(self, client: APIClient):
+        instrument = client.instrument("12da536f-0d07-41ea-9ced-f6cdeb97198b")
+        hash(instrument)
+
 
 class TestProductFiles:
     def test_file_route_with_geophysical_product(self, client: APIClient):
@@ -295,6 +333,11 @@ class TestProductFiles:
         with pytest.raises(CloudnetAPIError):
             client.files(site_id="invalid-site")
 
+    def test_file_is_hashable(self, client: APIClient):
+        uuid = "8dcc865c-6920-49ce-a627-de045ec896e8"
+        meta = client.file(uuid)
+        hash(meta)
+
 
 class TestRawFiles:
     def test_filter_by_site_and_date(self, client: APIClient):
@@ -356,6 +399,11 @@ class TestRawFiles:
         with pytest.raises(CloudnetAPIError):
             client.raw_files(site_id="invalid-site")
 
+    def test_raw_files_are_hashable(self, client: APIClient):
+        meta = client.raw_files(date_from="2025-08-01", date_to="2025-08-08")
+        for m in meta:
+            hash(m)
+
 
 class TestDateParameterHandling:
     """Test various date parameter formats and edge cases."""

cloudnet_api_client-0.12.3/cloudnet_api_client/version.py

@@ -1 +0,0 @@
-__version__ = "0.12.3"