Document PyUnicode_* API

@malemburg

BPO	1944
Nosy	@malemburg, @birkenfeld, @vstinner, @avassalotti, @berkerpeksag, @vadmium, @serhiy-storchaka, @shihai1991, @furkanonder
PRs	bpo-1944: wrap functions with macro #20011
Files	unicode.patch: docs for PyUnicodes C-API functions: FromFormat, FromFormatV, FromString, FromStringAndSize, Partition, RPartition and RSplit

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = None
closed_at = None
created_at = <Date 2008-01-27.06:26:42.019>
labels = ['type-feature', 'docs']
title = 'Document PyUnicode_* API'
updated_at = <Date 2020-06-21.12:39:22.129>
user = 'https://github.com/avassalotti'

bugs.python.org fields:

activity = <Date 2020-06-21.12:39:22.129>
actor = 'shihai1991'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2008-01-27.06:26:42.019>
creator = 'alexandre.vassalotti'
dependencies = []
files = ['13717']
hgrepos = []
issue_num = 1944
keywords = ['patch']
message_count = 9.0
messages = ['61734', '86116', '86121', '89100', '185552', '185725', '264571', '264575', '368582']
nosy_count = 11.0
nosy_names = ['lemburg', 'georg.brandl', 'vstinner', 'alexandre.vassalotti', 'donlorenzo', 'docs@python', 'berker.peksag', 'martin.panter', 'serhiy.storchaka', 'shihai1991', 'furkanonder']
pr_nums = ['20011']
priority = 'normal'
resolution = None
stage = 'patch review'
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue1944'
versions = ['Python 3.5', 'Python 3.6']

[edit @encukou]: Converting the lists below to checkboxes:

Linked PRs

PyUnicode_DecodeCodePageStateful

Following functions likely should be wrapped with "#ifndef Py_LIMITED_API":

_PyUnicode_ClearStaticStrings
_PyUnicode_EQ
_PyUnicode_FromId

"""
Following functions likely should be wrapped with "#ifndef Py_LIMITED_API":

_PyUnicode_ClearStaticStrings
_PyUnicode_EQ
_PyUnicode_FromId
"""

It's already the case since at least Python 3.7. Extract of Python 3.7 Include/unicodeobject.h:

#ifndef Py_LIMITED_API
/* Return an interned Unicode object for an Identifier; may fail if there is no memory.*/
PyAPI_FUNC(PyObject*) _PyUnicode_FromId(_Py_Identifier*);
/* Clear all static strings. */
PyAPI_FUNC(void) _PyUnicode_ClearStaticStrings(void);

/* Fast equality check when the inputs are known to be exact unicode types
   and where the hash values are equal (i.e. a very probable match) */
PyAPI_FUNC(int) _PyUnicode_EQ(PyObject *, PyObject *);
#endif /* !Py_LIMITED_API */

gh-46236: Document `PyUnicode_DecodeCodePageStateful` (GH-127934)

