NotificationsYou must be signed in to change notification settings
Fork7.9k
Star21.3k

set_loglevel documenation and escape hatch#23681

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

Closed

tacaswell wants to merge2 commits intomatplotlib:mainfromtacaswell:loggers

Closed

set_loglevel documenation and escape hatch#23681

tacaswell wants to merge2 commits intomatplotlib:mainfromtacaswell:loggers

Conversation

Copy link

Member

tacaswell commentedAug 19, 2022

PR Summary

closes#23646

If we want this new flag I'll add a test. I am of two minds on it, we might only want the doc updates.

PR Checklist

Tests and Styling

[] Has pytest style unit tests (andpytest passes).
IsFlake 8 compliant (installflake8-docstrings and runflake8 --docstring-convention=all).

Documentation

New features are documented, with examples if plot related.
New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
[N/A] API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).
Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).

tacaswell added2 commits

August 19, 2022 14:49

DOC: clarify that Matplotlib uses standard library logging module

6f28407

and that set_loglevel tries to be helpful and installs a stream handler.

ENH: add ability for set_loglevel to not add a handler

1b1502d

tacaswell added the status: needs tests label

Aug 19, 2022

tacaswell added this to thev3.7.0 milestone

Aug 19, 2022

jklymak reviewed

Aug 20, 2022

View reviewed changes

lib/matplotlib/__init__.py

		Parameters
		----------
		level : {"notset", "debug", "info", "warning", "error", "critical"}
		The log level of the handler.

		ensure_handler : bool

Copy link

Member

jklymakAug 20, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I guess I am not sure why we would add this. A naive enduser unfamiliar with logging won't know what this means, and a library author familiar with logging should know not to call this, particularly given the change to the docstring above. If we do add this, the docstring below probably needs to be clarified.

Copy link

Contributor

l-johnstonAug 20, 2022•
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I agree; a documentation update should be sufficient:

Add a new section for discussion of logging within Matplotlib - the two use cases as a library and as an application
End users can call set_level()
For library developers, state that Matplotlib is using the standard librarylogging and its singleton logger is called 'matplotlib' and in their library code get the 'matplotlib' logger and add the desired handler.