[MNT] Typing: Use Literal for set_loglevel #30302
Conversation
|
Hi all 👋, I initially attempted to address multiple points from this issue in a single PR, but I realized that it introduced unnecessary complexity, especially for someone like me who is still learning and new to contributing at this scale. To manage things better and ensure clarity in both review and implementation, I’ve now shifted to handling one fix at a time. I’ve started with set_loglevel as it seemed like a simpler, self-contained change to begin with. This approach will also help me improve gradually and avoid making mistakes across unrelated parts. Thank you so much for your patience and guidance, it’s really encouraging for a beginner like me 🙏🙂 |
|
Thanks. This is correct in the sense that it matches documentation now. 
However, implementation-wise we've accepted any capitalization, in particular also thd capitalized form "INFO", which is passed through to/accepted by stdlibs |
|
Yes @timhoffm, you’re right. I’ve implemented this by normalising the input to lowercase within set_loglevel(), so it aligns with the stdlib behaviour. You think that will work? Let me know if any further changes are required. |
1f29d69 to
0555206
Compare
matplotlib#30302 just introduced literals for the log levels. Previously, the situation was a bit vague: While the docstring described the levels as all lowercase, in fact any casing is accepted. This PR changes the preferred casing to be all-capitalized in analogy to the logging standard library, which only supports this casing. Lowercase remains supported because it's not worth an API breakage. We might later consider to also accept logging levels directly, i.e. `logging.DEBUG` to be more congruent with the logging library. But this can be done any time. It's important to get this PR in soon to not release the typing Literal in lowercase form.
* MNT: Prefer capitalized logging levels #30302 just introduced literals for the log levels. Previously, the situation was a bit vague: While the docstring described the levels as all lowercase, in fact any casing is accepted. This PR changes the preferred casing to be all-capitalized in analogy to the logging standard library, which only supports this casing. Lowercase remains supported because it's not worth an API breakage. We might later consider to also accept logging levels directly, i.e. `logging.DEBUG` to be more congruent with the logging library. But this can be done any time. It's important to get this PR in soon to not release the typing Literal in lowercase form. * Update lib/matplotlib/__init__.py Co-authored-by: Thomas A Caswell <tcaswell@gmail.com> --------- Co-authored-by: Thomas A Caswell <tcaswell@gmail.com>
This PR addresses part of #30257 by improving type safety and IDE support for set_loglevel.
Changes in this PR:
This improves discoverability and static type checking for valid logging levels like "info", "debug", "error", etc.
Related work not included here
MarkerType updates were implemented by @ZPyrolink in #30261
Event type literals for connect methods were contributed by @ZPyrolink in #30275