Validate query params with record_id, normalize datetime/np.datetime64, use context manager in example

Author: Saurabh Badenkal

examples/advanced/dataframe_operations.py

@@ -30,8 +30,12 @@ def main():
 
     print("[INFO] Authenticating via browser...")
     credential = InteractiveBrowserCredential()
-    client = DataverseClient(base_url, credential)
 
+    with DataverseClient(base_url, credential) as client:
+        _run_walkthrough(client)
+
+
+def _run_walkthrough(client):
     table = input("Enter table schema name to use [default: account]: ").strip() or "account"
     print(f"[INFO] Using table: {table}")
 

src/PowerPlatform/Dataverse/operations/dataframe.py

@@ -110,6 +110,11 @@ def get(
                 df = client.dataframe.get("account", select=["name"], top=100)
         """
         if record_id is not None:
+            if any(p is not None for p in (filter, orderby, top, expand, page_size)):
+                raise ValueError(
+                    "Cannot specify query parameters (filter, orderby, top, "
+                    "expand, page_size) when fetching a single record by ID"
+                )
             result = self._client.records.get(
                 table,
                 record_id,

src/PowerPlatform/Dataverse/utils/_pandas.py

@@ -5,6 +5,7 @@
 
 from __future__ import annotations
 
+import datetime
 from typing import Any, Dict, List
 
 import numpy as np
@@ -19,6 +20,10 @@ def _normalize_scalar(v: Any) -> Any:
     """
     if isinstance(v, pd.Timestamp):
         return v.isoformat()
+    if isinstance(v, (datetime.datetime, datetime.date)):
+        return v.isoformat()
+    if isinstance(v, np.datetime64):
+        return pd.Timestamp(v).isoformat()
     if isinstance(v, np.integer):
         return int(v)
     if isinstance(v, np.floating):

tests/unit/test_dataframe_operations.py

@@ -175,6 +175,18 @@ def test_get_passes_all_params(self):
             page_size=25,
         )
 
+    def test_get_record_id_with_query_params_raises(self):
+        """ValueError raised when record_id is provided with query params."""
+        with self.assertRaises(ValueError) as ctx:
+            self.client.dataframe.get("account", record_id="guid-1", filter="name eq 'X'")
+        self.assertIn("Cannot specify query parameters", str(ctx.exception))
+
+    def test_get_record_id_with_top_raises(self):
+        """ValueError raised when record_id is provided with top."""
+        with self.assertRaises(ValueError) as ctx:
+            self.client.dataframe.get("account", record_id="guid-1", top=10)
+        self.assertIn("Cannot specify query parameters", str(ctx.exception))
+
 
 class TestDataFrameCreate(unittest.TestCase):
     """Tests for client.dataframe.create()."""

tests/unit/test_pandas_helpers.py

@@ -85,6 +85,31 @@ def test_numpy_float32(self):
         self.assertIsInstance(result, float)
         self.assertAlmostEqual(result, 2.5, places=5)
 
+    def test_python_datetime(self):
+        """datetime.datetime is converted to ISO 8601 string."""
+        import datetime
+
+        dt = datetime.datetime(2024, 6, 15, 10, 30, 0)
+        result = _normalize_scalar(dt)
+        self.assertIsInstance(result, str)
+        self.assertEqual(result, "2024-06-15T10:30:00")
+
+    def test_python_date(self):
+        """datetime.date is converted to ISO 8601 string."""
+        import datetime
+
+        d = datetime.date(2024, 6, 15)
+        result = _normalize_scalar(d)
+        self.assertIsInstance(result, str)
+        self.assertEqual(result, "2024-06-15")
+
+    def test_numpy_datetime64(self):
+        """np.datetime64 is converted to ISO 8601 string."""
+        dt = np.datetime64("2024-06-15T10:30:00")
+        result = _normalize_scalar(dt)
+        self.assertIsInstance(result, str)
+        self.assertIn("2024-06-15T10:30:00", result)
+
 
 class TestDataframeToRecords(unittest.TestCase):
     """Unit tests for dataframe_to_records()."""