pythongh-46236: Document `PyUnicode_DecodeCodePageStateful` (pythonGH…

[3.13] gh-46236: Document `PyUnicode_DecodeCodePageStateful` (GH-127934…

[3.12] gh-46236: Document `PyUnicode_DecodeCodePageStateful` (GH-127934…

pythongh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and Py…

I have noticed that some tasks that have already been opened are not checked off. I believe we should select them.

gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and PyUnicod…

pythongh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and Py…

[3.13] gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and P…

[3.12] gh-46236: Document PyUnicode_RSplit, PyUnicode_Partition and P…

gh-46236: Add docs for PyUnicode_GetDefaultEncoding() doc (GH-130335)

pythongh-46236: Add docs for PyUnicode_GetDefaultEncoding() doc (pyth…

[3.13] gh-46236: Add docs for PyUnicode_GetDefaultEncoding() doc (GH-…

[3.12] gh-46236: Add docs for PyUnicode_GetDefaultEncoding() doc (GH-…

gh-46236: PyUnicode docs improvements (GH-129966)

gh-46236: Add missing PyUnicode_Append() doc (#130531)

@encukou

@encukou Let's remove the PyUnicode_GetMax entry, which was removed in Misc/NEWS.d/3.10.0a1.rst.

.. bpo: 41123
.. date: 2020-06-28-11-39-22
.. nonce: sjJWjQ
.. section: C API

Removed ``PyUnicode_GetMax()``.

Let's remove the PyUnicode_GetMax entry

I checked the checkbox :-)

gh-46236: Add missing PyUnicode_FromOrdinal() doc (#132040)

pythongh-46236: Add missing PyUnicode_FromOrdinal() doc (python#132040)

[3.13] gh-46236: Add missing PyUnicode_FromOrdinal() doc (#132040) (#…

PyUnicode_EncodeDecimal was removed in 3.11

gh-46236: Add PyUnicode_Resize() doc (#132628)

PyUnicode_AsDecodedObject, PyUnicode_AsDecodedUnicode, PyUnicode_AsEncodedUnicode, PyUnicode_AsEncodedObject are deprecated since 3.6 and should probably be removed by now, do we still want to document them?

cpython/Include/unicodeobject.h

Line 351 in 05d0559

Py_DEPRECATED(3.6) PyAPI_FUNC(PyObject*) PyUnicode_AsDecodedObject(

cpython/Include/unicodeobject.h

Line 364 in 05d0559

Py_DEPRECATED(3.6) PyAPI_FUNC(PyObject*) PyUnicode_AsDecodedUnicode(

cpython/Include/unicodeobject.h

Line 400 in 05d0559

Py_DEPRECATED(3.6) PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedUnicode(

cpython/Include/unicodeobject.h

Line 378 in 05d0559

Py_DEPRECATED(3.6) PyAPI_FUNC(PyObject*) PyUnicode_AsEncodedObject(

No, I don't think that it's worth it to document them if they are going to be removed.

gh-46236: Add Py_UNICODE_REPLACEMENT_CHARACTER doc (#132706)

PyUnicode_FromFormatV is documented.

No, I don't think that it's worth it to document them if they are going to be removed.

I agree, though they have been deprecated for many years but there is no planned removal date that I can find. Should we just remove them now?

I agree, though they have been deprecated for many years but there is no planned removal date that I can find. Should we just remove them now?

IMO now it's too late for the 3.14 release cycle. It would be better to schedule such removal at the start of a new dev cycle, such as Python 3.15. Someone also has to check if these functions are used in the wild (ex: run a code search).

@serhiy-storchaka

cc @serhiy-storchaka who originally deprecated them in 0093907

A new issue is probably best for this, scheduling for 3.15 seems good for now.

gh-46236: Document `PyUnicodeIter_Type` (GH-132925)

pythongh-46236: Document `PyUnicodeIter_Type` (pythonGH-132925)

[3.13] gh-46236: Document `PyUnicodeIter_Type` (GH-132925) (GH-133149)

The list needs to be updated, just PyUnicode_BuildEncodingMap is left.

gh-46236: Document PyUnicode_BuildEncodingMap (#133270)

pythongh-46236: Document PyUnicode_BuildEncodingMap (pythonGH-133270)

The list is complete. I close the issue. Thanks to everybody who was involved in this old issue (2008!).

[3.14] gh-46236: Document PyUnicode_BuildEncodingMap (GH-133270) (#13…

[3.13] gh-46236: Document PyUnicode_BuildEncodingMap (#133770)

pythongh-46236: Document PyUnicode_BuildEncodingMap (python#133270)

Navigation Menu

Repository navigation

Document PyUnicode_* API #46236

Linked PRs

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Document PyUnicode_* API #46236

Description

Linked PRs

Activity

serhiy-storchaka commented on Apr 30, 2016

vstinner commented on May 10, 2020

rruuaanng commented on Feb 20, 2025

rruuaanng commented on Apr 3, 2025

vstinner commented on Apr 3, 2025

StanFromIreland commented on Apr 18, 2025

StanFromIreland commented on Apr 22, 2025

vstinner commented on Apr 22, 2025

StanFromIreland commented on Apr 22, 2025

StanFromIreland commented on Apr 22, 2025

vstinner commented on Apr 22, 2025

StanFromIreland commented on Apr 22, 2025

StanFromIreland commented on May 1, 2025

vstinner commented on May 9, 2025

Metadata

Metadata

Assignees

Labels

Projects

Milestone

Relationships

Development

Issue actions