Merge pull request matplotlib#17684 from anntzer/unbytes

jkseppan · jkseppan · commit 4f02c737d499 · 2020-08-04T12:57:02.000+03:00
Deprecate passing bytes to FT2Font.set_text.
diff --git a/doc/api/next_api_changes/deprecations/17684-AL.rst b/doc/api/next_api_changes/deprecations/17684-AL.rst
@@ -0,0 +1,3 @@
+Passing `bytes` to ``FT2Font.set_text``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... is deprecated, pass `str` instead.
diff --git a/src/ft2font_wrapper.cpp b/src/ft2font_wrapper.cpp
@@ -648,6 +648,13 @@ static PyObject *PyFT2Font_set_text(PyFT2Font *self, PyObject *args, PyObject *k
         }
 #endif
     } else if (PyBytes_Check(textobj)) {
+        if (PyErr_WarnEx(
+            PyExc_FutureWarning,
+            "Passing bytes to FTFont.set_text is deprecated since Matplotlib "
+            "3.4 and support will be removed in Matplotlib 3.6; pass str instead",
+            1)) {
+            return NULL;
+        }
         size = PyBytes_Size(textobj);
         codepoints.resize(size);
         char *bytestr = PyBytes_AsString(textobj);

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+Passing `bytes` to ``FT2Font.set_text``
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	+... is deprecated, pass `str` instead.