Skip to content

Show DeprecationWarnings as INFO messages#2907

Merged
oprypin merged 1 commit intomkdocs:masterfrom
oprypin:warn
Aug 1, 2022
Merged

Show DeprecationWarnings as INFO messages#2907
oprypin merged 1 commit intomkdocs:masterfrom
oprypin:warn

Conversation

@oprypin
Copy link
Copy Markdown

@oprypin oprypin commented Jul 31, 2022

(previously they were not shown at all)

This works for both extensions and plugins -- and for MkDocs itself.
It will enable plugin developers to see warnings in advance. Or users to report such warnings to plugin developers.

Ref #2892, Python-Markdown/markdown#1277

Example session:

$ .venv/bin/pip install 'mdx_gh_links==0.2' 'Markdown==3.3.7'
$ PYTHONPATH=. .venv/bin/mkdocs serve                        
INFO     -  Building documentation...
INFO     -  DeprecationWarning: 'etree' is deprecated. Use 'xml.etree.ElementTree' instead.
              File "/home/blaxpirit/repos/mkdocs/.venv/lib/python3.10/site-packages/mdx_gh_links.py", line 35, in <module>
                from markdown.util import etree
              File "/home/blaxpirit/repos/mkdocs/.venv/lib/python3.10/site-packages/markdown/util.py", line 475, in __getattr__
                warnings.warn(
INFO     -  DeprecationWarning: Using setitem to register a processor or pattern is deprecated. Use the `register` method instead.
              File "/home/blaxpirit/repos/mkdocs/.venv/lib/python3.10/site-packages/mdx_gh_links.py", line 126, in extendMarkdown
                md.inlinePatterns['issue'] = IssuePattern(self.getConfigs(), md)
              File "/home/blaxpirit/repos/mkdocs/.venv/lib/python3.10/site-packages/markdown/util.py", line 393, in __setitem__
                warnings.warn(
INFO     -  DeprecationWarning: The 'md_globals' parameter of 'mdx_gh_links.GithubLinks.extendMarkdown' is deprecated.
              File "/home/blaxpirit/repos/mkdocs/.venv/lib/python3.10/site-packages/markdown/core.py", line 125, in registerExtensions
                ext._extendMarkdown(self)
              File "/home/blaxpirit/repos/mkdocs/.venv/lib/python3.10/site-packages/markdown/extensions/__init__.py", line 82, in _extendMarkdown
                warnings.warn(
INFO     -  Cleaning site directory
INFO     -  Documentation built in 0.51 seconds

cc @ultrabug @pawamoy

@oprypin
Show DeprecationWarnings as INFO messages
67a1dbf 
(previously they were not shown at all)

This works for both extensions and plugins -- and for MkDocs itself.
It will enable plugin developers to see warnings in advance. Or users to report such warnings to plugin developers.
ultrabug
ultrabug approved these changes Aug 1, 2022
View reviewed changes
Copy link
Copy Markdown
Member

@ultrabug ultrabug left a comment

Choose a reason for hiding this comment

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

Good job, I find that very elegant

@pawamoy
Copy link
Copy Markdown
Contributor

pawamoy commented Aug 1, 2022 •
edited
Loading

Just to understand: the change basically makes sure warnings are shown to the user by logging them as INFO? If users already have warnings shown, will they see them twice (once as a regular warning and a second time as an info log)? Also, good call on making them INFO level and not WARNING 👍

@oprypin

This comment was marked as abuse.

Sign in to view
@pawamoy
Copy link
Copy Markdown
Contributor

pawamoy commented Aug 1, 2022

Thanks, that answers my questions :) perfect.

@pawamoy
Copy link
Copy Markdown
Contributor

pawamoy commented Aug 1, 2022 •
edited
Loading

Actually I'm not sure if hiding regular warnings in favor of INFO logs is a good idea. I mean, maybe keeping the duplication would be better. In the common case, that's a few more lines of INFO logs few will read, in the worst case, users that were relying on regular warnings don't get their pytest run fail anymore, and I believe that's less chance these users will report these deprecations to the upstream packages. I hope I'm wrong though. The INFO logs are pretty visible so I guess it's fine.

@oprypin

This comment was marked as abuse.

Sign in to view
@oprypin

This comment was marked as abuse.

Sign in to view
@pawamoy
Copy link
Copy Markdown
Contributor

pawamoy commented Aug 1, 2022

Hmmm yeah I don't think a lot of users/plugin developers run MkDocs commands through pytest with warnings enabled anyway 🤔
Always happy to be proven wrong.
I just know warnings are a nice way to, well, warn users, and worry about the effects of replacing them with logs, which don't react to the same mechanisms. But I'm probably overthinking here. I trust your decisions @oprypin. And I'm slowly getting back to open source so don't mind me too much.

@llwt llwt mentioned this pull request Jan 25, 2023
Closed
@wilhelmer wilhelmer mentioned this pull request Mar 10, 2023
Closed
@kcgthb kcgthb mentioned this pull request May 3, 2024
Open
@provisota provisota mentioned this pull request Nov 12, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@ultrabug ultrabug ultrabug approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@oprypin @pawamoy @ultrabug