Ok, here is something else. What about adding a PyUnicodeExport structure which holds 4 members and a strong reference to the Python str object?

#define PyUnicode_FORMAT_UCS1 0x01
#define PyUnicode_FORMAT_UCS2 0x02
#define PyUnicode_FORMAT_UCS4 0x04
#define PyUnicode_FORMAT_UTF8 0x08

typedef struct PyUnicodeExport {
    PyObject *obj;
    uint32_t format;
    const void *data;
    Py_ssize_t nbytes;
} PyUnicodeExport;

// Get the content of a string in the requested format:
// - Set '*unicode_export' and return 0 on success.
// - Set an exception and return -1 on error.
//
// The export must be released by PyUnicode_ReleaseExport().
PyAPI_FUNC(int) PyUnicode_Export(
    PyObject *unicode,
    uint32_t requested_formats,
    PyUnicodeExport *unicode_export);

// Release an export created by PyUnicode_Export().
PyAPI_FUNC(void) PyUnicode_ReleaseExport(
    PyUnicodeExport *unicode_export);

// Create a string object from a string in the format 'format'.
// - Return a reference to a new string object on success.
// - Set an exception and return NULL on error.
PyAPI_FUNC(PyObject*) PyUnicode_Import(
    const void *data,
    Py_ssize_t nbytes,
    uint32_t format);

UPDATE: I removed PyUnicode_FORMAT_ASCII, I don't think that it brings much value over PyUnicode_FORMAT_UCS1. And PyUnicode_IS_ASCII() can be used to check if a Python str is ASCII-only.

UPDATE: I renamed export to unicode_export since export name causes compilation errors on Windows (MSC compiler).

Example of usage:

    PyUnicodeExport unicode_export;
    if (PyUnicode_Export(obj, requested_formats, &unicode_export) < 0) {
        // handle error
    }
    // ... use unicode_export ...
    PyUnicode_ReleaseExport(&unicode_export);

PEP 756: Add PyUnicode_Export() and PyUnicode_Import() to the limited C API #33

Description

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions