Skip to content

fix: escape backslashes in popup text (fixes #1907) #2240

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
cycsmail wants to merge 1 commit into
base: main
Choose a base branch
from
+8 −7
Open

fix: escape backslashes in popup text (fixes #1907) #2240

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
5 changes: 2 additions & 3 deletions folium/utilities.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
import json
import math
import os
import re
import tempfile
import uuid
from collections.abc import Iterable, Iterator, Sequence
Expand Down Expand Up @@ -412,8 +411,8 @@ def remove_empty(**kwargs: TypeJsonValue) -> dict[str, TypeJsonValueNoNone]:


def escape_backticks(text: str) -> str:
"""Escape backticks so text can be used in a JS template."""
return re.sub(r"(?<!\\)`", r"\`", text)
"""Escape backslashes and backticks so text can be used in a JS template."""
return text.replace("\\", "\\\\").replace("`", "\\`")


def escape_double_quotes(text: str) -> str:
Expand Down
10 changes: 6 additions & 4 deletions tests/test_map.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,15 +234,17 @@ def test_popup_backticks():
assert normalize(rendered) == normalize(expected)


def test_popup_backticks_already_escaped():
def test_popup_backslashes():
m = Map()
popup = Popup("back\\`tick").add_to(m)
# A backslash followed by a digit would become an illegal octal escape
# sequence inside the JS template literal if it is not escaped, see #1907.
popup = Popup("C:\\path\\20190221").add_to(m)
rendered = popup._template.render(this=popup, kwargs={})
expected = """
expected = r"""
var {popup_name} = L.popup({{
"maxWidth": "100%",
}});
var {html_name} = $(`<div id="{html_name}" style="width: 100.0%; height: 100.0%;">back\\`tick</div>`)[0];
var {html_name} = $(`<div id="{html_name}" style="width: 100.0%; height: 100.0%;">C:\\path\\20190221</div>`)[0];
{popup_name}.setContent({html_name});
{map_name}.bindPopup({popup_name});
""".format(
Expand Down