bpo-21071: struct.Struct.format type is now str (#845)

vstinner · web-flow · commit f87b85f80853 · 2017-06-23T15:11:12.000+02:00
diff --git a/Doc/library/struct.rst b/Doc/library/struct.rst
@@ -443,6 +443,9 @@ The :mod:`struct` module also defines the following type:
 
       The format string used to construct this Struct object.
 
+      .. versionchanged:: 3.7
+         The format string type is now :class:`str` instead of :class:`bytes`.
+
    .. attribute:: size
 
       The calculated size of the struct (and hence of the bytes object produced
diff --git a/Doc/whatsnew/3.7.rst b/Doc/whatsnew/3.7.rst
@@ -429,6 +429,9 @@ Changes in the Python API
   ``makedirs()``.
   (Contributed by Serhiy Storchaka in :issue:`19930`.)
 
+* The :attr:`struct.Struct.format` type is now :class:`str` instead of
+  :class:`bytes`. (Contributed by Victor Stinner in :issue:`21071`.)
+
 
 CPython bytecode changes
 ------------------------
diff --git a/Lib/test/test_struct.py b/Lib/test/test_struct.py
@@ -618,6 +618,14 @@ def test_issue29802(self):
         # Shouldn't crash.
         self.assertEqual(struct.unpack(b'b', b'a'), (b'a'[0],))
 
+    def test_format_attr(self):
+        s = struct.Struct('=i2H')
+        self.assertEqual(s.format, '=i2H')
+
+        # use a bytes string
+        s2 = struct.Struct(s.format.encode())
+        self.assertEqual(s2.format, s.format)
+
 
 class UnpackIteratorTest(unittest.TestCase):
     """
diff --git a/Misc/NEWS b/Misc/NEWS
@@ -374,6 +374,9 @@ Extension Modules
 Library
 -------
 
+- bpo-21071: struct.Struct.format type is now :class:`str` instead of
+  :class:`bytes`.
+
 - bpo-29212: Fix concurrent.futures.thread.ThreadPoolExecutor threads to have
   a non repr() based thread name by default when no thread_name_prefix is
   supplied.  They will now identify themselves as "ThreadPoolExecutor-y_n".
diff --git a/Modules/_struct.c b/Modules/_struct.c
@@ -1957,8 +1957,8 @@ s_pack_into(PyObject *self, PyObject **args, Py_ssize_t nargs, PyObject *kwnames
 static PyObject *
 s_get_format(PyStructObject *self, void *unused)
 {
-    Py_INCREF(self->s_format);
-    return self->s_format;
+    return PyUnicode_FromStringAndSize(PyBytes_AS_STRING(self->s_format),
+                                       PyBytes_GET_SIZE(self->s_format));
 }
 
 static PyObject *

Original file line number	Diff line number	Diff line change
`@@ -1957,8 +1957,8 @@ s_pack_into(PyObject self, PyObject args, Py_ssize_t nargs, PyObject kwnames`
`1957`	`1957`	`static PyObject *`
`1958`	`1958`	`s_get_format(PyStructObject self, void unused)`
`1959`	`1959`	`{`
`1960`		`- Py_INCREF(self->s_format);`
`1961`		`- return self->s_format;`
	`1960`	`+ return PyUnicode_FromStringAndSize(PyBytes_AS_STRING(self->s_format),`
	`1961`	`+ PyBytes_GET_SIZE(self->s_format));`
`1962`	`1962`	`}`
`1963`	`1963`
`1964`	`1964`	`static PyObject *`