Stowage/cpython
2
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-30 21:21:22 +00:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
* Clarify sys.getdefaultencoding() documentation

* Add missing documentation for PyUnicode_GetDefaultEncoding,
  the C equivalent of sys.getdefaultencoding
This commit is contained in:
RUANG (James Roy) 2025-02-24 22:37:21 +08:00 • committed by GitHub
parent fc8d2cba54
commit 9f25c1f012
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 14 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

9
Doc/c-api/unicode.rst
View file

@ -607,6 +607,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.

3
Doc/data/refcounts.dat
View file

@ -2770,6 +2770,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:

4
Doc/library/sys.rst
View file

@ -771,8 +771,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()