Added Cell level control for Table Borders

fpdf/enums.py

@@ -310,6 +310,46 @@ class TableBordersLayout(CoerciveEnum):
     "Draw only the top horizontal border, below the headings"
 
 
+class CellBordersLayout(CoerciveIntFlag):
+    NONE = 0
+    LEFT = 1
+    RIGHT = 2
+    TOP = 4
+    BOTTOM = 8
+    ALL = LEFT | RIGHT | TOP | BOTTOM
+    INHERIT = 16
+
+    @classmethod
+    def coerce(cls, value):
+        if isinstance(value, int) and value > 16:
+            raise ValueError("INHERIT cannot be combined with other values")
+        return super().coerce(value)
+
+    def __and__(self, value):
+        value = super().__and__(value)
+        if value > 16:
+            raise ValueError("INHERIT cannot be combined with other values")
+        return value
+
+    def __or__(self, value):
+        value = super().__or__(value)
+        if value > 16:
+            raise ValueError("INHERIT cannot be combined with other values")
+        return value
+
+    def __str__(self):
+        border_str = []
+        if self & CellBordersLayout.LEFT:
+            border_str.append("L")
+        if self & CellBordersLayout.RIGHT:
+            border_str.append("R")
+        if self & CellBordersLayout.TOP:
+            border_str.append("T")
+        if self & CellBordersLayout.BOTTOM:
+            border_str.append("B")
+        return "".join(border_str) if border_str else "NONE"
+
+
 class TableCellFillMode(CoerciveEnum):
     "Defines which table cells to fill"
 

fpdf/table.py

@@ -11,6 +11,7 @@
     WrapMode,
     VAlign,
     TableSpan,
+    CellBordersLayout,
 )
 from .errors import FPDFException
 from .fonts import CORE_FONTS, FontFace
@@ -251,13 +252,21 @@ def render(self):
         self._fpdf.l_margin = prev_l_margin
         self._fpdf.x = self._fpdf.l_margin
 
+    # pylint: disable=too-many-return-statements
     def get_cell_border(self, i, j, cell):
         """
         Defines which cell borders should be drawn.
         Returns a string containing some or all of the letters L/R/T/B,
         to be passed to `fpdf.FPDF.multi_cell()`.
         Can be overriden to customize this logic
         """
+
+        if hasattr(cell, "border"):
+            border = CellBordersLayout.coerce(cell.border)
+
+            if border != CellBordersLayout.INHERIT:
+                return str(border)
+
         if self._borders_layout == TableBordersLayout.ALL:
             return 1
         if self._borders_layout == TableBordersLayout.NONE:
@@ -770,6 +779,7 @@ def cell(
         rowspan=1,
         padding=None,
         link=None,
+        border=CellBordersLayout.INHERIT,
     ):
         """
         Adds a cell to the row.
@@ -819,6 +829,7 @@ def cell(
             rowspan,
             padding,
             link,
+            CellBordersLayout.coerce(border),
         )
         self.cells.append(cell)
         return cell
@@ -838,6 +849,7 @@ class Cell:
         "rowspan",
         "padding",
         "link",
+        "border",
     )
     text: str
     align: Optional[Union[str, Align]]
@@ -849,6 +861,7 @@ class Cell:
     rowspan: int
     padding: Optional[Union[int, tuple, type(None)]]
     link: Optional[Union[str, int]]
+    border: Optional[CellBordersLayout]
 
     def write(self, text, align=None):
         raise NotImplementedError("Not implemented yet")

test/text/test_cell.py

@@ -1,6 +1,5 @@
 import gzip
 from pathlib import Path
-
 import pytest
 
 from fpdf import FPDF, FPDFException
@@ -362,3 +361,239 @@ def test_cell_speed_with_long_text():  # issue #907
     assert len(LONG_TEXT_LINES) == 26862
     for line in LONG_TEXT_LINES:
         pdf.cell(0, 3, line, new_x="LMARGIN", new_y="NEXT")
+
+
+def test_cell_border_none(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border="None")
+    assert_pdf_equal(pdf, HERE / "test_cell_border_none.pdf", tmp_path)
+
+
+def test_cell_border_left(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+            for datum in data_row:
+                row.cell(datum, border="left")
+    assert_pdf_equal(pdf, HERE / "test_cell_border_left.pdf", tmp_path)
+
+
+def test_cell_border_right(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border="right")
+    assert_pdf_equal(pdf, HERE / "test_cell_border_right.pdf", tmp_path)
+
+
+def test_cell_border_top(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border="top")
+    assert_pdf_equal(pdf, HERE / "test_cell_border_top.pdf", tmp_path)
+
+
+def test_cell_border_bottom(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border="bottom")
+    assert_pdf_equal(pdf, HERE / "test_cell_border_bottom.pdf", tmp_path)
+
+
+def test_cell_border_all(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border="all")
+    assert_pdf_equal(pdf, HERE / "test_cell_border_all.pdf", tmp_path)
+
+
+def test_cell_border_inherit(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border="inherit")
+    assert_pdf_equal(pdf, HERE / "test_cell_border_inherit.pdf", tmp_path)
+
+
+def test_cell_border_left_right(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=3)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_left_right.pdf", tmp_path)
+
+
+def test_cell_border_left_top(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=5)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_left_top.pdf", tmp_path)
+
+
+def test_cell_border_left_bottom(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=9)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_left_bottom.pdf", tmp_path)
+
+
+def test_cell_border_right_top(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=6)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_right_top.pdf", tmp_path)
+
+
+def test_cell_border_right_bottom(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=10)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_right_bottom.pdf", tmp_path)
+
+
+def test_cell_border_left_right_top(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=7)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_left_right_top.pdf", tmp_path)
+
+
+def test_cell_border_left_right_bottom(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=11)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_left_right_bottom.pdf", tmp_path)
+
+
+def test_cell_border_left_top_bottom(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=13)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_left_top_bottom.pdf", tmp_path)
+
+
+def test_cell_border_right_top_bottom(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=13)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_right_top_bottom.pdf", tmp_path)
+
+
+def test_cell_border_top_bottom(tmp_path):
+    pdf = FPDF()
+    pdf.add_page()
+    pdf.set_font("Times", size=16)
+    with pdf.table(gutter_height=3, gutter_width=3) as table:
+        for data_row in TABLE_DATA:
+            row = table.row()
+
+            for datum in data_row:
+                print(datum, end=" ")
+                row.cell(datum, border=12)
+    assert_pdf_equal(pdf, HERE / "test_cell_border_top_bottom.pdf", tmp_path)