Skip to content

Fix JSONDecodeError when JSON-LD script is HTML-entity-encoded #249

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gaoflow wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix JSONDecodeError when JSON-LD script is HTML-entity-encoded #249

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions extruct/jsonld.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
JSON-LD extractor
"""

import html
import json
import re

Expand Down Expand Up @@ -36,6 +37,9 @@ def _extract_items(self, node):
script = node.xpath("string()").strip()
if not script:
return
# Some sites incorrectly HTML-encode the JSON-LD content (e.g. " instead of ").
# Unescape HTML entities before parsing so json.loads sees valid JSON.
script = html.unescape(script)
try:
# TODO: `strict=False` can be configurable if needed
data = json.loads(script, strict=False)
Expand Down
42 changes: 42 additions & 0 deletions tests/test_jsonld.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,45 @@ def test_empty_jsonld_script(self):
body = '<script type="application/ld+json"> \n\n </script>'
data = jsonlde.extract(body)
self.assertEqual(data, [])

def test_jsonld_with_html_entities(self):
"""HTML-encoded JSON-LD (e.g. &quot; instead of ") is parsed correctly.

Some sites incorrectly escape script content as HTML, producing JSON-LD
with named entities (&quot;, &amp;) or numeric references (&#34;).
See https://github.com/scrapinghub/extruct/issues/208
"""
jsonlde = JsonLdExtractor()

# Named entity &quot; for double-quotes
body_named = (
b'<html><body>'
b'<script type="application/ld+json">'
b'{&quot;@context&quot;:&quot;http://schema.org/&quot;,'
b'&quot;@type&quot;:&quot;Product&quot;,'
b'&quot;name&quot;:&quot;My Product&quot;}'
b'</script></body></html>'
)
data = jsonlde.extract(body_named)
self.assertEqual(data, [{"@context": "http://schema.org/", "@type": "Product", "name": "My Product"}])

# Numeric entity &#34; for double-quotes
body_numeric = (
b'<html><body>'
b'<script type="application/ld+json">'
b'{&#34;@context&#34;:&#34;http://schema.org/&#34;,'
b'&#34;@type&#34;:&#34;WebPage&#34;}'
b'</script></body></html>'
)
data = jsonlde.extract(body_numeric)
self.assertEqual(data, [{"@context": "http://schema.org/", "@type": "WebPage"}])

# &amp; in a value is unescaped to &
body_amp = (
b'<html><body>'
b'<script type="application/ld+json">'
b'{"@context":"http://schema.org/","@type":"Organization","name":"Foo &amp; Bar"}'
b'</script></body></html>'
)
data = jsonlde.extract(body_amp)
self.assertEqual(data, [{"@context": "http://schema.org/", "@type": "Organization", "name": "Foo & Bar"}])