Add PyUnicodeWriter_WriteASCII() (#145)

vstinner · web-flow · commit ffae0ffa2a3f · 2025-06-09T14:50:50.000+02:00
diff --git a/docs/api.rst b/docs/api.rst
@@ -136,6 +136,10 @@ Python 3.14
 
    See `PyUnicodeWriter_WriteUTF8() documentation <https://docs.python.org/dev/c-api/unicode.html#c.PyUnicodeWriter_WriteUTF8>`__.
 
+.. c:function:: int PyUnicodeWriter_WriteASCII(PyUnicodeWriter *writer, const char *str, Py_ssize_t size)
+
+   See `PyUnicodeWriter_WriteASCII() documentation <https://docs.python.org/dev/c-api/unicode.html#c.PyUnicodeWriter_WriteASCII>`__.
+
 .. c:function:: int PyUnicodeWriter_WriteWideChar(PyUnicodeWriter *writer, const wchar_t *str, Py_ssize_t size)
 
    See `PyUnicodeWriter_WriteWideChar() documentation <https://docs.python.org/dev/c-api/unicode.html#c.PyUnicodeWriter_WriteWideChar>`__.
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,6 +1,7 @@
 Changelog
 =========
 
+* 2025-06-09: Add ``PyUnicodeWriter_WriteASCII()`` function.
 * 2025-06-03: Add functions:
 
   * ``PySys_GetAttr()``
diff --git a/pythoncapi_compat.h b/pythoncapi_compat.h
@@ -1456,6 +1456,18 @@ PyUnicodeWriter_WriteUTF8(PyUnicodeWriter *writer,
     return res;
 }
 
+static inline int
+PyUnicodeWriter_WriteASCII(PyUnicodeWriter *writer,
+                           const char *str, Py_ssize_t size)
+{
+    if (size < 0) {
+        size = (Py_ssize_t)strlen(str);
+    }
+
+    return _PyUnicodeWriter_WriteASCIIString((_PyUnicodeWriter*)writer,
+                                             str, size);
+}
+
 static inline int
 PyUnicodeWriter_WriteWideChar(PyUnicodeWriter *writer,
                               const wchar_t *str, Py_ssize_t size)
diff --git a/tests/test_pythoncapi_compat_cext.c b/tests/test_pythoncapi_compat_cext.c
@@ -1847,6 +1847,11 @@ test_unicodewriter(PyObject *Py_UNUSED(self), PyObject *Py_UNUSED(args))
         goto error;
     }
 
+    // test PyUnicodeWriter_WriteASCII()
+    if (PyUnicodeWriter_WriteASCII(writer, " non-ASCII", -1) < 0) {
+        goto error;
+    }
+
     // test PyUnicodeWriter_WriteUTF8()
     if (PyUnicodeWriter_WriteUTF8(writer, " valu\xC3\xA9", -1) < 0) {
         goto error;
@@ -1870,7 +1875,7 @@ test_unicodewriter(PyObject *Py_UNUSED(self), PyObject *Py_UNUSED(args))
         if (result == NULL) {
             return NULL;
         }
-        assert(PyUnicode_EqualToUTF8(result, "var=long valu\xC3\xA9 'repr'"));
+        assert(PyUnicode_EqualToUTF8(result, "var=long non-ASCII valu\xC3\xA9 'repr'"));
         Py_DECREF(result);
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1847,6 +1847,11 @@ test_unicodewriter(PyObject Py_UNUSED(self), PyObject Py_UNUSED(args))`
`1847`	`1847`	`goto error;`
`1848`	`1848`	`}`
`1849`	`1849`
	`1850`	`+ // test PyUnicodeWriter_WriteASCII()`
	`1851`	`+ if (PyUnicodeWriter_WriteASCII(writer, " non-ASCII", -1) < 0) {`
	`1852`	`+ goto error;`
	`1853`	`+ }`
	`1854`	`+`
`1850`	`1855`	`// test PyUnicodeWriter_WriteUTF8()`
`1851`	`1856`	`if (PyUnicodeWriter_WriteUTF8(writer, " valu\xC3\xA9", -1) < 0) {`
`1852`	`1857`	`goto error;`
`@@ -1870,7 +1875,7 @@ test_unicodewriter(PyObject Py_UNUSED(self), PyObject Py_UNUSED(args))`
`1870`	`1875`	`if (result == NULL) {`
`1871`	`1876`	`return NULL;`
`1872`	`1877`	`}`
`1873`		`- assert(PyUnicode_EqualToUTF8(result, "var=long valu\xC3\xA9 'repr'"));`
	`1878`	`+ assert(PyUnicode_EqualToUTF8(result, "var=long non-ASCII valu\xC3\xA9 'repr'"));`
`1874`	`1879`	`Py_DECREF(result);`
`1875`	`1880`	`}`
`1876`	`1881`