pam-python 0.2.18__tar.gz → 0.2.19__tar.gz

{pam_python-0.2.18/pam_python.egg-info → pam_python-0.2.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pam-python
-Version: 0.2.18
+Version: 0.2.19
 Summary: Pam Python Library
 Author-email: Narongrit Kanhanoi <narongrit@pams.ai>
 Project-URL: Homepage, https://github.com/heart/pam-python

{pam_python-0.2.18 → pam_python-0.2.19}/pam/__init__.py

@@ -1,3 +1,3 @@
 """PAM Data Plugin framework."""
 
-__version__ = "0.2.18"
+__version__ = "0.2.19"

{pam_python-0.2.18 → pam_python-0.2.19}/pam/reports/store.py

@@ -6,7 +6,7 @@ import sqlite3
 import threading
 from datetime import datetime, timezone
 from pathlib import Path
-from typing import Any, Iterable, List, Optional, Set
+from typing import Any, Iterable, List, Mapping, Optional, Set
 
 from pam.datetime_utils import format_pam_datetime
 from pam.reports.errors import (
@@ -157,9 +157,12 @@ class ReportStore:
         granularity: str,
         columns: Iterable[Field],
         temporal_mode: Optional[TemporalMode] = None,
+        row_order: Optional[Mapping[str, Iterable[Any]]] = None,
     ) -> TableReport:
         """Declare a typed Table report."""
-        return TableReport.declare(self, key, granularity, columns, temporal_mode)
+        return TableReport.declare(
+            self, key, granularity, columns, temporal_mode, row_order
+        )
 
     def metric(
         self,

{pam_python-0.2.18 → pam_python-0.2.19}/pam/reports/table.py

@@ -1,7 +1,8 @@
 """Typed Table report public API."""
 
-from typing import Any, Dict, Iterable, List, Mapping, Optional, Sequence
+from typing import Any, Dict, Iterable, List, Mapping, Optional, Sequence, Tuple
 
+from pam.reports.axis import normalize_value_order
 from pam.reports.definition import ReportDefinition
 from pam.reports.errors import ReportStoreValidationError
 from pam.reports.fields import Dimension, Field, Measure
@@ -22,6 +23,7 @@ class TableReport:
         report,
         granularity: str,
         columns: Sequence[Field],
+        row_order: Mapping[str, Tuple[Any, ...]],
     ):
         self._report = report
         self.key = report.key
@@ -33,6 +35,7 @@ class TableReport:
         self._measures = tuple(
             column for column in self.columns if isinstance(column, Measure)
         )
+        self.row_order = dict(row_order)
 
     @classmethod
     def declare(
@@ -42,6 +45,7 @@ class TableReport:
         granularity: str,
         columns: Iterable[Field],
         temporal_mode: Optional[TemporalMode] = None,
+        row_order: Optional[Mapping[str, Iterable[Any]]] = None,
     ):
         if isinstance(columns, (str, bytes)):
             raise ReportStoreValidationError("columns must contain field declarations")
@@ -71,12 +75,21 @@ class TableReport:
         normalized_temporal_mode = normalize_temporal_mode(
             temporal_mode, granularity, measures, "Table"
         )
+        normalized_row_order = cls._normalize_row_order(
+            normalized_columns, row_order
+        )
 
         definition = ReportDefinition.create(
             report_type="table",
             contract_version=TABLE_CONTRACT_VERSION,
             fields=normalized_columns,
             binding={"columns": [column.name for column in normalized_columns]},
+            options={
+                "row_order": {
+                    name: list(values)
+                    for name, values in normalized_row_order.items()
+                }
+            } if normalized_row_order else None,
             temporal_mode=normalized_temporal_mode,
         )
         report = store._declare_typed_report(
@@ -86,7 +99,40 @@ class TableReport:
             granularity=granularity,
             definition_json=definition.to_json(),
         )
-        return cls(report, granularity, normalized_columns)
+        return cls(report, granularity, normalized_columns, normalized_row_order)
+
+    @staticmethod
+    def _normalize_row_order(
+        columns: Sequence[Field],
+        row_order: Optional[Mapping[str, Iterable[Any]]],
+    ) -> Dict[str, Tuple[Any, ...]]:
+        if row_order is None:
+            return {}
+        if not isinstance(row_order, Mapping) or not row_order:
+            raise ReportStoreValidationError(
+                "Table row_order must be a non-empty mapping of dimension names to values"
+            )
+        dimensions = {
+            column.name: column
+            for column in columns
+            if isinstance(column, Dimension)
+        }
+        unknown = set(row_order) - set(dimensions)
+        if unknown:
+            raise ReportStoreValidationError(
+                f"Table row_order contains unknown dimension fields: {sorted(unknown)}"
+            )
+        normalized = {}
+        for name, values in row_order.items():
+            order = normalize_value_order(
+                "Table", f"row_order['{name}']", dimensions[name], values
+            )
+            if order is None:
+                raise ReportStoreValidationError(
+                    f"Table row_order['{name}'] must be non-empty"
+                )
+            normalized[name] = order
+        return normalized
 
     def append_rows(
         self,
@@ -241,4 +287,10 @@ class TableReport:
             raise ReportStoreValidationError(
                 f"Report '{self.key}' row {index} must contain a dimension value"
             )
+        for name, values in self.row_order.items():
+            if dimensions.get(name) not in values:
+                raise ReportStoreValidationError(
+                    f"Table row {index} value '{dimensions.get(name)}' is not declared "
+                    f"in row_order['{name}']"
+                )
         return normalized

{pam_python-0.2.18 → pam_python-0.2.19}/pam/templates/init/REPORTS-th.md

@@ -399,6 +399,7 @@ table = store.table(
         Dimension("branch", label="สาขา", value_type="string"),
         Measure("members", label="สมาชิก", value_type="integer", unit="คน"),
     ],
+    row_order={"branch": ["กรุงเทพฯ", "เชียงใหม่", "รวม"]},
 )
 
 table.append_rows(
@@ -413,6 +414,8 @@ table.append_rows(
 - Required column ต้องมีครบและค่าต้องตรงชนิด
 - Row ใน Report เดียวกันห้ามมี generated identity ซ้ำ
 - CMS ใช้ลำดับ column จาก definition ไม่ใช่ row แรก
+- `row_order` กำหนดลำดับค่าของ Dimension ได้ โดยค่าที่เขียนต้องอยู่ในรายการทั้งหมด
+  เช่น วาง `รวม` เป็นตัวสุดท้ายเพื่อให้อยู่ล่างสุดเสมอ
 - Partition เป็น metadata สำหรับ range/order ไม่ถูกเพิ่มเป็น Day/Month column พิเศษ
 - `remove_rows` รับเฉพาะ Dimension identity; Measure ไม่ใช่ identity
 

{pam_python-0.2.18 → pam_python-0.2.19}/pam/templates/init/REPORTS.md

@@ -558,11 +558,17 @@ table = store.table(
             unit="THB",
         ),
     ],
+    row_order={
+        "branch": ["Bangkok", "Chiang Mai", "Total"],
+    },
 )
 ```
 
 Column order is the declaration order. At least one dimension is required. By
-default, all dimension values form the stable row identity.
+default, all dimension values form the stable row identity. Optional `row_order`
+maps Dimension names to their complete display order. Every written value for an
+ordered Dimension must appear in that list; place values such as `Total` last when
+they must remain at the bottom of the table.
 
 ## Writing rows
 

{pam_python-0.2.18 → pam_python-0.2.19/pam_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pam-python
-Version: 0.2.18
+Version: 0.2.19
 Summary: Pam Python Library
 Author-email: Narongrit Kanhanoi <narongrit@pams.ai>
 Project-URL: Homepage, https://github.com/heart/pam-python

{pam_python-0.2.18 → pam_python-0.2.19}/tests/test_typed_table_report.py

@@ -105,6 +105,45 @@ class TypedTableReportTest(unittest.TestCase):
         with self.assertRaises(ReportStoreValidationError):
             table.delete_partition("2026-01")
 
+    def test_explicit_row_order(self):
+        table = self.store.table(
+            key="ordered-table",
+            granularity="NONE",
+            columns=[
+                Dimension("segment", label="Segment", value_type="string"),
+                Measure("customers", label="Customers", value_type="integer"),
+            ],
+            row_order={"segment": ["New", "VIP", "Total"]},
+        )
+        definition = json.loads(
+            self.store._connection.execute(
+                "SELECT definition_json FROM report_definitions WHERE report_key = ?",
+                ("ordered-table",),
+            ).fetchone()[0]
+        )
+        self.assertEqual(
+            {"segment": ["New", "VIP", "Total"]},
+            definition["options"]["row_order"],
+        )
+        table.append_rows([
+            {"segment": "VIP", "customers": 2},
+            {"segment": "Total", "customers": 3},
+        ])
+        with self.assertRaisesRegex(ReportStoreValidationError, "row_order"):
+            table.append_rows([{"segment": "Unknown", "customers": 1}])
+
+    def test_row_order_rejects_unknown_dimension(self):
+        with self.assertRaisesRegex(ReportStoreValidationError, "unknown dimension"):
+            self.store.table(
+                key="invalid-order",
+                granularity="NONE",
+                columns=[
+                    Dimension("segment", label="Segment", value_type="string"),
+                    Measure("customers", label="Customers", value_type="integer"),
+                ],
+                row_order={"customers": [1, 2]},
+            )
+
     def test_public_fixture_generation(self):
         fixture = Path(self.temp_dir.name) / "table.sqlite"
         pointer = generate_table_contract_fixture(fixture)