dafab-client 2.2.4__tar.gz → 2.2.6__tar.gz

{dafab_client-2.2.4 → dafab_client-2.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dafab_client
-Version: 2.2.4
+Version: 2.2.6
 Summary: DaFab helper client built on top of Rucio client modules.
 Author: DaFab
 License-Expression: Apache-2.0

{dafab_client-2.2.4 → dafab_client-2.2.6}/dafab_client/_rucio/overridden_rucio_client.py

@@ -63,10 +63,10 @@ class DevDownloadClient(DownloadClient):
 
 class DevUploadClient(UploadClient):
 
-    def upload_file(self, fpath, pname, scope: str, rse: str):
+    def upload_file(self, fpath, pname, scope: str, rse: str, did_name: str | None = None):
 
         LOG.info(f"Uploading file for dataset_name: `{pname}`")
-        filename = os.path.basename(fpath)
+        filename = did_name or os.path.basename(fpath)
 
         if rse == 'MELUXINA_S3':
             # Prepare the file dictionary for upload

{dafab_client-2.2.4 → dafab_client-2.2.6}/dafab_client/_rucio/rse/translation.py

@@ -197,7 +197,7 @@ class RSEDeterministicTranslation(PolicyPackageAlgorithms):
         del rse
         del rse_attrs
         del protocol_attrs
-        hstr = hashlib.md5(f'demo:{name}'.encode('utf-8')).hexdigest()
+        hstr = hashlib.md5(f'{scope}:{name}'.encode('utf-8')).hexdigest()
         if scope.startswith('user') or scope.startswith('group'):
             scope = scope.replace('.', '/')
         return '%s/%s/%s/%s' % (scope, hstr[0:2], hstr[2:4], name)

{dafab_client-2.2.4 → dafab_client-2.2.6}/dafab_client/example_notebooks/dafab_simple_user_workflows.ipynb

@@ -56,46 +56,89 @@
    "cell_type": "code",
    "metadata": {},
    "source": [
-    "# STAC scope for the DaFab catalog (e.g., \"dafab\" for production, \"demo\" for development).\n",
+    "# STAC scope for the DaFab catalog.\n",
     "STAC_SCOPE = \"dafab\"\n",
     "\n",
-    "# Available collection in DaFab's unified-catalog: sentinel_2_l2a, water_analysis, smart_agriculture\n",
     "COLLECTION_ID = \"water_analysis\"\n",
-    "\n",
-    "# Top facet catalog ID in DaFab's unified-catalog: \"agriculture_season\", \"water_basin\", \"water_anomaly\"\n",
     "TOP_FACET_CATALOG_ID = \"water_basin\"\n",
-    "\n",
-    "# Facet value catalog ID in DaFab's unified-catalog: \"agriculture_season_winter\", \"agriculture_season_spring\", \"agriculture_season_summer\", \"agriculture_season_autumn\", \"water_anomaly_flood\", \"water_anomaly_drought\", \"water_anomaly_normal\", \"water_basin_ganges\".\n",
     "FACET_VALUE_CATALOG_ID = \"water_basin_ganges\"\n",
     "\n",
-    "# Original item ID in DaFab's unified-catalog (e.g., \"S2A_45RYJ_20221205_0_L2A\").\n",
+    "# Source/original and derived pair used by relationship and metadata examples.\n",
     "ORIGINAL_ITEM_ID = \"S2A_45RYJ_20221205_0_L2A\"\n",
+    "DERIVED_ITEM_ID = \"S2A_31TEG_20220226_0_L2A_smart_agriculture_120\"\n",
+    "DERIVED_ASSET_KEY = \"dafab-field-boundaries\"\n",
     "\n",
-    "# Derived item ID in DaFab's unified-catalog (e.g., \"S2A_45RYJ_20221205_0_L2A_water_analysis_100\", \"S2A_45RYJ_20221205_0_L2A_smart_agriculture_100\", ...).\n",
-    "DERIVED_ITEM_ID = \"S2A_31TEG_20220226_0_L2A_smart_agriculture_120\"  # \"S2A_45RYJ_20221205_0_L2A_water_analysis_100\"  # \"S2A_31TEG_20220226_0_L2A_smart_agriculture_120\"\n",
+    "# Staged original Sentinel-2 asset published through Rucio.\n",
+    "STAGED_ORIGINAL_ITEM_ID = \"S2C_MSIL2A_20260218T105111_N0512_R051_T30TYN_20260218T145711\"\n",
+    "STAGED_ORIGINAL_ASSET_KEY = \"B11_20m\"\n",
     "\n",
-    "# Asset key to resolve under `assets` of the selected derived item.\n",
-    "DERIVED_ASSET_KEY = \"dafab-field-boundaries\"\n",
+    "# Ancillary raster examples stored in their own STAC scopes.\n",
+    "HAND_SCOPE = \"hand\"\n",
+    "HAND_ITEM_ID = \"Copernicus_DSM_COG_10_N00_00_E006_00_HAND\"\n",
+    "HAND_ASSET_KEY = \"data\"\n",
+    "\n",
+    "WORLDCOVER_SCOPE = \"worldcover\"\n",
+    "WORLDCOVER_ITEM_ID = \"ESA_WorldCover_10m_2021_v200_N51E003_Map\"\n",
+    "WORLDCOVER_ASSET_KEY = \"Map\"\n",
     "\n",
-    "# Local download directory used by the asset download examples below.\n",
     "ASSET_DOWNLOAD_DIR = \"demo-data/downloads\"\n",
     "\n",
-    "# Start datetime (inclusive) used by Q1/Q3 filter examples.\n",
-    "FILTER_START_DATETIME = \"2020-01-01T00:00:00Z\"\n",
+    "ASSET_EXAMPLES = [\n",
+    "    {\n",
+    "        \"label\": \"original-sentinel-2\",\n",
+    "        \"scope\": STAC_SCOPE,\n",
+    "        \"item_id\": STAGED_ORIGINAL_ITEM_ID,\n",
+    "        \"asset_key\": STAGED_ORIGINAL_ASSET_KEY,\n",
+    "        \"downloadable\": True,\n",
+    "    },\n",
+    "    {\n",
+    "        \"label\": \"derived-dafab\",\n",
+    "        \"scope\": STAC_SCOPE,\n",
+    "        \"item_id\": DERIVED_ITEM_ID,\n",
+    "        \"asset_key\": DERIVED_ASSET_KEY,\n",
+    "        \"downloadable\": False,\n",
+    "    },\n",
+    "    {\n",
+    "        \"label\": \"hand\",\n",
+    "        \"scope\": HAND_SCOPE,\n",
+    "        \"item_id\": HAND_ITEM_ID,\n",
+    "        \"asset_key\": HAND_ASSET_KEY,\n",
+    "        \"downloadable\": True,\n",
+    "    },\n",
+    "    {\n",
+    "        \"label\": \"worldcover\",\n",
+    "        \"scope\": WORLDCOVER_SCOPE,\n",
+    "        \"item_id\": WORLDCOVER_ITEM_ID,\n",
+    "        \"asset_key\": WORLDCOVER_ASSET_KEY,\n",
+    "        \"downloadable\": True,\n",
+    "    },\n",
+    "]\n",
     "\n",
-    "# End datetime (inclusive) used by Q1/Q3 filter examples.\n",
-    "FILTER_END_DATETIME = \"2020-12-31T23:59:59Z\"\n",
+    "DOWNLOADABLE_ASSET_EXAMPLES = [example for example in ASSET_EXAMPLES if example[\"downloadable\"]]\n",
     "\n",
-    "# Bounding box [min_long, min_lat, max_long, max_lat] used by Q2/Q3 filter examples.\n",
+    "FILTER_START_DATETIME = \"2020-01-01T00:00:00Z\"\n",
+    "FILTER_END_DATETIME = \"2020-12-31T23:59:59Z\"\n",
     "FILTER_BBOX = [-0.6, 19.7, 96.6, 54.2]\n",
-    "\n",
-    "# Minimum number of fields used by the Q4 nested metadata filter example.\n",
-    "SMART_AGRICULTURE_MIN_FIELDS = 100000"
+    "SMART_AGRICULTURE_MIN_FIELDS = 100000\n"
    ],
    "id": "c90eef0876e76811",
    "outputs": [],
    "execution_count": null
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "### 1.1 Asset Example Classes\n",
+    "| Example | Scope | Item | Asset key | Best use |\n",
+    "|---|---|---|---|---|\n",
+    "| Original Sentinel-2 | `dafab` | `STAGED_ORIGINAL_ITEM_ID` | `STAGED_ORIGINAL_ASSET_KEY` | Original DASI product assets published through Rucio. |\n",
+    "| Derived DaFab | `dafab` | `DERIVED_ITEM_ID` | `DERIVED_ASSET_KEY` | Derived item relationships and metadata. |\n",
+    "| HAND | `hand` | `HAND_ITEM_ID` | `HAND_ASSET_KEY` | Terrain ancillary raster. |\n",
+    "| WorldCover | `worldcover` | `WORLDCOVER_ITEM_ID` | `WORLDCOVER_ASSET_KEY` | Land-cover ancillary raster. |\n"
+   ],
+   "id": "asset-example-classes"
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -699,9 +742,9 @@
    "metadata": {},
    "source": [
     "print(dc.extract_metadata_value(\n",
-    "    value_path=\"/assets/dafab-field-boundaries/href\",\n",
+    "    value_path=f\"/assets/{DERIVED_ASSET_KEY}/href\",\n",
     "    pname=DERIVED_ITEM_ID,\n",
-    "))"
+    "))\n"
    ],
    "id": "393130cb6c97ad38",
    "outputs": [],
