Added Cell level control for Table Borders #1285
Conversation
|
Hi @Lucas-C, I have made a PR to know if I am doing it correctly it is not a complete implementation, please see the code change and give me suggestions. |
| 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) |
There was a problem hiding this comment.
Not needed if you perform the call to .coerce() in Row.cell()
There was a problem hiding this comment.
I do not think that those hasattr & CellBordersLayout.coerce calls are needed.
Nice, thank you for creating a PR 🙂 I made a few comments. One thing that should come next is to add unit tests! 🙂 |
|
Hi, I made the suggested changes, now how can I fix this pylint warning, And please tell me where I should add the unit tests. |
It now seems to be passing, but you have however 27 failing tests.
You can add them to |
|
Hi @Lucas-C, should I write test just like this? and for all the different values like, def test_cell_border_left(tmp_path):
pdf = FPDF()
pdf.add_page()
pdf.set_font("Times", size=5)
with pdf.table( gutter_height=2, gutter_width=2) 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) |
|
@Lucas-C is it the right way of writing the tests? |
Yes, this look likes a good start 👍 And testing many possible combination of values is also a good idea! |
|
is it fine @Lucas-C ? |
| @@ -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): | |||
There was a problem hiding this comment.
Could you regroup all or most of those tests in a single one, with one case per page, in order to limit the number of reference PDF files, please?
All the right/left/top/bottom cases could form a single unit test I think.
inherit should have its own dedicated unit test & reference file, but I think more cases should be tested:
- cell
border="INHERIT"with various tableborders_layoutvalues - cell
border="INHERIT"with tableouter_border_widthset
|
Hi @Lucas-C, Should I add documentation for this as well, or would it be better to address it in a new issue? Creating a separate issue might also be a good idea, as it would give me the opportunity to make an additional contribution 🙂 |
We usually integrate the documentation related to new features as part of the PR that introduced it, so yes, it would be a good idea to include some documentation as part of this PR 🙂 Also, have you seen my other previous comments regarding the remaing minor changes required? |
|
Yes, I have made the changes you suggested. |
I'm sorry but I don't think you adressed those 4 distinct points:
|
|
I haven't committed it yet. |
Oh OK, alright, that's fine🙂 |
Fixes : #1192
Implemented a new feature that allows granular, cell-level control over table borders. With this update, users can now define specific borders (left, right, top, bottom) for individual cells, offering greater customization when generating tables in PDFs.
Checklist:
The GitHub pipeline is OK (green),
meaning that both
pylint(static code analyzer) andblack(code formatter) are happy with the changes of this PR.A unit test is covering the code added / modified by this PR
This PR is ready to be merged
In case of a new feature, docstrings have been added, with also some documentation in the
docs/folderA mention of the change is present in
CHANGELOG.mdBy submitting this pull request, I confirm that my contribution is made under the terms of the GNU LGPL 3.0 license.