[issue11173] Undocumented public APIs in Python 3.2

New submission from Marc-Andre Lemburg mal@egenix.com:
Mark Shannon on python-dev:
The following API functions were removed from 3.1.3:
PyAST_Compile PyCObject_AsVoidPtr PyCObject_FromVoidPtr PyCObject_FromVoidPtrAndDesc PyCObject_GetDesc PyCObject_Import PyCObject_SetVoidPtr PyCode_CheckLineNumber Py_CompileStringFlags PyEval_CallObject PyOS_ascii_atof PyOS_ascii_formatd PyOS_ascii_strtod PyThread_exit_prog PyThread__PyThread_exit_prog PyThread__PyThread_exit_thread PyUnicode_SetDefaultEncoding
And the following were added to 3.2, of which only 2 are documented:
PyArg_ValidateKeywordArguments PyAST_CompileEx Py_CompileString Py_CompileStringExFlags PyErr_NewExceptionWithDoc (documented) PyErr_SyntaxLocationEx PyErr_WarnFormat PyFrame_GetLineNumber PyImport_ExecCodeModuleWithPathnames PyImport_GetMagicTag PyLong_AsLongLongAndOverflow (documented) PyModule_GetFilenameObject Py_SetPath PyStructSequence_GetItem PyStructSequence_NewType PyStructSequence_SetItem PySys_AddWarnOptionUnicode PySys_AddXOption PySys_FormatStderr PySys_FormatStdout PySys_GetXOptions PyThread_acquire_lock_timed PyType_FromSpec PyUnicode_AsUnicodeCopy PyUnicode_AsWideCharString PyUnicode_EncodeFSDefault PyUnicode_FSDecoder Py_UNICODE_strcat Py_UNICODE_strncmp Py_UNICODE_strrchr PyUnicode_TransformDecimalToASCII
For added confusion PySys_SetArgvEx is documented as new in 3.2, but exists in 3.1.3
Note that this only include functions. The API also includes a number of macros such as Py_False and Py_RETURN_FALSE, types , and data like PyBool_Type.
---------- assignee: docs@python components: Documentation messages: 128294 nosy: docs@python, lemburg priority: normal severity: normal status: open title: Undocumented public APIs in Python 3.2 versions: Python 3.2
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11173 _______________________________________

Changes by Eli Bendersky eliben@gmail.com:
---------- nosy: +eli.bendersky
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11173 _______________________________________

STINNER Victor victor.stinner@haypocalc.com added the comment:
PyErr_WarnFormat
is already documented in Doc/c-api/exceptions.rst
PyImport_ExecCodeModuleWithPathnames
is already documented in Doc/c-api/import.rst
PyModule_GetFilenameObject
is already documented in Doc/c-api/module.rst
PySys_AddWarnOptionUnicode, PySys_FormatStderr and PySys_FormatStdout
are already documented in Doc/c-api/sys.rst
PyUnicode_AsUnicodeCopy, PyUnicode_AsWideCharString, PyUnicode_EncodeFSDefault and PyUnicode_FSDecoder
are already documented in Doc/c-api/unicode.rst
Mark Shannon should read the documentation more carefuly.
---------- nosy: +haypo
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11173 _______________________________________

STINNER Victor victor.stinner@haypocalc.com added the comment:
Py_UNICODE_strcat, Py_UNICODE_strncmp, Py_UNICODE_strrchr
See issue #10435 (with a patch) for these functions.
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11173 _______________________________________

Antoine Pitrou pitrou@free.fr added the comment:
PyThread_acquire_lock_timed
It's on purpose that I didn't document this one. I'm not sure the PyThread_ APIs should be used by third-party extensions; so I'd prefer to hear about potential users before starting documenting it (and being tied by compatibility issues).
---------- nosy: +pitrou
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11173 _______________________________________

Georg Brandl georg@python.org added the comment:
In fact, most of the functions are documented. (Mark S. apparently referred to the "What's new" document when talking about "documented" functions.)
Missing are:
PyAST_CompileEx (because PyAST_Compile wasn't documented either) PyStructSequence_* PyType_FromSpec
and the PyThread one which Antoine already mentioned.
---------- nosy: +georg.brandl
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11173 _______________________________________

Changes by Eli Bendersky eliben@gmail.com:
---------- nosy: -eli.bendersky
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11173 _______________________________________

Marc-Andre Lemburg added the comment:
PyEval_CallObject wasn't removed. It's a macro now. And it was documented for a long time in Extending Python... in fact, the documentation was removed, not the API :-)
----------
_______________________________________ Python tracker report@bugs.python.org http://bugs.python.org/issue11173 _______________________________________
participants (5)
-
Antoine Pitrou
-
Eli Bendersky
-
Georg Brandl
-
Marc-Andre Lemburg
-
STINNER Victor