@@ -724,14 +767,14 @@
     "    \"/id\",\n",
     "    \"/collection\",\n",
     "    \"/properties/datetime\",\n",
-    "    \"/assets/dafab-field-boundaries/href\",\n",
+    "    f\"/assets/{DERIVED_ASSET_KEY}/href\",\n",
     "]\n",
     "derived_item_partial_subset = dc.get_bulk_metadata(\n",
     "    DERIVED_ITEM_ID,\n",
     "    scope=STAC_SCOPE,\n",
     "    paths=PARTIAL_METADATA_PATHS,\n",
     ")\n",
-    "print(dc.as_json(derived_item_partial_subset))"
+    "print(dc.as_json(derived_item_partial_subset))\n"
    ],
    "id": "1849a6c900bcd821",
    "outputs": [],
@@ -823,9 +866,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## 25. Download Asset Using Stable Link\n",
-    "- URL-first mode: use a known stable DaFab asset URL and download directly from it.\n",
-    "- Best when the caller already has the stable link (for example from search results, copied links, or external clients).\n"
+    "## 25. Download Original Asset Using Stable Link\n",
+    "URL-first mode: build the stable resolver URL for a staged original asset, then download directly from it.\n"
    ],
    "id": "1ed656e29fa0f2f4"
   },
@@ -833,10 +875,10 @@
    "cell_type": "code",
    "metadata": {},
    "source": [
-    "# Get automatically the download href based on a derived id and its asset destination (e.g. https://dafab.cern.ch/stac/assets/dafab/items/S2A_30TYN_20200311_1_L2A_smart_agriculture_120/dafab-field-boundaries)\n",
     "stable_asset_href = dc.build_stable_asset_href(\n",
-    "    item_id=DERIVED_ITEM_ID,\n",
-    "    asset_key=DERIVED_ASSET_KEY,\n",
+    "    item_id=STAGED_ORIGINAL_ITEM_ID,\n",
+    "    asset_key=STAGED_ORIGINAL_ASSET_KEY,\n",
+    "    scope=STAC_SCOPE,\n",
     ")\n",
     "\n",
     "stable_asset_download = dc.download_asset_from_stable_href(\n",
@@ -844,7 +886,7 @@
     "    destination_dir=ASSET_DOWNLOAD_DIR,\n",
     "    overwrite=True,\n",
     ")\n",
-    "print(dc.as_json(stable_asset_download))"
+    "print(dc.as_json(stable_asset_download))\n"
    ],
    "id": "28500ca4defac451",
    "outputs": [],
