prisma-api 0.3.8__tar.gz → 0.3.10__tar.gz

{prisma_api-0.3.8 → prisma_api-0.3.10}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prisma_api
-Version: 0.3.8
+Version: 0.3.10
 Summary: A package for interacting with PrISMa Platform APIs. PrISMa is a holistic system for numerical synthesis and assessment of Metal-Organic Frameworks and their applications, for Direct Air Capture of CO2. For more information, see: https://prisma.hw.ac.uk.
 Author-email: RCCS-CaptureTeam <team@prisma-platform.org>
 License: GNUv3

{prisma_api-0.3.8 → prisma_api-0.3.10}/prisma_api/__init__.py

@@ -1,4 +1,4 @@
-__version__ = "0.3.8"
+__version__ = "0.3.9"
 
 
 from prisma_api.prisma_api import prisma_api as init        # Main prisma_api class for initialisation

{prisma_api-0.3.8 → prisma_api-0.3.10}/prisma_api/prisma_api_v2.py

@@ -22,6 +22,9 @@ from typing import Any
 from pathlib import Path
 from urllib.parse import urlencode
 import warnings
+import json
+import re
+from datetime import datetime
 
 
 _BASE_PROD = "https://prisma-platform.org/api/v2"
@@ -141,6 +144,76 @@ class PrismaAPIv2:
             "raw": cif_text,
         }
 
+    def _coerce_scalar(self, value: Any) -> Any:
+        """Best-effort conversion of scalar API values to native Python types."""
+        if not isinstance(value, str):
+            return value
+
+        text = value.strip()
+        if text == "":
+            return value
+
+        lowered = text.lower()
+        if lowered == "true":
+            return True
+        if lowered == "false":
+            return False
+
+        # Strict integer parsing first to avoid converting floats like '1.0' to int.
+        if re.fullmatch(r"[+-]?\d+", text):
+            try:
+                return int(text)
+            except ValueError:
+                pass
+
+        # Support decimal/scientific notation.
+        if re.fullmatch(r"[+-]?(?:\d+\.\d*|\.\d+|\d+)(?:[eE][+-]?\d+)?", text):
+            try:
+                return float(text)
+            except ValueError:
+                pass
+
+        # Parse JSON list/dict payloads often returned as strings.
+        if (text.startswith("[") and text.endswith("]")) or (
+            text.startswith("{") and text.endswith("}")
+        ):
+            try:
+                parsed = json.loads(text)
+                if isinstance(parsed, (list, dict)):
+                    return parsed
+            except json.JSONDecodeError:
+                pass
+
+        # Parse ISO-ish datetime strings.
+        if any(sep in text for sep in ("-", "T", ":")):
+            try:
+                return datetime.fromisoformat(text.replace("Z", "+00:00"))
+            except ValueError:
+                pass
+
+        return value
+
+    def _coerce_scope_types(self, payload: Any) -> Any:
+        """Normalize scope endpoint payload values to useful runtime types."""
+        if isinstance(payload, dict):
+            return {k: self._coerce_scalar(v) for k, v in payload.items()}
+
+        if isinstance(payload, list):
+            if payload and all(isinstance(item, dict) for item in payload):
+                return [{k: self._coerce_scalar(v) for k, v in row.items()} for row in payload]
+            return [self._coerce_scalar(v) for v in payload]
+
+        if isinstance(payload, pd.DataFrame):
+            df = payload.copy()
+            for col in df.columns:
+                df[col] = df[col].map(self._coerce_scalar)
+                non_null = df[col].dropna()
+                if len(non_null) > 0 and non_null.map(lambda v: isinstance(v, datetime)).all():
+                    df[col] = pd.to_datetime(df[col], errors="coerce")
+            return df
+
+        return payload
+
     # ── Health ────────────────────────────────────────────────────────────────
 
     def health(self) -> dict:
@@ -275,7 +348,7 @@ class PrismaAPIv2:
         """
         GET /api/v2/list_cifs/
 
-        Dev-only endpoint (not yet available on the production server).
+        List CIF-backed MOF records.
 
         Args:
             tag: Optional tag to filter CIFs by. If omitted, all CIFs are returned.
@@ -283,11 +356,6 @@ class PrismaAPIv2:
         Returns:
             List of MOF names matching ``tag``.
         """
