Merge pull request #69 from dawran6/issue-68

Fix the return type of escape to Markup

CHANGES

@@ -1,6 +1,16 @@
 MarkupSafe Changelog
 ====================
 
+Version 1.1
+-----------
+
+unreleased
+
+- ``escape`` wraps ``__html__`` result in ``Markup``, consistent with
+  documented behavior. (`#69`_)
+
+.. _#69: https://github.com/pallets/markupsafe/pull/69
+
 Version 1.0
 -----------
 

markupsafe/_native.py

@@ -18,7 +18,7 @@ def escape(s):
     such characters in HTML.  Marks return value as markup string.
     """
     if hasattr(s, '__html__'):
-        return s.__html__()
+        return Markup(s.__html__())
     return Markup(text_type(s)
         .replace('&', '&')
         .replace('>', '>')

markupsafe/_speedups.c

@@ -131,8 +131,11 @@ escape(PyObject *self, PyObject *text)
 	/* if the object has an __html__ method that performs the escaping */
 	html = PyObject_GetAttrString(text, "__html__");
 	if (html) {
-		rv = PyObject_CallObject(html, NULL);
+		s = PyObject_CallObject(html, NULL);
 		Py_DECREF(html);
+		/* Convert to Markup object */
+		rv = PyObject_CallFunctionObjArgs(markup, (PyObject*)s, NULL);
+		Py_DECREF(s);
 		return rv;
 	}
 

tests.py

@@ -173,6 +173,14 @@ def test_splitting(self):
     def test_mul(self):
         self.assertEqual(Markup('a') * 3, Markup('aaa'))
 
+    def test_escape_return_type(self):
+        self.assertTrue(isinstance(escape('a'), Markup))
+        self.assertTrue(isinstance(escape(Markup('a')), Markup))
+        class Foo:
+            def __html__(self):
+                return '<strong>Foo</strong>'
+        self.assertTrue(isinstance(escape(Foo()), Markup))
+
 
 class MarkupLeakTestCase(unittest.TestCase):