@@ -854,9 +896,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## 26. Download Asset By Item And Asset Key\n",
-    "- Metadata-first mode: provide item id + asset key, resolve `assets.<asset_key>` from metadata, then download.\n",
-    "- Best when the caller does not already have the stable URL and wants lookup + download in one helper call.\n"
+    "## 26. Download Original Asset By Item And Asset Key\n",
+    "Metadata-first mode: provide item id + asset key, resolve the asset entry, then download.\n"
    ],
    "id": "ba01c4c5f0c41828"
   },
@@ -865,12 +906,13 @@
    "metadata": {},
    "source": [
     "item_asset_download = dc.download_item_asset(\n",
-    "    item_id=DERIVED_ITEM_ID,\n",
-    "    asset_key=DERIVED_ASSET_KEY,\n",
+    "    item_id=STAGED_ORIGINAL_ITEM_ID,\n",
+    "    asset_key=STAGED_ORIGINAL_ASSET_KEY,\n",
+    "    scope=STAC_SCOPE,\n",
     "    destination_dir=ASSET_DOWNLOAD_DIR,\n",
     "    overwrite=True,\n",
     ")\n",
-    "print(dc.as_json(item_asset_download))"
+    "print(dc.as_json(item_asset_download))\n"
    ],
    "id": "c93935596c2f03b6",
    "outputs": [],
