feat: update style interface

Author: reindervdw-cmi

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cmi_docx"
-version = "0.2.0"
+version = "0.3.0"
 description = ".docx utilities"
 authors = ["Reinder Vos de Wael <reinder.vosdewael@childmind.org>"]
 license = "LGPL-2.1"

src/cmi_docx/paragraph.py

@@ -5,7 +5,6 @@
 import itertools
 import re
 
-from docx.enum import text
 from docx.text import paragraph as docx_paragraph
 from docx.text import run as docx_run
 
@@ -141,46 +140,31 @@ def insert_run(self, index: int, text: str, style: styles.RunStyle) -> docx_run.
 
     def format(
         self,
-        *,
-        bold: bool | None = None,
-        italics: bool | None = None,
-        font_size: int | None = None,
-        font_rgb: tuple[int, int, int] | None = None,
-        line_spacing: float | None = None,
-        space_before: float | None = None,
-        space_after: float | None = None,
-        alignment: text.WD_PARAGRAPH_ALIGNMENT | None = None,
+        style: styles.ParagraphStyle,
     ) -> None:
         """Formats a paragraph in a Word document.
 
         Args:
-            bold: Whether to bold the paragraph.
-            italics: Whether to italicize the paragraph.
-            font_size: The font size of the paragraph.
-            font_rgb: The font color of the paragraph.
-            line_spacing: The line spacing of the paragraph.
-            space_before: The spacing before the paragraph.
-            space_after: The spacing after the paragraph.
-            alignment: The alignment of the paragraph.
+            style: The style to apply to the paragraph.
         """
-        if line_spacing is not None:
-            self.paragraph.paragraph_format.line_spacing = line_spacing
+        if style.line_spacing is not None:
+            self.paragraph.paragraph_format.line_spacing = style.line_spacing
 
-        if alignment is not None:
-            self.paragraph.alignment = alignment
+        if style.alignment is not None:
+            self.paragraph.alignment = style.alignment
 
-        if space_before is not None:
-            self.paragraph.paragraph_format.space_before = space_before
+        if style.space_before is not None:
+            self.paragraph.paragraph_format.space_before = style.space_before
 
-        if space_after is not None:
-            self.paragraph.paragraph_format.space_after = space_after
+        if style.space_after is not None:
+            self.paragraph.paragraph_format.space_after = style.space_after
 
         for paragraph_run in self.paragraph.runs:
             run.ExtendRun(paragraph_run).format(
                 styles.RunStyle(
-                    bold=bold,
-                    italic=italics,
-                    font_size=font_size,
-                    font_rgb=font_rgb,
+                    bold=style.bold,
+                    italic=style.italic,
+                    font_size=style.font_size,
+                    font_rgb=style.font_rgb,
                 )
             )

src/cmi_docx/styles.py

@@ -36,6 +36,7 @@ class ParagraphStyle:
 class TableStyle:
     """Dataclass for table style arguments."""
 
+    paragraph: ParagraphStyle | None = None
     space_before: float | None = None
     space_after: float | None = None
     background_rgb: tuple[int, int, int] | None = None

src/cmi_docx/table.py

@@ -1,10 +1,9 @@
 """Extends a python-docx Table cell with additional functionality."""
 
 from docx import oxml, table
-from docx.enum import text
 from docx.oxml import ns
 
-from cmi_docx import paragraph
+from cmi_docx import paragraph, styles
 
 
 class ExtendCell:
@@ -18,49 +17,22 @@ def __init__(self, cell: table._Cell) -> None:
         """
         self.cell = cell
 
-    def format(
-        self,
-        *,
-        line_spacing: float | None = None,
-        space_before: float | None = None,
-        space_after: float | None = None,
-        bold: bool | None = None,
-        italics: bool | None = None,
-        font_size: int | None = None,
-        font_rgb: tuple[int, int, int] | None = None,
-        background_rgb: tuple[int, int, int] | None = None,
-        alignment: text.WD_PARAGRAPH_ALIGNMENT | None = None,
-    ) -> None:
+    def format(self, style: styles.TableStyle) -> None:
         """Formats a cell in a Word table.
 
         Args:
-            cell: The cell to format.
-            line_spacing: The line spacing of the cell.
-            space_before: The spacing before the cell.
-            space_after: The spacing after the cell.
-            bold: Whether to bold the cell.
-            italics: Whether to italicize the cell.
-            font_size: The font size of the cell.
-            font_rgb: The font color of the cell.
-            background_rgb: The background color of the cell.
-            alignment: The alignment of the cell.
+            style: The style to apply to the cell.
         """
-        for table_paragraph in self.cell.paragraphs:
-            paragraph.ExtendParagraph(table_paragraph).format(
-                line_spacing=line_spacing,
-                bold=bold,
-                italics=italics,
-                font_size=font_size,
-                font_rgb=font_rgb,
-                alignment=alignment,
-                space_after=space_after,
-                space_before=space_before,
-            )
+        if style.paragraph is not None:
+            for table_paragraph in self.cell.paragraphs:
+                paragraph.ExtendParagraph(table_paragraph).format(style.paragraph)
 
-        if background_rgb is not None:
+        if style.background_rgb is not None:
             shading = oxml.parse_xml(
                 (
-                    r'<w:shd {} w:fill="' + f"{rgb_to_hex(*background_rgb)}" + r'"/>'
+                    r'<w:shd {} w:fill="'
+                    + f"{rgb_to_hex(*style.background_rgb)}"
+                    + r'"/>'
                 ).format(
                     ns.nsdecls("w"),
                 ),