Skip to content

Add parameters to JsCode #2123

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.

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
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
43 changes: 1 addition & 42 deletions folium/template.py
Original file line number Diff line number Diff line change
@@ -1,47 +1,6 @@
import json
from typing import Union

import jinja2
from branca.element import Element

from folium.utilities import JsCode, TypeJsonValue, camelize


def tojavascript(obj: Union[str, JsCode, dict, list, Element]) -> str:
if isinstance(obj, JsCode):
return obj.js_code
elif isinstance(obj, Element):
return obj.get_name()
elif isinstance(obj, dict):
out = ["{\n"]
for key, value in obj.items():
if isinstance(key, str):
out.append(f' "{camelize(key)}": ')
else:
out.append(f" {key}: ")
out.append(tojavascript(value))
out.append(",\n")
out.append("}")
return "".join(out)
elif isinstance(obj, list):
out = ["[\n"]
for value in obj:
out.append(tojavascript(value))
out.append(",\n")
out.append("]")
return "".join(out)
else:
return _to_escaped_json(obj)


def _to_escaped_json(obj: TypeJsonValue) -> str:
return (
json.dumps(obj)
.replace("<", "\\u003c")
.replace(">", "\\u003e")
.replace("&", "\\u0026")
.replace("'", "\\u0027")
)
from folium.utilities import tojavascript


class Environment(jinja2.Environment):
Expand Down
44 changes: 41 additions & 3 deletions folium/utilities.py
Original file line number Diff line number Diff line change
Expand Up @@ -441,16 +441,54 @@ def get_and_assert_figure_root(obj: Element) -> Figure:
class JsCode:
"""Wrapper around Javascript code."""

def __init__(self, js_code: Union[str, "JsCode"]):
def __init__(self, js_code: Union[str, "JsCode"], **kwargs):
args = {k: tojavascript(v) for k, v in kwargs.items()}
if isinstance(js_code, JsCode):
self.js_code: str = js_code.js_code
self.js_code: str = js_code.js_code % args
else:
self.js_code = js_code
self.js_code = js_code % args

def __str__(self):
return self.js_code


def tojavascript(obj: Union[str, JsCode, dict, list, Element]) -> str:
if isinstance(obj, JsCode):
return obj.js_code
elif isinstance(obj, Element):
return obj.get_name()
elif isinstance(obj, dict):
out = ["{\n"]
for key, value in obj.items():
if isinstance(key, str):
out.append(f' "{camelize(key)}": ')
else:
out.append(f" {key}: ")
out.append(tojavascript(value))
out.append(",\n")
out.append("}")
return "".join(out)
elif isinstance(obj, list):
out = ["[\n"]
for value in obj:
out.append(tojavascript(value))
out.append(",\n")
out.append("]")
return "".join(out)
else:
return _to_escaped_json(obj)


def _to_escaped_json(obj: TypeJsonValue) -> str:
return (
json.dumps(obj)
.replace("<", "\\u003c")
.replace(">", "\\u003e")
.replace("&", "\\u0026")
.replace("'", "\\u0027")
)


def parse_font_size(value: Union[str, int, float]) -> str:
"""Parse a font size value, if number set as px"""
if isinstance(value, (int, float)):
Expand Down
9 changes: 8 additions & 1 deletion tests/test_template.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
from branca.element import Element

from folium import JsCode
from folium.template import Environment, Template, _to_escaped_json, tojavascript
from folium.template import Environment, Template
from folium.utilities import _to_escaped_json, tojavascript


def test_tojavascript_with_jscode():
Expand Down Expand Up @@ -72,3 +73,9 @@ def test_environment_filter():

def test_template_environment_class():
assert Template.environment_class == Environment


def test_jscode_with_parameters():
element = Element()
js_code = JsCode("var element = %(element)s", element=element)
assert js_code.js_code == f"var element = {element.get_name()}"