wordhelpers 0.1.4__tar.gz → 0.1.6__tar.gz

{wordhelpers-0.1.4 → wordhelpers-0.1.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wordhelpers
-Version: 0.1.4
+Version: 0.1.6
 Summary: Helpers for working with python-docx
 Author: AJ Cruz
 Author-email: 15045766-a-cruz@users.noreply.gitlab.com
@@ -65,6 +65,7 @@ The WordTablesModel class has a number of methods available to help you build th
 - ```model_dump()```
 - ```pretty_print()```
 - ```write()```
+- ```sort_rows_by_columns(primary_col: int, secondary_col: int | None = None, *, ascending: bool = True,)```
 
 If you prefer to create the tables manually via Python dictionary, the dictionary must follow a strict schema that looks something like this:
 ```python

{wordhelpers-0.1.4 → wordhelpers-0.1.6}/README.md

@@ -49,6 +49,7 @@ The WordTablesModel class has a number of methods available to help you build th
 - ```model_dump()```
 - ```pretty_print()```
 - ```write()```
+- ```sort_rows_by_columns(primary_col: int, secondary_col: int | None = None, *, ascending: bool = True,)```
 
 If you prefer to create the tables manually via Python dictionary, the dictionary must follow a strict schema that looks something like this:
 ```python

{wordhelpers-0.1.4 → wordhelpers-0.1.6}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "wordhelpers"
-version = "0.1.4"
+version = "0.1.6"
 description = "Helpers for working with python-docx"
 authors = [
     {name = "AJ Cruz",email = "15045766-a-cruz@users.noreply.gitlab.com"}

{wordhelpers-0.1.4 → wordhelpers-0.1.6}/wordhelpers/__init__.py

@@ -97,17 +97,15 @@ def inject_table(
     # Locate the paragraph from the supplied placeholder text
     paragraph: Paragraph = get_para_by_string(doc_obj, placeholder)
     if not paragraph:
-        raise ValueError(
-            f'WARNING: Could not locate placeholder "{placeholder}"'
-        )
+        raise ValueError(f'WARNING: Could not locate placeholder "{placeholder}"')
 
     # Build the word table and add it to the end of the document
     table = (
-        build_table(
-            doc_obj, table, remove_leading_para=remove_leading_para
-        )
+        build_table(doc_obj, table, remove_leading_para=remove_leading_para)
         if isinstance(table, dict)
-        else build_table(doc_obj, table.model_dump(), remove_leading_para=remove_leading_para)
+        else build_table(
+            doc_obj, table.model_dump(), remove_leading_para=remove_leading_para
+        )
     )
 
     # Move the Word table to a new paragraph immediately after the placeholder paragraph

{wordhelpers-0.1.4 → wordhelpers-0.1.6}/wordhelpers/pydantic_models.py

@@ -107,7 +107,7 @@ class WordTableModel(BaseModel):
                 if text:
                     paragraphs = [
                         WordParagraphModel(
-                            style=style, alignment=alignment, text=[text.pop(0)]
+                            style=style, alignment=alignment, text=text.pop(0)
                         )
                     ]
                 cells.append(
@@ -319,3 +319,56 @@ class WordTableModel(BaseModel):
     def write(self, filepath: str) -> None:
         with open(filepath, "w") as f:
             json.dump(self.model_dump(), f, indent=4)
+
+    def _row_text_at(self, row: WordRowModel, col_index: int) -> str:
+        if col_index >= len(row.cells):
+            return ""
+
+        cell = row.cells[col_index]
+
+        if isinstance(cell, str):  # "merge"
+            return ""
+
+        if not cell.paragraphs:
+            return ""
+
+        paragraph = cell.paragraphs[0]
+        text = paragraph.text
+
+        if isinstance(text, list) and text:
+            return text[0].lower()
+
+        if isinstance(text, str):
+            return text.lower()
+
+        return ""
+
+    def sort_rows_by_columns(
+        self,
+        primary_col: int,
+        secondary_col: int | None = None,
+        *,
+        ascending: bool = True,
+    ) -> None:
+        if len(self.rows) <= 1:
+            return
+
+        header = self.rows[0]
+        body = self.rows[1:]
+
+        def sort_key(row: WordRowModel):
+            primary = self._row_text_at(row, primary_col)
+            secondary = (
+                self._row_text_at(row, secondary_col)
+                if secondary_col is not None
+                else ""
+            )
+            return (primary, secondary)
+
+        body_sorted = sorted(
+            body,
+            key=sort_key,
+            reverse=not ascending,
+        )
+
+        self.rows = [header] + body_sorted