Skip to content

Fix to_json escape #2310

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

Merged
tomkralidis merged 2 commits into from
Mar 31, 2026
+14 −5
Merged

Fix to_json escape #2310

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ab5d5a6
Fix to_json escape
webb-ben Mar 31, 2026
c80bc69
Fix flake8
webb-ben Mar 31, 2026
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
5 changes: 3 additions & 2 deletions pygeoapi/util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,8 +265,9 @@ def to_json(dict_: dict, pretty: bool = False) -> str:
json_dump = json.dumps(dict_, default=json_serial, indent=indent,
separators=(',', ':'))

LOGGER.debug('Removing < and >')
json_dump = json_dump.replace('<', '&lt').replace('>', '&gt')
LOGGER.debug('Escaping < and >')
json_dump = json_dump.replace('<', '&lt;')
json_dump = json_dump.replace('>', '&gt;')

return json_dump

Expand Down
14 changes: 11 additions & 3 deletions tests/other/test_util.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from io import StringIO
from unittest import mock
import uuid
from xml.sax.saxutils import unescape

import pytest

Expand Down Expand Up @@ -77,13 +78,20 @@ def test_get_typed_value():
@pytest.mark.parametrize('data,minified,pretty_printed', [
[{'foo': 'bar'}, '{"foo":"bar"}', '{\n "foo":"bar"\n}'],
[{'foo<script>alert("hi")</script>': 'bar'},
'{"foo&ltscript&gtalert(\\"hi\\")&lt/script&gt":"bar"}',
'{\n "foo&ltscript&gtalert(\\"hi\\")&lt/script&gt":"bar"\n}']
'{"foo&lt;script&gt;alert(\\"hi\\")&lt;/script&gt;":"bar"}',
'{\n "foo&lt;script&gt;alert(\\"hi\\")&lt;/script&gt;":"bar"\n}']
])
def test_to_json(data, minified, pretty_printed):
assert util.to_json(data) == minified
output = util.to_json(data)
assert output == minified
assert util.to_json(data, pretty=True) == pretty_printed

unescaped_output = unescape(output)
if '&lt;' in output:
assert '<' in unescaped_output
if '&gt;' in output:
assert '>' in unescaped_output


def test_yaml_load(config):
assert isinstance(config, dict)
Expand Down
Loading