Fixed escaping of alt text in ContentFormat.img() #2036
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
bmispelon
changed the title
bmispelon
force-pushed
the
fix/2035-img-alt-text-escape
branch
from
6cdcbef to
161b8fd
Compare
adamzap
reviewed
May 16, 2025
There was a problem hiding this comment.
Other than the final ReST test that includes a newline (see my other comment), I'm able to get the tests to pass with this small change:
diff --git a/blog/models.py b/blog/models.py
index 0083dd22..9ca310b0 100644
--- a/blog/models.py
+++ b/blog/models.py
@@ -1,3 +1,4 @@
+import html
from urllib.parse import urlparse
from django.conf import settings
@@ -73,7 +74,7 @@ class ContentFormat(models.TextChoices):
CF = type(self)
return {
CF.REST: f".. image:: {url}\n :alt: {alt_text}",
- CF.HTML: f'<img src="{url}" alt="{alt_text}">',
+ CF.HTML: f'<img src="{url}" alt="{html.escape(alt_text)}">',
CF.MARKDOWN: f"",
}[self]I'm wondering if _md_escape is not needed since markdown escapes alt text automatically:
>>> import markdown
>>> markdown.markdown('')
'<p><img alt="Al"t t"ext" src="/path/to/img.jpg" /></p>'If the intent behind _md_escape is something beyond fixing alt text quoting, could we put it in a different PR?
| (ContentFormat.REST, "test-", '<img src="." alt="test-">'), | ||
| (ContentFormat.REST, "test.", '<img src="." alt="test.">'), | ||
| (ContentFormat.REST, "test!", '<img src="." alt="test!">'), | ||
| (ContentFormat.REST, "te\nst", '<img src="." alt="te st">'), |
There was a problem hiding this comment.
Do we need to support newlines in alt text? I'm having trouble verifying that newlines would have any affect on rendering.
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.
This should fix #2035 and also address escaping issues in the other formats (markdown and restructured text).