mirror of
https://github.com/python/cpython.git
synced 2025-08-04 17:08:35 +00:00
[3.12] gh-46236: Add docs for PyUnicode_GetDefaultEncoding() doc (GH-130335) (GH-130512)
* Clarify sys.getdefaultencoding() documentation
* Add missing documentation for PyUnicode_GetDefaultEncoding,
the C equivalent of sys.getdefaultencoding
(cherry picked from commit 9f25c1f012
)
Co-authored-by: RUANG (James Roy) <longjinyii@outlook.com>
This commit is contained in:
parent
3c20e8bc3a
commit
e38cded312
3 changed files with 14 additions and 2 deletions
|
@ -591,6 +591,15 @@ APIs:
|
|||
decref'ing the returned objects.
|
||||
|
||||
|
||||
.. c:function:: const char* PyUnicode_GetDefaultEncoding(void)
|
||||
|
||||
Return the name of the default string encoding, ``"utf-8"``.
|
||||
See :func:`sys.getdefaultencoding`.
|
||||
|
||||
The returned string does not need to be freed, and is valid
|
||||
until interpreter shutdown.
|
||||
|
||||
|
||||
.. c:function:: Py_ssize_t PyUnicode_GetLength(PyObject *unicode)
|
||||
|
||||
Return the length of the Unicode object, in code points.
|
||||
|
|
|
@ -2755,6 +2755,9 @@ PyUnicode_FromFormatV:PyObject*::+1:
|
|||
PyUnicode_FromFormatV:const char*:format::
|
||||
PyUnicode_FromFormatV:va_list:args::
|
||||
|
||||
PyUnicode_GetDefaultEncoding:const char*:::
|
||||
PyUnicode_GetDefaultEncoding::void::
|
||||
|
||||
PyUnicode_GetLength:Py_ssize_t:::
|
||||
PyUnicode_GetLength:PyObject*:unicode:0:
|
||||
|
||||
|
|
|
@ -751,8 +751,8 @@ always available. Unless explicitly noted otherwise, all variables are read-only
|
|||
|
||||
.. function:: getdefaultencoding()
|
||||
|
||||
Return the name of the current default string encoding used by the Unicode
|
||||
implementation.
|
||||
Return ``'utf-8'``. This is the name of the default string encoding, used
|
||||
in methods like :meth:`str.encode`.
|
||||
|
||||
|
||||
.. function:: getdlopenflags()
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue