Skip to content

added a note to avoid f-strings in logging #25081

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
jklymak merged 5 commits into from
Mar 6, 2023
Merged

added a note to avoid f-strings in logging #25081

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a9ab747
added a note to avoid f-strings in logging
muddi900 Jan 25, 2023
3b52047
Reduced Verbosity
muddi900 Feb 24, 2023
d103cb5
Double Backtick typo fixed
muddi900 Feb 25, 2023
33207ce
Better example format, with less verbosity[from @story645]
muddi900 Mar 1, 2023
b434e82
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Mar 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions doc/devel/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -455,6 +455,12 @@ Then they will receive messages like
DEBUG:matplotlib.yourmodulename:Here is some information
DEBUG:matplotlib.yourmodulename:Here is some more detailed information

Avoid using pre-computed strings (``f-strings``, ``str.format``,etc.) for logging because of security and
performance issues, and because they interfere with style handlers. For example, use ``_log.error('hello %s', 'world')`` rather than
``_log.error('hello {}'.format('world'))`` or ``_log.error(f'hello {s}')``.



Which logging level to use?
~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down