NotificationsYou must be signed in to change notification settings
Fork8.1k
Star22.1k

MAINT: don't format logs in log call.#25073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

jklymak merged 2 commits intomatplotlib:mainfromCarreau:log-f

Jan 25, 2023

Merged

MAINT: don't format logs in log call.#25073

jklymak merged 2 commits intomatplotlib:mainfromCarreau:log-f

Jan 25, 2023

Conversation

Copy link

Contributor

Carreau commentedJan 25, 2023•
edited
Loading

In particular f-string:

There are many reason not to use f-string in logs,

F-strings are eager, so might be slow. So this may affect performance (we can filter before formatting).
prevent structured logging or handler to highlight.
Security (untrusted input can lead to DOS on formatting,https://discuss.python.org/t/safer-logging-methods-for-f-strings-and-new-style-formatting/13802)

But also % formatting in a couple of places.

PR Checklist

Documentation and Tests

Has pytest style unit tests (andpytest passes)
Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
New plotting related features are documented with examples.

Release Notes

New features are marked with a.. versionadded:: directive in the docstring and documented indoc/users/next_whats_new/
API changes are marked with a.. versionchanged:: directive in the docstring and documented indoc/api/next_api_changes/
Release notes conform with instructions innext_whats_new/README.rst ornext_api_changes/README.rst

MAINT: don't format logs in log call.

90a753b

In particular f-string:There are many reason not to use f-string in logs, - F-strings are eager, so might be slow. So this may affect performance   (we can filter before formatting). - prevent structured logging or handler to highlight. - Security (untrusted input can lead to DOS on formatting,https://discuss.python.org/t/safer-logging-methods-for-f-strings-and-new-style-formatting/13802)But also % formatting in a couple of places.

QuLogic approved these changes

Jan 25, 2023

View reviewed changes

lib/matplotlib/_mathtext.py OutdatedShow resolvedHide resolved

Update lib/matplotlib/_mathtext.py

9fceadf

Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>

Copy link

Member

story645 commentedJan 25, 2023

Can a note about this be put somewhere on thecontributing code page? I worry that this is the type of thing that will get changed in either direction 16 times.

jklymak approved these changes

Jan 25, 2023

View reviewed changes

jklymak merged commitaaf01bf intomatplotlib:main

Jan 25, 2023

Copy link

Member

jklymak commentedJan 25, 2023

@meeseeksdev backport to 3.7.0

jklymak added this to thev3.7.0 milestone

Jan 25, 2023

Copy link

lumberbot-appbot commentedJan 25, 2023

Something went wrong ... Please have a look at my logs.

It seems that the branch you are trying to backport to does not exist.

jklymak mentioned this pull request

Jan 25, 2023

Add note in contrib guide admonishing against use of f strings in logs#25080

Closed

Copy link

Member

lumberbot-appbot commentedJan 25, 2023

Something went wrong ... Please have a look at my logs.

It seems that the branch you are trying to backport to does not exist.

Copy link

Member

jklymak commentedJan 25, 2023

@meeseeksdev backport to v3.7.x

Copy link

lumberbot-appbot commentedJan 25, 2023

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

Checkout backport branch and update it.

git checkout v3.7.xgit pull

Cherry pick the first parent branch of the this PR on top of the older branch:

git cherry-pick -x -m1 aaf01bf0918d6d072a9824581aa3e5bccf1ad7e0

You will likely have some merge/cherry-pick conflict here, fix them and commit:

git commit -am "Backport PR #25073: MAINT: don't format logs in log call."

Push to a named branch:

git push YOURFORK v3.7.x:auto-backport-of-pr-25073-on-v3.7.x

Create a PR against branch v3.7.x, I would have named this PR:

"Backport PR#25073 on branch v3.7.x (MAINT: don't format logs in log call.)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove theStill Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free tosuggest an improvement.

lumberbot-appbot added the Still Needs Manual Backport label

Jan 25, 2023

Copy link

Member

jklymak commentedJan 25, 2023

@Carreau is this important enough to manually backport?

Copy link

Member

ksunden commentedJan 25, 2023

I didn't go back to find these lines specifically, but most of these are likely made into f strings via#24980 which was not itself backported to 3.7.x

Copy link

Member

jklymak commentedJan 25, 2023

Ah.... It did all seem too obscure to have triggered conflicts. So I think this can safely not be backported.

Copy link

Contributor

greglucas commentedJan 25, 2023

This may conflict with the f-string PR, but that PR only changed from.format() tof"{}" in the log calls, so we were already previously doing it poorly with thestr.format(val). This is an improvement and uses the logger formatting, notstr % val but ratherlog(str, val). I don't think it would be super hard to manually backport if@Carreau wants to tackle it.