-        if not self._dev:
-            raise RuntimeError(
-                "list_cifs() is only available on the dev server. "
-                "Initialise with dev=True (e.g. prisma_api.init(local_dev=True))."
-            )
         response = self._get("/cifs/", _compact(tag=tag))
         records = response.get("results", response) if isinstance(response, dict) else response
         records = records or []
@@ -300,7 +368,7 @@ class PrismaAPIv2:
         """
         GET /api/v2/cifs/files/
 
-        Dev-only endpoint (not yet available on the production server).
+        Fetch CIF payload(s) for one or more MOF names.
 
         Args:
             mof: One MOF name (str) or list of MOF names.
@@ -319,12 +387,6 @@ class PrismaAPIv2:
             If ``structured=False``: streamed CIF response(s), or saved path(s)
             when ``save_dir`` is provided.
         """
-        if not self._dev:
-            raise RuntimeError(
-                "get_cifs() is only available on the dev server. "
-                "Initialise with dev=True (e.g. prisma_api.init(local_dev=True))."
-            )
-
         if structured and save_dir is not None:
             raise ValueError("save_dir is only supported when structured=False.")
 
@@ -1256,6 +1318,16 @@ class PrismaAPIv2:
         """GET /api/v2/sources/{source_id}/"""
         return self._get(f"/sources/{source_id}/")
 
+    def get_scopes(self, name: str | None = None,
+                   limit: int = 500, offset: int = 0) -> pd.DataFrame:
+        """GET /api/v2/scopes/"""
+        params = _compact(name=name, limit=limit, offset=offset)
+        return self._coerce_scope_types(self._to_df(self._get("/scopes/", params)))
+
+    def get_scope(self, scope_id: int) -> dict:
+        """GET /api/v2/scopes/{scope_id}/"""
+        return self._coerce_scope_types(self._get(f"/scopes/{scope_id}/"))
+
     def get_sinks(self, name: str | None = None,
                   limit: int = 500, offset: int = 0) -> pd.DataFrame:
         """GET /api/v2/sinks/"""

{prisma_api-0.3.8 → prisma_api-0.3.10}/prisma_api.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: prisma_api
-Version: 0.3.8
+Version: 0.3.10
 Summary: A package for interacting with PrISMa Platform APIs. PrISMa is a holistic system for numerical synthesis and assessment of Metal-Organic Frameworks and their applications, for Direct Air Capture of CO2. For more information, see: https://prisma.hw.ac.uk.
 Author-email: RCCS-CaptureTeam <team@prisma-platform.org>
 License: GNUv3