@@ -880,8 +922,8 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## 27. Download All Assets Of a Derived Item\n",
-    "Download all assets for a derived item in one call. The helper guards against original-item IDs and returns a per-asset status summary.\n"
+    "## 27. Inspect Downloadable Asset Entries By Example Class\n",
+    "This reports the selected asset entry for each downloadable reference class without downloading file content.\n"
    ],
    "id": "ebde8e85d32eae9d"
   },
@@ -889,13 +931,25 @@
    "cell_type": "code",
    "metadata": {},
    "source": [
-    "all_derived_assets_download = dc.download_all_derived_item_assets(\n",
-    "    item_id=DERIVED_ITEM_ID,\n",
-    "    scope=STAC_SCOPE,\n",
-    "    destination_dir=ASSET_DOWNLOAD_DIR,\n",
-    "    overwrite=True,\n",
-    ")\n",
-    "print(dc.as_json(all_derived_assets_download))"
+    "asset_entry_reports = {}\n",
+    "for example in DOWNLOADABLE_ASSET_EXAMPLES:\n",
+    "    report = dc.list_item_asset_entries(\n",
+    "        example[\"item_id\"],\n",
+    "        stac_namespace=example[\"scope\"],\n",
+    "        check_storage=True,\n",
+    "    )\n",
+    "    selected = next(\n",
+    "        (row for row in report.get(\"asset_entries\", []) if row.get(\"asset_key\") == example[\"asset_key\"]),\n",
+    "        None,\n",
+    "    )\n",
+    "    asset_entry_reports[example[\"label\"]] = {\n",
+    "        \"scope\": example[\"scope\"],\n",
+    "        \"item_id\": example[\"item_id\"],\n",
+    "        \"selected_asset\": selected,\n",
+    "        \"metadata_asset_count\": report.get(\"metadata_asset_count\"),\n",
+    "        \"attached_asset_count\": report.get(\"attached_asset_count\"),\n",
+    "    }\n",
+    "print(dc.as_json(asset_entry_reports))\n"
    ],
    "id": "6756ebe6999c1925",
    "outputs": [],

