Skip to content

When a Markdown extension fails to load, print its name and traceback#2894

Merged
oprypin merged 2 commits intomkdocs:masterfrom
oprypin:tb
Jul 19, 2022
Merged

When a Markdown extension fails to load, print its name and traceback#2894
oprypin merged 2 commits intomkdocs:masterfrom
oprypin:tb

Conversation

@oprypin
Copy link
Contributor

@oprypin oprypin commented Jul 18, 2022

No description provided.

@oprypin oprypin mentioned this pull request Jul 18, 2022
Closed
@oprypin
Copy link
Contributor Author

oprypin commented Jul 18, 2022 •
edited
Loading

Example output:

ERROR    -  Config value: 'markdown_extensions'. Error: Failed to load extension 'mdx_gh_links'.
              File "/home/blaxpirit/repos/mkdocs/venv/lib/python3.10/site-packages/mdx_gh_links.py", line 35, in <module>
                from markdown.util import etree
            ImportError: cannot import name 'etree' from 'markdown.util' (/home/blaxpirit/.local/lib/py/markdown/util.py)
Aborted with 1 Configuration Errors!

@ultrabug
Copy link
Member

ultrabug commented Jul 19, 2022

Thanks, the PR is good as-is

I was just wondering if we should add a mention that makes it explicit that mkdocs is not responsible for the breakage, like Please check the traceback below to find out which extension module has a problem and report to them.

@oprypin
Copy link
Contributor Author

oprypin commented Jul 19, 2022

Actually we don't know that that's true - that the extension is at fault. This could also be coming from configuring the extension incorrectly.

extensions:
  - pymdownx.superfences:
      custom_fences: foo
ERROR    -  Config value: 'markdown_extensions'. Error: Failed to load extension 'pymdownx.superfences'.
              File "/home/blaxpirit/repos/mkdocs/mkdocs/config/config_options.py", line 641, in run_validation
                md.registerExtensions((ext,), self.configdata)
              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/pymdownx/superfences.py", line 273, in extendMarkdown
                name = custom.get('name')
            AttributeError: 'str' object has no attribute 'get'

Previously it was just this, btw:

ERROR    -  Config value: 'markdown_extensions'. Error: 'str' object has no attribute 'get'

Determining that this is for sure an extension's fault could be more complex or not even feasible.

@oprypin oprypin merged commit 6bd62b9 into mkdocs:master Jul 19, 2022
ultrabug added a commit to ultrabug/mkdocs that referenced this pull request Jul 25, 2022
@ultrabug
config: try to detect extensions breaking with markdown >= 3.4.1
f758356 
see mkdocs#2892 mkdocs#2894 and Python-Markdown#1277
ultrabug added a commit to ultrabug/mkdocs that referenced this pull request Jul 25, 2022
@ultrabug
config: try to detect extensions breaking with markdown >= 3.4.1
468e924 
see mkdocs#2892 mkdocs#2894 and Python-Markdown#1277
@ultrabug ultrabug mentioned this pull request Jul 25, 2022
Closed
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.

2 participants

@oprypin @ultrabug