table-renderer 0.2.0__tar.gz → 0.4.0__tar.gz

{table_renderer-0.2.0 → table_renderer-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: table-renderer
-Version: 0.2.0
+Version: 0.4.0
 Summary: A Python library for rendering structured tables as high-quality images or HTML.
 Keywords: table,renderer,rendering,image,html,weasyprint,pdfium,report
 Author: pTaunium
@@ -44,7 +44,7 @@ Description-Content-Type: text/markdown
 - **Auto-Crop**: Automatically crops images to the actual table area using visual detection, eliminating unnecessary white space.
 - **Continuous Long Tables**: Automatically stitches multiple PDF pages into a single continuous long image, preventing content from being cut off.
 - **Object-Oriented API**: Clean `Table` -> `Row/Column` -> `Cell` hierarchy with fluent interface support.
-- **Cascading Styles**: Manage visual styles effortlessly with "Global Defaults + Local Overrides."
+- **Cascading Styles**: Manage visual styles effortlessly with logical precedence: `Cell` > `Row` > `Column` > `Table`.
 - **Multi-language Font Support**: Support for font stacks (e.g., different fonts for English and Chinese).
 - **Customizable Resolution**: Adjustable DPI for high-resolution output (e.g., 300 DPI for print).
 - **Lightweight Deployment**: No heavy browser dependencies (like Chromium), making it ideal for Docker/K8s.
@@ -82,7 +82,6 @@ from table_renderer import Table
 
 # 1. Initialize a 3x3 table
 table = Table(3, 3)
-table.set_width(600)
 table.set_border(width=1, color="black", style="solid")
 
 # 2. Set header style (Row 0)
@@ -105,8 +104,8 @@ table.cell(2, 2).set_text("$79")
 # 4. Global column styling (align prices to the right)
 table.get_column(2).set_align(horizontal="right").set_width(100)
 
-# 5. Export to image with custom DPI and padding
-table.to_image("report.png", dpi=300, padding=20)
+# 5. Export to image with custom DPI, padding, and background color
+table.to_image("report.png", dpi=300, padding=20, background_color="white")
 ```
 
 ---
@@ -174,6 +173,9 @@ Fine-tune your output image quality and margins.
 # High-res JPG with custom 20px padding
 table.to_image("output.jpg", dpi=300, padding=20)
 
+# PNG with a solid white background (instead of the default transparent)
+table.to_image("output_white.png", background_color="white")
+
 # Lightweight WebP with tight margins
 table.to_image("output.webp", dpi=72, padding=0)
 ```

{table_renderer-0.2.0 → table_renderer-0.4.0}/README.md

@@ -21,7 +21,7 @@
 - **Auto-Crop**: Automatically crops images to the actual table area using visual detection, eliminating unnecessary white space.
 - **Continuous Long Tables**: Automatically stitches multiple PDF pages into a single continuous long image, preventing content from being cut off.
 - **Object-Oriented API**: Clean `Table` -> `Row/Column` -> `Cell` hierarchy with fluent interface support.
-- **Cascading Styles**: Manage visual styles effortlessly with "Global Defaults + Local Overrides."
+- **Cascading Styles**: Manage visual styles effortlessly with logical precedence: `Cell` > `Row` > `Column` > `Table`.
 - **Multi-language Font Support**: Support for font stacks (e.g., different fonts for English and Chinese).
 - **Customizable Resolution**: Adjustable DPI for high-resolution output (e.g., 300 DPI for print).
 - **Lightweight Deployment**: No heavy browser dependencies (like Chromium), making it ideal for Docker/K8s.
@@ -59,7 +59,6 @@ from table_renderer import Table
 
 # 1. Initialize a 3x3 table
 table = Table(3, 3)
-table.set_width(600)
 table.set_border(width=1, color="black", style="solid")
 
 # 2. Set header style (Row 0)
@@ -82,8 +81,8 @@ table.cell(2, 2).set_text("$79")
 # 4. Global column styling (align prices to the right)
 table.get_column(2).set_align(horizontal="right").set_width(100)
 
-# 5. Export to image with custom DPI and padding
-table.to_image("report.png", dpi=300, padding=20)
+# 5. Export to image with custom DPI, padding, and background color
+table.to_image("report.png", dpi=300, padding=20, background_color="white")
 ```
 
 ---
@@ -151,6 +150,9 @@ Fine-tune your output image quality and margins.
 # High-res JPG with custom 20px padding
 table.to_image("output.jpg", dpi=300, padding=20)
 
+# PNG with a solid white background (instead of the default transparent)
+table.to_image("output_white.png", background_color="white")
+
 # Lightweight WebP with tight margins
 table.to_image("output.webp", dpi=72, padding=0)
 ```

{table_renderer-0.2.0 → table_renderer-0.4.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "uv_build"
 
 [project]
 name = "table-renderer"
-version = "0.2.0"
+version = "0.4.0"
 description = "A Python library for rendering structured tables as high-quality images or HTML."
 readme = "README.md"
 license = "MIT"

{table_renderer-0.2.0 → table_renderer-0.4.0}/src/table_renderer/__init__.py

@@ -6,6 +6,6 @@ try:
     __version__ = importlib.metadata.version("table-renderer")
 except importlib.metadata.PackageNotFoundError:
     # Package is not installed (e.g. during local development without pip install -e .)
-    __version__ = "0.2.0"
+    __version__ = "0.4.0"
 
 __all__ = ["Cell", "Column", "Row", "Style", "StyledObject", "Table", "__version__"]

{table_renderer-0.2.0 → table_renderer-0.4.0}/src/table_renderer/models/__init__.py

@@ -1,8 +1,7 @@
-from .base import StyledObject
 from .cell import Cell
 from .column import Column
 from .row import Row
-from .style import Style
+from .style import Style, StyledObject
 from .table import Table
 
 __all__ = ["Cell", "Column", "Row", "Style", "StyledObject", "Table"]

{table_renderer-0.2.0 → table_renderer-0.4.0}/src/table_renderer/models/cell.py

@@ -1,6 +1,6 @@
 from typing import Self
 
-from .base import StyledObject
+from .style import StyledObject
 
 
 class Cell(StyledObject):

{table_renderer-0.2.0 → table_renderer-0.4.0}/src/table_renderer/models/column.py

@@ -1,6 +1,6 @@
 from typing import Self
 
-from .base import StyledObject
+from .style import StyledObject
 
 
 class Column(StyledObject):

{table_renderer-0.2.0 → table_renderer-0.4.0}/src/table_renderer/models/row.py

@@ -1,4 +1,4 @@
-from .base import StyledObject
+from .style import StyledObject
 
 
 class Row(StyledObject):

{table_renderer-0.2.0 → table_renderer-0.4.0}/src/table_renderer/models/style.py

@@ -1,5 +1,5 @@
 from dataclasses import dataclass
-from typing import Literal
+from typing import Literal, Self
 
 
 @dataclass
@@ -105,3 +105,93 @@ class Style:
             if style:
                 css.append(f"border-{side}-style: {style};")
         return css
+
+
+class StyledObject:
+    """Base class for objects that can be styled."""
+
+    def __init__(self) -> None:
+        """Initialize with a default Style."""
+        self.style = Style()
+
+    def set_font(
+        self,
+        *,
+        size: int | None = None,
+        color: str | None = None,
+        family: str | None = None,
+        weight: Literal["normal", "bold"] | None = None,
+    ) -> Self:
+        """
+        Set font related styles.
+
+        Args:
+            size: Font size in pixels.
+            color: Text color (e.g., 'red', '#ff0000').
+            family: Font family or font stack.
+            weight: 'normal' or 'bold'.
+
+        Returns:
+            The object itself for chaining.
+        """
+        self.style.font_size = size or self.style.font_size
+        self.style.font_color = color or self.style.font_color
+        self.style.font_family = family or self.style.font_family
+        self.style.font_weight = weight or self.style.font_weight
+        return self
+
+    def set_background(self, color: str) -> Self:
+        """
+        Set the background color.
+
+        Args:
+            color: Background color.
+
+        Returns:
+            The object itself for chaining.
+        """
+        self.style.bg_color = color
+        return self
+
+    def set_align(
+        self,
+        *,
+        horizontal: Literal["left", "center", "right"] | None = None,
+        vertical: Literal["top", "middle", "bottom"] | None = None,
+    ) -> Self:
+        """
+        Set text alignment.
+
+        Args:
+            horizontal: Horizontal alignment.
+            vertical: Vertical alignment.
+
+        Returns:
+            The object itself for chaining.
+        """
+        self.style.text_align = horizontal or self.style.text_align
+        self.style.vertical_align = vertical or self.style.vertical_align
+        return self
+
+    def set_border(
+        self,
+        *,
+        width: int | None = None,
+        color: str | None = None,
+        style: Literal["solid", "dashed", "dotted"] | None = None,
+    ) -> Self:
+        """
+        Set border styles.
+
+        Args:
+            width: Border width in pixels.
+            color: Border color.
+            style: Border style.
+
+        Returns:
+            The object itself for chaining.
+        """
+        self.style.border_width = width or self.style.border_width
+        self.style.border_color = color or self.style.border_color
+        self.style.border_style = style or self.style.border_style
+        return self

{table_renderer-0.2.0 → table_renderer-0.4.0}/src/table_renderer/models/table.py

@@ -2,10 +2,10 @@ from typing import Self
 
 from table_renderer.renderer import render_to_image, save_html
 
-from .base import StyledObject
 from .cell import Cell
 from .column import Column
 from .row import Row
+from .style import StyledObject
 
 
 class Table(StyledObject):
@@ -25,7 +25,7 @@ class Table(StyledObject):
         self._cells = [[Cell() for _ in range(cols)] for _ in range(rows)]
         self._row_objects = [Row(i) for i in range(rows)]
         self._col_objects = [Column(i) for i in range(cols)]
-        self.width: int | str = "100%"
+        self.width: int | str = "auto"
         self.font_files: list[str] = []
 
     def cell(self, row_index: int, col_index: int) -> Cell:
@@ -112,7 +112,14 @@ class Table(StyledObject):
         self.font_files.append(font_path)
         return self
 
-    def to_image(self, output_path: str, *, dpi: int = 144, padding: int = 10) -> None:
+    def to_image(
+        self,
+        output_path: str,
+        *,
+        dpi: int = 144,
+        padding: int = 10,
+        background_color: str = "transparent",
+    ) -> None:
         """
         Render the table to an image file.
 
@@ -120,17 +127,27 @@ class Table(StyledObject):
             output_path: Path to the output file (e.g., 'table.png', 'table.webp').
             dpi: Resolution of the output image.
             padding: Padding around the table in pixels.
+            background_color: Background color of the image.
         """
-        render_to_image(self, output_path, dpi=dpi, padding=padding)
+        render_to_image(
+            self,
+            output_path,
+            dpi=dpi,
+            padding=padding,
+            background_color=background_color,
+        )
 
-    def to_html(self, output_path: str) -> None:
+    def to_html(
+        self, output_path: str, *, background_color: str = "transparent"
+    ) -> None:
         """
         Export the table to an HTML file.
 
         Args:
             output_path: Path to the output HTML file.
+            background_color: Background color of the HTML body.
         """
-        save_html(self, output_path)
+        save_html(self, output_path, background_color=background_color)
 
     def _prepare_render(self) -> None:
         """Handle merging logic and cascading styles before rendering."""

{table_renderer-0.2.0 → table_renderer-0.4.0}/src/table_renderer/renderer.py

@@ -19,7 +19,7 @@ HTML_TEMPLATE = """
 body {
     margin: 0;
     padding: 20px;
-    background-color: transparent;
+    background-color: {{ background_color }};
 }
 {% for font in font_faces %}
 @font-face {
@@ -37,6 +37,7 @@ table {
 td {
     padding: 8px;
     box-sizing: border-box;
+    {{ table_style }}
 }
 
 {% for col in columns %}
@@ -60,10 +61,10 @@ td {
             {% for c_idx in range(cells[r_idx]|length) %}
                 {% set cell = cells[r_idx][c_idx] %}
                 {% if not cell.is_merged %}
-                <td class="col-{{ c_idx }}"
+                <td class="row-{{ r_idx }} col-{{ c_idx }}"
                     rowspan="{{ cell.row_span }}"
                     colspan="{{ cell.col_span }}"
-                    style="{{ cell.final_style }}">
+                    style="{{ cell.style.to_css() }}">
                     {% if cell.image_url %}
                     <img src="{{ cell.image_url }}"
                          style="{% if cell.image_width %}width: {{ cell.image_width }}px;{% endif %}
@@ -82,12 +83,13 @@ td {
 """
 
 
-def render_to_html(table: "Table") -> str:
+def render_to_html(table: "Table", *, background_color: str = "transparent") -> str:
     """
     Generate the HTML representation of the table.
 
     Args:
         table: The Table object to render.
+        background_color: The background color of the body.
 
     Returns:
         A string containing the complete HTML document.
@@ -107,12 +109,6 @@ def render_to_html(table: "Table") -> str:
         row_data = []
         for col_index in range(len(table._cells[0])):
             cell = table._cells[row_index][col_index]
-            row = table.get_row(row_index)
-            col = table.get_column(col_index)
-
-            # Cascading: Table -> Row/Col -> Cell
-            base_style = table.style.merge(col.style).merge(row.style)
-            final_style = base_style.merge(cell.style)
 
             # Handle Image URL resolution
             cell.image_url = ""
@@ -123,8 +119,6 @@ def render_to_html(table: "Table") -> str:
                     abs_img_path = os.path.abspath(cell.image_path)
                     cell.image_url = f"file://{abs_img_path}"
 
-            # Attach final style string for template
-            cell.final_style = final_style.to_css()
             row_data.append(cell)
         cells_data.append(row_data)
 
@@ -151,6 +145,7 @@ def render_to_html(table: "Table") -> str:
     return template.render(
         page_width=estimated_width,
         page_height=estimated_height,
+        background_color=background_color,
         table_width=f"{table.width}px" if isinstance(table.width, int) else table.width,
         table_style=table.style.to_css(),
         font_faces=font_faces,
@@ -175,6 +170,7 @@ def render_to_image(
     *,
     dpi: int = 144,
     padding: int = 10,
+    background_color: str = "transparent",
 ) -> None:
     """
     Render the table to an image file.
@@ -184,8 +180,9 @@ def render_to_image(
         output_path: Destination path for the image.
         dpi: Target resolution.
         padding: Margin around the table.
+        background_color: Background color of the image.
     """
-    html_content = render_to_html(table)
+    html_content = render_to_html(table, background_color=background_color)
     # WeasyPrint v53+ removed write_png, so we render to PDF then convert to PNG
     pdf_bytes = HTML(string=html_content).write_pdf()
 
@@ -220,17 +217,19 @@ def render_to_image(
             y_offset += img.height
 
     # Visual Auto-Crop: Find the bounding box of non-white pixels
-    # 1. Convert to RGB to ensure we have a standard background to check
-    bg = Image.new("RGB", pil_image.size, (255, 255, 255))
+    # Use 'L' (grayscale) mode to reduce memory usage (1 byte per pixel vs 3)
     if pil_image.mode == "RGBA":
-        bg.paste(pil_image, mask=pil_image.split()[3])
+        # Flatten RGBA onto a white grayscale background
+        grayscale = Image.new("L", pil_image.size, 255)
+        grayscale.paste(pil_image.convert("L"), mask=pil_image.getchannel("A"))
     else:
-        bg.paste(pil_image)
+        # For RGB or other modes, just convert to grayscale
+        grayscale = pil_image.convert("L")
 
-    # 2. Invert and find bbox of "ink"
+    # Invert and find bbox of "ink" (non-white pixels)
     import PIL.ImageOps
 
-    inverted = PIL.ImageOps.invert(bg)
+    inverted = PIL.ImageOps.invert(grayscale)
     bbox = inverted.getbbox()
 
     if bbox:
@@ -252,14 +251,17 @@ def render_to_image(
     pil_image.save(output_path)
 
 
-def save_html(table: "Table", output_path: str) -> None:
+def save_html(
+    table: "Table", output_path: str, *, background_color: str = "transparent"
+) -> None:
     """
     Save the table's HTML representation to a file.
 
     Args:
         table: The Table object to export.
         output_path: Path to the destination HTML file.
+        background_color: Background color of the HTML body.
     """
-    html_content = render_to_html(table)
+    html_content = render_to_html(table, background_color=background_color)
     with open(output_path, "w", encoding="utf-8") as f:
         f.write(html_content)

table_renderer-0.2.0/src/table_renderer/models/base.py

@@ -1,93 +0,0 @@
-from typing import Literal, Self
-
-from .style import Style
-
-
-class StyledObject:
-    """Base class for objects that can be styled."""
-
-    def __init__(self) -> None:
-        """Initialize with a default Style."""
-        self.style = Style()
-
-    def set_font(
-        self,
-        *,
-        size: int | None = None,
-        color: str | None = None,
-        family: str | None = None,
-        weight: Literal["normal", "bold"] | None = None,
-    ) -> Self:
-        """
-        Set font related styles.
-
-        Args:
-            size: Font size in pixels.
-            color: Text color (e.g., 'red', '#ff0000').
-            family: Font family or font stack.
-            weight: 'normal' or 'bold'.
-
-        Returns:
-            The object itself for chaining.
-        """
-        self.style.font_size = size or self.style.font_size
-        self.style.font_color = color or self.style.font_color
-        self.style.font_family = family or self.style.font_family
-        self.style.font_weight = weight or self.style.font_weight
-        return self
-
-    def set_background(self, color: str) -> Self:
-        """
-        Set the background color.
-
-        Args:
-            color: Background color.
-
-        Returns:
-            The object itself for chaining.
-        """
-        self.style.bg_color = color
-        return self
-
-    def set_align(
-        self,
-        *,
-        horizontal: Literal["left", "center", "right"] | None = None,
-        vertical: Literal["top", "middle", "bottom"] | None = None,
-    ) -> Self:
-        """
-        Set text alignment.
-
-        Args:
-            horizontal: Horizontal alignment.
-            vertical: Vertical alignment.
-
-        Returns:
-            The object itself for chaining.
-        """
-        self.style.text_align = horizontal or self.style.text_align
-        self.style.vertical_align = vertical or self.style.vertical_align
-        return self
-
-    def set_border(
-        self,
-        *,
-        width: int | None = None,
-        color: str | None = None,
-        style: Literal["solid", "dashed", "dotted"] | None = None,
-    ) -> Self:
-        """
-        Set border styles.
-
-        Args:
-            width: Border width in pixels.
-            color: Border color.
-            style: Border style.
-
-        Returns:
-            The object itself for chaining.
-        """
-        self.style.border_width = width or self.style.border_width
-        self.style.border_color = color or self.style.border_color
-        self.style.border_style = style or self.style.border_style
-        return self