dafab_client-2.2.6/dafab_client/example_notebooks/dafab_simple_user_workflows.py

@@ -0,0 +1,322 @@
+import dafab_client as dc
+
+# STAC scope for the DaFab catalog.
+STAC_SCOPE = "dafab"
+
+COLLECTION_ID = "water_analysis"
+TOP_FACET_CATALOG_ID = "water_basin"
+FACET_VALUE_CATALOG_ID = "water_basin_ganges"
+
+# Source/original and derived pair used by relationship and metadata examples.
+ORIGINAL_ITEM_ID = "S2A_45RYJ_20221205_0_L2A"
+DERIVED_ITEM_ID = "S2A_31TEG_20220226_0_L2A_smart_agriculture_120"
+DERIVED_ASSET_KEY = "dafab-field-boundaries"
+
+# Staged original Sentinel-2 asset published through Rucio.
+STAGED_ORIGINAL_ITEM_ID = "S2C_MSIL2A_20260218T105111_N0512_R051_T30TYN_20260218T145711"
+STAGED_ORIGINAL_ASSET_KEY = "B11_20m"
+
+# Ancillary raster examples stored in their own STAC scopes.
+HAND_SCOPE = "hand"
+HAND_ITEM_ID = "Copernicus_DSM_COG_10_N00_00_E006_00_HAND"
+HAND_ASSET_KEY = "data"
+
+WORLDCOVER_SCOPE = "worldcover"
+WORLDCOVER_ITEM_ID = "ESA_WorldCover_10m_2021_v200_N51E003_Map"
+WORLDCOVER_ASSET_KEY = "Map"
+
+ASSET_DOWNLOAD_DIR = "demo-data/downloads"
+
+ASSET_EXAMPLES = [
+    {
+        "label": "original-sentinel-2",
+        "scope": STAC_SCOPE,
+        "item_id": STAGED_ORIGINAL_ITEM_ID,
+        "asset_key": STAGED_ORIGINAL_ASSET_KEY,
+        "downloadable": True,
+    },
+    {
+        "label": "derived-dafab",
+        "scope": STAC_SCOPE,
+        "item_id": DERIVED_ITEM_ID,
+        "asset_key": DERIVED_ASSET_KEY,
+        "downloadable": False,
+    },
+    {
+        "label": "hand",
+        "scope": HAND_SCOPE,
+        "item_id": HAND_ITEM_ID,
+        "asset_key": HAND_ASSET_KEY,
+        "downloadable": True,
+    },
+    {
+        "label": "worldcover",
+        "scope": WORLDCOVER_SCOPE,
+        "item_id": WORLDCOVER_ITEM_ID,
+        "asset_key": WORLDCOVER_ASSET_KEY,
+        "downloadable": True,
+    },
+]
+
+DOWNLOADABLE_ASSET_EXAMPLES = [example for example in ASSET_EXAMPLES if example["downloadable"]]
+
+FILTER_START_DATETIME = "2020-01-01T00:00:00Z"
+FILTER_END_DATETIME = "2020-12-31T23:59:59Z"
+FILTER_BBOX = [-0.6, 19.7, 96.6, 54.2]
+SMART_AGRICULTURE_MIN_FIELDS = 100000
+
+dc.ping()
+
+dc.whoami()
+
+dc.list_stac_scopes()
+
+dc.list_catalogs_and_collections()
+# If you need structured records for downstream processing, use dc.get_catalogs_and_collections() instead.
+print(f"Structured rows available via dc.get_catalogs_and_collections(): {len(dc.get_catalogs_and_collections())}")
+
+# Enhanced filter payload for STAC records whose metadata type is "Collection".
+COLLECTION_TYPE_FILTER = {
+    "filter": {
+        "type": "comparison",
+        "comparator": "equals",
+        "path": ["type"],
+        "value": "Collection",
+        "valueType": "string",
+    }
+}
+
+collection_type_item_ids = dc.get_items_by_enhanced_filter(COLLECTION_TYPE_FILTER, return_mode="ids")
+print(collection_type_item_ids)
+
+# Enhanced filter payload for STAC records whose metadata type is "Catalog".
+CATALOG_TYPE_FILTER = {
+    "filter": {
+        "type": "comparison",
+        "comparator": "equals",
+        "path": ["type"],
+        "value": "Catalog",
+        "valueType": "string",
+    }
+}
+
+catalog_type_item_ids = dc.get_items_by_enhanced_filter(CATALOG_TYPE_FILTER, return_mode="ids")
+print(catalog_type_item_ids)
+
+item_rows = dc.get_items()
+print([item["name"] for item in item_rows])
+print(f"Structured rows available via dc.get_items(): {len(item_rows)}")
+
+collection_item_ids = dc.get_item_ids_by_collection_field(COLLECTION_ID)
+print(f"Collection: {COLLECTION_ID}")
+print(collection_item_ids)
+
+top_facet_item_ids = dc.get_item_ids_by_top_facet_catalog(TOP_FACET_CATALOG_ID)
+
+print(f"Top facet catalog: {TOP_FACET_CATALOG_ID}")
+print(top_facet_item_ids)
+
+facet_value_item_ids = dc.get_item_ids_by_facet_value_catalog(FACET_VALUE_CATALOG_ID)
+
+print(f"Facet value catalog: {FACET_VALUE_CATALOG_ID}")
+print(facet_value_item_ids)
+
+related_item_ids = dc.get_related_item_ids_from_original_item(ORIGINAL_ITEM_ID)
+
+print(f"Original item: {ORIGINAL_ITEM_ID}")
+print(related_item_ids)
+
+source_original_item_ids = dc.get_source_original_item_ids_from_derived_item(DERIVED_ITEM_ID)
+
+print(f"Derived item: {DERIVED_ITEM_ID}")
+print(source_original_item_ids)
+
+sibling_ids = dc.get_sibling_derived_item_ids(
+    ORIGINAL_ITEM_ID,
+    collection_id=COLLECTION_ID,
+)
+
+print(f"Original item: {ORIGINAL_ITEM_ID} | Sibling filter collection: {COLLECTION_ID}")
+print(sibling_ids)
+
+q1_item_ids = dc.get_items_by_timerange(
+    FILTER_START_DATETIME,
+    FILTER_END_DATETIME,
+    return_mode="ids",
+)
+print(q1_item_ids[:20])
+print(f"Total matches: {len(q1_item_ids)}")
+
+q2_item_ids = dc.get_items_by_bbox(
+    FILTER_BBOX[0],
+    FILTER_BBOX[1],
+    FILTER_BBOX[2],
+    FILTER_BBOX[3],
+    return_mode="ids",
+)
+print(q2_item_ids[:20])
+print(f"Total matches: {len(q2_item_ids)}")
+
+q3_item_ids = dc.get_items_by_bbox_and_timerange(
+    FILTER_BBOX,
+    [FILTER_START_DATETIME, FILTER_END_DATETIME],
+    return_mode="ids",
+)
+print(q3_item_ids[:20])
+print(f"Total matches: {len(q3_item_ids)}")
+
+Q4_COMPLEX_FILTER = {
+    "filter": {
+        "type": "logical",
+        "combinator": "and",
+        "filters": [
+            {
+                "type": "comparison",
+                "comparator": "equals",
+                "path": ["type"],
+                "value": "Feature",
+                "valueType": "string",
+            },
+            {
+                "type": "comparison",
+                "comparator": "equals",
+                "path": ["collection"],
+                "value": "smart_agriculture",
+                "valueType": "string",
+            },
+            {
+                "type": "comparison",
+                "comparator": "greaterThan",
+                "path": ["properties", "dafab:smart-agriculture", "number_of_fields"],
+                "value": SMART_AGRICULTURE_MIN_FIELDS,
+                "valueType": "number",
+            },
+        ],
+    }
+}
+
+q4_item_ids = dc.get_items_by_enhanced_filter(
+    Q4_COMPLEX_FILTER,
+    return_mode="ids",
+)
+print(q4_item_ids[:20])
+print(f"Total matches: {len(q4_item_ids)}")
+
+q4_item_ids_mode = dc.get_items_by_enhanced_filter(
+    Q4_COMPLEX_FILTER,
+    return_mode="ids",
+)
+q4_item_metadata_mode = dc.get_items_by_enhanced_filter(
+    Q4_COMPLEX_FILTER,
+    return_mode="metadata",
+)
+
+sample_asset_hrefs = [
+    item.get("assets", {}).get("dafab-field-boundaries", {}).get("href")
+    for item in q4_item_metadata_mode[:5]
+]
+
+print(f"IDs mode count: {len(q4_item_ids_mode)}")
+print(f"Metadata mode count: {len(q4_item_metadata_mode)}")
+print(f"First IDs: {q4_item_ids_mode[:5]}")
+print(f"First metadata asset hrefs (dafab-field-boundaries): {sample_asset_hrefs}")
+
+q3_item_metadata = dc.get_items_by_bbox_and_timerange(
+    FILTER_BBOX,
+    [FILTER_START_DATETIME, FILTER_END_DATETIME],
+    return_mode="metadata",
+)
+print(f"Rendering {len(q3_item_metadata)} items to demo-data/filters/bbox_map.html")
+dc.get_map(q3_item_metadata, draw_ids=False)
+
+# STAC root catalog ID used as the top-level entrypoint for discovery.
+ROOT_CATALOG_ID = "stac"
+print(dc.extract_metadata_value(value_path="", pname=ROOT_CATALOG_ID))
+
+# STAC collection ID in the DaFab catalog (e.g., "sentinel_2_l2a", "water_analysis", "smart_agriculture", ... )
+STAC_COLLECTION_ID = "water_analysis"
+print(dc.extract_metadata_value(value_path="", pname=STAC_COLLECTION_ID))
+
+print(dc.extract_metadata_value(value_path="", pname=TOP_FACET_CATALOG_ID))
+
+print(dc.extract_metadata_value(value_path="", pname=FACET_VALUE_CATALOG_ID))
+
+print(dc.extract_metadata_value(value_path="", pname=ORIGINAL_ITEM_ID))
+
+print(dc.extract_metadata_value(value_path="", pname=DERIVED_ITEM_ID))
+
+print(dc.extract_metadata_value(
+    value_path=f"/assets/{DERIVED_ASSET_KEY}/href",
+    pname=DERIVED_ITEM_ID,
+))
+
+PARTIAL_METADATA_PATHS = [
+    "/id",
+    "/collection",
+    "/properties/datetime",
+    f"/assets/{DERIVED_ASSET_KEY}/href",
+]
+derived_item_partial_subset = dc.get_bulk_metadata(
+    DERIVED_ITEM_ID,
+    scope=STAC_SCOPE,
+    paths=PARTIAL_METADATA_PATHS,
+)
+print(dc.as_json(derived_item_partial_subset))
+
+dc.list_storages()
+
+print(dc.as_json(dc.check_storage(rse_name="MELUXINA_S3")))
+
+derived_item_asset_availability = dc.list_item_asset_entries(
+    DERIVED_ITEM_ID,
+    check_storage=True,
+)
+print(dc.as_json(derived_item_asset_availability))
+
+derived_item_asset_entries = dc.list_item_asset_entries(
+    DERIVED_ITEM_ID,
+    check_storage=False,
+)
+print(dc.as_json(derived_item_asset_entries))
+
+stable_asset_href = dc.build_stable_asset_href(
+    item_id=STAGED_ORIGINAL_ITEM_ID,
+    asset_key=STAGED_ORIGINAL_ASSET_KEY,
+    scope=STAC_SCOPE,
+)
+
+stable_asset_download = dc.download_asset_from_stable_href(
+    stable_href=stable_asset_href,
+    destination_dir=ASSET_DOWNLOAD_DIR,
+    overwrite=True,
+)
+print(dc.as_json(stable_asset_download))
+
+item_asset_download = dc.download_item_asset(
+    item_id=STAGED_ORIGINAL_ITEM_ID,
+    asset_key=STAGED_ORIGINAL_ASSET_KEY,
+    scope=STAC_SCOPE,
+    destination_dir=ASSET_DOWNLOAD_DIR,
+    overwrite=True,
+)
+print(dc.as_json(item_asset_download))
+
+asset_entry_reports = {}
+for example in DOWNLOADABLE_ASSET_EXAMPLES:
+    report = dc.list_item_asset_entries(
+        example["item_id"],
+        stac_namespace=example["scope"],
+        check_storage=True,
+    )
+    selected = next(
+        (row for row in report.get("asset_entries", []) if row.get("asset_key") == example["asset_key"]),
+        None,
+    )
+    asset_entry_reports[example["label"]] = {
+        "scope": example["scope"],
+        "item_id": example["item_id"],
+        "selected_asset": selected,
+        "metadata_asset_count": report.get("metadata_asset_count"),
+        "attached_asset_count": report.get("attached_asset_count"),
+    }
+print(dc.as_json(asset_entry_reports))