{prisma_api-0.3.8 → prisma_api-0.3.10}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "prisma_api"
-version = "0.3.8"
+version = "0.3.10"
 description = "A package for interacting with PrISMa Platform APIs. PrISMa is a holistic system for numerical synthesis and assessment of Metal-Organic Frameworks and their applications, for Direct Air Capture of CO2. For more information, see: https://prisma.hw.ac.uk."
 authors = [
     {name = "RCCS-CaptureTeam", email = "team@prisma-platform.org"}

{prisma_api-0.3.8 → prisma_api-0.3.10}/tests/test_prisma_api_v2.py

@@ -14,6 +14,9 @@ import os
 import pytest
 import responses as resp_lib
 from responses import matchers
+from datetime import datetime
+
+import pandas as pd
 
 from prisma_api.prisma_api_v2 import PrismaAPIv2, _BASE_PROD
 
@@ -461,6 +464,7 @@ def test_get_region_detail(api):
 
 @pytest.mark.parametrize("method,path,fixture", [
     ("get_sources",    "/sources/",    [{"id": 1, "name": "Coal Plant", "short_name": "CP"}]),
+    ("get_scopes",     "/scopes/",     [{"id": 7, "name": "Point Source"}]),
     ("get_sinks",      "/sinks/",      [{"id": 2, "name": "North Sea"}]),
     ("get_transport_scenarios", "/transport-scenarios/", [{"id": 3, "name": "Pipeline 200km"}]),
     ("get_utilities",  "/utilities/",  [{"id": 4, "name": "Steam"}]),
@@ -476,6 +480,7 @@ def test_catalog_list_endpoints_return_dataframe(api, method, path, fixture):
 
 @pytest.mark.parametrize("method,path,record", [
     ("get_source",             "/sources/1/",            {"id": 1, "name": "Coal Plant"}),
+    ("get_scope",              "/scopes/7/",             {"id": 7, "name": "Point Source"}),
     ("get_sink",               "/sinks/2/",              {"id": 2, "name": "North Sea"}),
     ("get_transport_scenario", "/transport-scenarios/3/",{"id": 3, "name": "Pipeline"}),
     ("get_utility",            "/utilities/4/",          {"id": 4, "name": "Steam"}),
@@ -820,6 +825,7 @@ def test_get_mea_kpi_detail(api):
 
 @pytest.mark.parametrize("method,path,fixture", [
     ("get_sources",    "/sources/",    [{"id": 1, "name": "Coal Plant", "short_name": "CP"}]),
+    ("get_scopes",     "/scopes/",     [{"id": 7, "name": "Point Source"}]),
     ("get_sinks",      "/sinks/",      [{"id": 2, "name": "North Sea"}]),
     ("get_transport_scenarios", "/transport-scenarios/", [{"id": 3, "name": "Pipeline 200km"}]),
     ("get_utilities",  "/utilities/",  [{"id": 4, "name": "Steam"}]),
@@ -835,6 +841,7 @@ def test_catalog_list_endpoints_return_dataframe(api, method, path, fixture):
 
 @pytest.mark.parametrize("method,path,record", [
     ("get_source",             "/sources/1/",            {"id": 1, "name": "Coal Plant"}),
+    ("get_scope",              "/scopes/7/",             {"id": 7, "name": "Point Source"}),
     ("get_sink",               "/sinks/2/",              {"id": 2, "name": "North Sea"}),
     ("get_transport_scenario", "/transport-scenarios/3/",{"id": 3, "name": "Pipeline"}),
     ("get_utility",            "/utilities/4/",          {"id": 4, "name": "Steam"}),
@@ -865,6 +872,76 @@ def test_get_isotherm_returns_dataframe(api):
     assert_df_columns(df, "id", "mof", "molecule", "T_ref_K", "sim_or_exp", "good_structure")
 
 
+# ── Scopes ───────────────────────────────────────────────────────────────────
+
+@resp_lib.activate
+def test_get_scopes_name_filter(api):
+    resp_lib.add(
+        resp_lib.GET,
+        f"{PROD_BASE}/scopes/",
+        match=[matchers.query_param_matcher({"name": "point", "limit": "500", "offset": "0"})],
+        json=_envelope([{"id": 7, "name": "Point Source"}]),
+        status=200,
+    )
+    df = api.get_scopes(name="point")
+    assert df.iloc[0]["name"] == "Point Source"
+
+
+@resp_lib.activate
+def test_get_scopes_coerces_types(api):
+    resp_lib.add(
+        resp_lib.GET,
+        f"{PROD_BASE}/scopes/",
+        json=_envelope([
+            {
+                "id": "7",
+                "name": "Point Source",
+                "active": "true",
+                "capture_efficiency": "0.935",
+                "created_at": "2026-07-01T12:34:56Z",
+                "tags": "[\"pilot\", \"uk\"]",
+            }
+        ]),
+        status=200,
+    )
+
+    df = api.get_scopes()
+    row = df.iloc[0]
+
+    assert isinstance(row["id"], int)
+    assert isinstance(row["name"], str)
+    assert isinstance(row["active"], bool)
+    assert isinstance(row["capture_efficiency"], float)
+    assert pd.api.types.is_datetime64_any_dtype(df["created_at"])
+    assert isinstance(row["tags"], list)
+
+
+@resp_lib.activate
+def test_get_scope_detail_coerces_types(api):
+    resp_lib.add(
+        resp_lib.GET,
+        f"{PROD_BASE}/scopes/7/",
+        json={
+            "id": "7",
+            "name": "Point Source",
+            "active": "false",
+            "capture_efficiency": "1.05",
+            "created_at": "2026-07-01T12:34:56Z",
+            "tags": "[\"a\", \"b\"]",
+        },
+        status=200,
+    )
+
+    scope = api.get_scope(7)
+
+    assert isinstance(scope["id"], int)
+    assert isinstance(scope["name"], str)
+    assert isinstance(scope["active"], bool)
+    assert isinstance(scope["capture_efficiency"], float)
+    assert isinstance(scope["created_at"], datetime)
+    assert isinstance(scope["tags"], list)
+
+
 @resp_lib.activate
 def test_get_isotherm_all_filters_passed(api):
     expected_params = {