implement format_map

pallets · Jun 2, 2023 · 391aa07 · 391aa07
1 parent 60e7eb9
commit 391aa07
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 0 deletions.
diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,6 +4,7 @@ Version 2.1.3
 Unreleased
 
 -   Fix static typing for basic ``str`` methods on ``Markup``. :issue:`358`
+-   Implement ``format_map`` method. :issue:`370`
 
 
 Version 2.1.2

diff --git a/src/markupsafe/__init__.py b/src/markupsafe/__init__.py
@@ -208,6 +208,10 @@ def format(self, *args: t.Any, **kwargs: t.Any) -> "Markup":
         formatter = EscapeFormatter(self.escape)
         return self.__class__(formatter.vformat(self, args, kwargs))
 
+    def format_map(self, map: t.Mapping[str, t.Any]) -> str:  # type: ignore[override]
+        formatter = EscapeFormatter(self.escape)
+        return self.__class__(formatter.vformat(self, (), map))
+
     def __html_format__(self, format_spec: str) -> "Markup":
         if format_spec:
             raise ValueError("Unsupported format specification for Markup.")

diff --git a/tests/test_markupsafe.py b/tests/test_markupsafe.py
@@ -108,6 +108,11 @@ def test_format():
     assert result == "<bar/>"
 
 
+def test_format_map():
+    result = Markup("<em>{value}</em>").format_map({"value": "<value>"})
+    assert result == "<em>&lt;value&gt;</em>"
+
+
 def test_formatting_empty():
     formatted = Markup("{}").format(0)
     assert formatted == Markup("0")