dafab_client-2.2.6/dafab_client/helpers/file_management/Insertion/upload_file_of_scope_name.py

@@ -0,0 +1,72 @@
+import time
+import traceback
+
+from dafab_client._rucio.dafab_lib import upload_manager
+from dafab_client._rucio.global_utils import setup_logger
+
+LOG = setup_logger(__name__)
+
+
+def upload_file(
+        fpath: str,
+        pname: str,
+        scope: str = 'dafab',
+        rse: str = 'MELUXINA_S3',
+        did_name: str | None = None,
+):
+    """
+    Upload a file to an RSE and register it in Rucio.
+
+    Parameters
+    ----------
+    fpath : str
+        Local filesystem path of the file to upload.
+    pname : str
+        Dataset DID name to attach the file to.
+    scope : str, optional
+        Rucio scope under which the file will be registered, by default ``'dafab'``.
+    rse : str, optional
+        Name of the Rucio Storage Element where the file will be uploaded, by default ``'MELUXINA_S3'``.
+    did_name : str, optional
+        FILE DID name to register. Defaults to the local file basename.
+
+    Notes
+    -----
+    The function retries failed uploads ``max_retries`` times with a pause of
+    ``retry_delay`` seconds between attempts.
+
+    Returns
+    -------
+    bool
+        ``True`` if the upload and registration succeed, ``False`` after all retries are exhausted.
+    """
+    max_retries = 1
+    retry_delay = 30  # seconds
+
+    for attempt in range(max_retries):
+        try:
+            # Get an uploader connection
+            uploader = upload_manager()
+
+            add_success = uploader.upload_file(fpath, pname, scope, rse, did_name=did_name)
+            if add_success:
+                LOG.result(f"The file '{fpath}' is now available on Rucio storage and indexed in catalog.\n")
+                return True
+            else:
+                LOG.warning(f"The upload of file '{fpath}' on Rucio storage did not finish normally.\n")
+                return False
+
+        except Exception as e:
+            LOG.warning(f"Attempt {attempt + 1}/{max_retries}: An unexpected error "
+                        f"of type '{type(e).__name__}' occurred "
+                        f"while uploading the file '{fpath}' on Rucio storage: {e}\n")
+
+            # Get the full traceback for debugging:
+            traceback.print_exc()
+
+            if attempt < max_retries - 1:  # Don't sleep after the last attempt
+                LOG.warning(f"Retrying in {retry_delay} seconds...")
+                time.sleep(retry_delay)
+
+    LOG.warning("All retry attempts exhausted.")
+    return False