Allow keep_aspect_ratio flag in templates. #1119

Clock-Speed · 2024-02-21T04:20:01Z

Fixes #1118
Allows for using the keep_aspect_ratio flag from the image method to templates.
Example use:

tmpl = [
        {
            "name": "box",
            "type": "B",
            "x1": 0,
            "y1": 0,
            "x2": 50,
            "y2": 25,
        },
        {
            "name": "img",
            "type": "I",
            "x1": 0,
            "y1": 0,
            "x2": 50,
            "y2": 25,
            "keep_aspect_ratio": True,
        },
    ]

    img = qrcode.make("Test keep_aspect_ratio").get_image()

    pdf = FPDF()
    pdf.add_page()
    templ1 = FlexTemplate(pdf, tmpl)
    templ1["img"] = img
    templ1.render(offsetx=20, offsety=20)

Which gives the following output:
keep_aspect_ratio=true.pdf
Compared to when keep_aspect_ratio is set to False:
keep_aspect_ratio=false.pdf

Checklist:

The GitHub pipeline is OK (green),
meaning that both pylint (static code analyzer) and black (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/ folder
A mention of the change is present in CHANGELOG.md

By submitting this pull request, I confirm that my contribution is made under the terms of the GNU LGPL 3.0 license.

Add appropriate tests and update documentation.

Lucas-C

Your PR is really nice!

Could please also add a mention of this addition in CHANGELOG.md?

Lucas-C · 2024-02-21T07:49:02Z

fpdf/template.py

@@ -84,6 +84,7 @@ def load_elements(self, elements):
            "priority": int,
            "multiline": (bool, type(None)),
            "rotate": (int, float),
+            "keep_aspect_ratio": object,  # "bool or equivalent",


Why not typing this as bool?

I was mostly just a little confused here with the types, as other fields also seem to be flags but are typed as objects (eg. bold & italic). Seems that "multiline" is also possibly a bool but it is typed as (bool, type(None)) for some reason.

@gmischler just a ping for you on this subject, as you have more experience than me with the templating system 🙂

It looks like I added this in #244.
The motivation was to allow other values with a True/False meaning, similar to what most library functions in Python allow. The documentation also specifies "enabled with True or equivalent value".
If there is a better/more explicit way to specify this, I haven't found it yet...

The other reason was that bold/italic/underline can also be specified in in a csv file, which uses ints instead of bools (more precisely: strings representing ints). This reason does not apply to keep_aspect_ratio, but the first one still does.

Alright!
So what do you think is the best there? int? (bool, int)?

IMHO we could stick to bool even if non-boolean "truthy" values are also valid, this would make the intent of this parameter clearer.

IMHO we could stick to bool even if non-boolean "truthy" values are also valid, this would make the intent of this parameter clearer.

If we use bool, then we need an additional conversion (first from str to int, then to bool) for CSV files.

You'd expect there to be a standard way of expressing "bool or True/False equivalent", wouldn't you?
A quick search has not turned up anything useful for me...

Maybe just using bool is really the simplest way, although that is technically a backwards incompatible change.

Lucas-C · 2024-02-21T07:49:21Z

fpdf/template.py

@@ -190,6 +191,7 @@ def _varsep_float(s, default="0"):
            ("priority", int, False),
            ("multiline", self._parse_multiline, False),
            ("rotate", _varsep_float, False),
+            ("keep_aspect_ratio", int, False),


Suggested change

("keep_aspect_ratio", int, False),

("keep_aspect_ratio", bool, False),

Same as above, the converter is int here in order to maintain similarity to the other boolean flags. Would need to test if this behaviour works (though I cannot see why it shouldn't).

Changing bold/italic/underline to using bool would require additional conversion magic when reading CSVs. Since we're evaluating strings there, currently int("0") evaluates correctly as False, while bool("0") would incorrectly evaluate to True.
It might be helpful to add some comments to the code explaining this...

Of couse, since keep_aspect_ratio is not supported via CSV, that one can use bool without a problem.

Lucas-C · 2024-02-27T14:48:33Z

Do you have enough information in our answers to adress the review feedbacks @Clock-Speed? 🙂

Lucas-C · 2024-02-28T13:57:02Z

@allcontributors please add @Clock-Speed for code

allcontributors · 2024-02-28T13:57:11Z

@Lucas-C

I've put up a pull request to add @Clock-Speed! 🎉

Lucas-C · 2024-05-24T09:45:24Z

Hi!

Just a quick update about this: @Clock-Speed are you still willing to work on this feature?
If you don't, or do not have time for this anymore, that totally fine! 🙂
If so we will just close this PR.

Also, if you need feedback or help on this PR, please tell us! 🙂

Allow keep_aspect_ratio flag in templates.

5792f50

Add appropriate tests and update documentation.

Clock-Speed requested a review from gmischler as a code owner February 21, 2024 04:20

Lucas-C requested changes Feb 21, 2024

View reviewed changes

Update changelog

4b0d537

allcontributors bot mentioned this pull request Feb 28, 2024

add Clock-Speed as a contributor for code #1129

Merged

gmischler mentioned this pull request May 9, 2024

Option to define wrapmode="CHAR" within a template #1159

Open

Lucas-C added the pending-answer label May 24, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow keep_aspect_ratio flag in templates. #1119

Allow keep_aspect_ratio flag in templates. #1119

Clock-Speed commented Feb 21, 2024 •

edited

Lucas-C left a comment

Lucas-C Feb 21, 2024

Clock-Speed Feb 21, 2024

Lucas-C Feb 21, 2024

gmischler Feb 22, 2024 •

edited

Lucas-C Feb 22, 2024

gmischler Feb 22, 2024

Lucas-C Feb 21, 2024

Clock-Speed Feb 21, 2024

gmischler Feb 22, 2024 •

edited

Lucas-C Feb 22, 2024 •

edited

Lucas-C commented Feb 27, 2024

Lucas-C commented Feb 28, 2024

allcontributors bot commented Feb 28, 2024

Lucas-C commented May 24, 2024

	("keep_aspect_ratio", int, False),
	("keep_aspect_ratio", bool, False),

Allow keep_aspect_ratio flag in templates. #1119

Are you sure you want to change the base?

Allow keep_aspect_ratio flag in templates. #1119

Conversation

Clock-Speed commented Feb 21, 2024 • edited

Lucas-C left a comment

Choose a reason for hiding this comment

Lucas-C Feb 21, 2024

Choose a reason for hiding this comment

Clock-Speed Feb 21, 2024

Choose a reason for hiding this comment

Lucas-C Feb 21, 2024

Choose a reason for hiding this comment

gmischler Feb 22, 2024 • edited

Choose a reason for hiding this comment

Lucas-C Feb 22, 2024

Choose a reason for hiding this comment

gmischler Feb 22, 2024

Choose a reason for hiding this comment

Lucas-C Feb 21, 2024

Choose a reason for hiding this comment

Clock-Speed Feb 21, 2024

Choose a reason for hiding this comment

gmischler Feb 22, 2024 • edited

Choose a reason for hiding this comment

Lucas-C Feb 22, 2024 • edited

Choose a reason for hiding this comment

Lucas-C commented Feb 27, 2024

Lucas-C commented Feb 28, 2024

allcontributors bot commented Feb 28, 2024

Lucas-C commented May 24, 2024

Clock-Speed commented Feb 21, 2024 •

edited

gmischler Feb 22, 2024 •

edited

gmischler Feb 22, 2024 •

edited

Lucas-C Feb 22, 2024 •

edited