fix(html): escape square brackets and backslashes in image alt text - #2523
Open
bodapatisaikrishna wants to merge 1 commit into
Open
bodapatisaikrishna wants to merge 1 commit into
bodapatisaikrishna wants to merge 1 commit into
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
When converting HTML images to Markdown, image
alttext is taken directly from the element attribute and formatted as. In Markdown/CommonMark syntax, the image description is delimited by square brackets[...].If the
alttext contains unescaped square brackets:alt="Photo ] 1") prematurely closes the image description delimiter, resulting in![Photo ] 1](url)which fails Markdown image parsing.alt="Photo [1") prevents Markdown parsers from matching the image delimiter or misinterprets subsequent text as a nested link (-><p>") breaks CommonMark image parsing because image descriptions cannot contain nested links.Solution
In
_CustomMarkdownify.convert_img, backslash-escape literal backslashes and square brackets (\->\\,[->\[,]->\]) before assembling theMarkdown image syntax:Testing
Added regression tests in
test_html_converter.pycovering:])[)[Q3])[here](url))\)