classification
Title: Undocumented public APIs in Python 3.2
Type: Stage:
Components: Documentation Versions: Python 3.2
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, georg.brandl, haypo, lemburg, pitrou
Priority: normal Keywords:

Created on 2011-02-10 15:19 by lemburg, last changed 2017-02-14 09:41 by lemburg.

Messages (6)
msg128294 - (view) Author: Marc-Andre Lemburg (lemburg) * (Python committer) Date: 2011-02-10 15:19
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.
msg128298 - (view) Author: STINNER Victor (haypo) * (Python committer) Date: 2011-02-10 15:42
> 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.
msg128299 - (view) Author: STINNER Victor (haypo) * (Python committer) Date: 2011-02-10 15:44
> Py_UNICODE_strcat, Py_UNICODE_strncmp, Py_UNICODE_strrchr

See issue #10435 (with a patch) for these functions.
msg128303 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2011-02-10 16:04
> 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).
msg128322 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2011-02-10 18:07
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.
msg287750 - (view) Author: Marc-Andre Lemburg (lemburg) * (Python committer) Date: 2017-02-14 09:41
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 :-)
History
Date User Action Args
2017-02-14 09:41:15lemburgsetmessages: + msg287750
2011-11-12 05:04:41eli.benderskysetnosy: - eli.bendersky
2011-02-10 18:07:06georg.brandlsetnosy: + georg.brandl
messages: + msg128322
2011-02-10 16:04:02pitrousetnosy: + pitrou
messages: + msg128303
2011-02-10 15:44:53hayposetnosy: lemburg, haypo, eli.bendersky, docs@python
messages: + msg128299
2011-02-10 15:42:46hayposetnosy: + haypo
messages: + msg128298
2011-02-10 15:34:06eli.benderskysetnosy: + eli.bendersky
2011-02-10 15:19:15lemburgcreate