cpython-lru_cache-weakref: Doc/api/api.tex history

[Patch #1490989 from Skip Montanaro] Mention debugging builds in the API documentation. I've changed Skip's patch to point to Misc/SpecialBuilds and fiddled with the markup a bit.

Sat, 29 Jul 2006 19:24:04 +0000

[Patch #1490989 from Skip Montanaro] Mention debugging builds in the API documentation. I've changed Skip's patch to point to Misc/SpecialBuilds and fiddled with the markup a bit.

Break the Python/C API manual into smaller files by chapter. This manual

Fri, 12 Oct 2001 19:01:43 +0000

Break the Python/C API manual into smaller files by chapter. This manual
has grown beyond what font-lock will work with using the default (X)Emacs
settings.

Indentation of the description has been made consistent, and a number of
smaller markup adjustments have been made as well.

Add documentation for the public API for weak reference objects.

Fri, 05 Oct 2001 22:03:58 +0000

Add documentation for the public API for weak reference objects.

Expand the documentation of the low-level tracing/profiling interface.

Wed, 03 Oct 2001 21:52:51 +0000

Expand the documentation of the low-level tracing/profiling interface.
This reflects what is currently in CVS, which may change before 2.2 is final.

Typo fix.

Wed, 26 Sep 2001 18:12:49 +0000

Typo fix.

Add more signature information and some descriptions for the new APIs

Mon, 24 Sep 2001 15:31:50 +0000

Add more signature information and some descriptions for the new APIs
introduced in Python 2.2.
Add documentation for the slice object interface (not complete).
Added version annotations for several of the Python 2.2 APIs already
documented.

Added API information for the PyCallIter_() and PySeqIter_() functions.

Sun, 23 Sep 2001 02:05:26 +0000

Added API information for the PyCallIter_*() and PySeqIter_*() functions.
Added signatures for some new PyType_*() functions.

Document all the Py*_CheckExact() functions.

Thu, 20 Sep 2001 19:18:52 +0000

Document all the Py*_CheckExact() functions.
Document many more of the PyLong_{As,From}*() functions.

Document the PyMethod_* type object, functions, and macros.

Thu, 06 Sep 2001 17:12:44 +0000

Document the PyMethod_* type object, functions, and macros.

Document the rule that Python.h must be included before any standard

Thu, 06 Sep 2001 16:30:30 +0000

Document the rule that Python.h must be included before any standard
headers. This is the final checkin for SF bug #458768.

Patch #449815: Set filesystemencoding based on CODESET.

Wed, 05 Sep 2001 17:09:48 +0000

Patch #449815: Set filesystemencoding based on CODESET.

At Guido's suggestion, here's a new C API function, PyObject_Dir(), like

Tue, 04 Sep 2001 22:08:56 +0000

At Guido's suggestion, here's a new C API function, PyObject_Dir(), like
__builtin__.dir(). Moved the guts from bltinmodule.c to object.c.

Update documentation for GC API. Closes SF patch #421893.

Thu, 30 Aug 2001 15:24:17 +0000

Update documentation for GC API. Closes SF patch #421893.

Documentation for PyString_FromFormat() and PyString_FromFormatV().

Tue, 28 Aug 2001 02:31:28 +0000

Documentation for PyString_FromFormat() and PyString_FromFormatV().
Closes SF patch #455666.

Document PyTuple_GET_SIZE(), removing confusing sentence from PyDict_Copy()

Mon, 20 Aug 2001 16:48:59 +0000

Document PyTuple_GET_SIZE(), removing confusing sentence from PyDict_Copy()
description.

This fixes SF bug #453111.

Patch #427190: Implement and use METH_NOARGS and METH_O.

Thu, 16 Aug 2001 13:15:00 +0000

Patch #427190: Implement and use METH_NOARGS and METH_O.

Add "exceptions" to the list of fundamental modules

Tue, 14 Aug 2001 15:32:16 +0000

Add "exceptions" to the list of fundamental modules
created by Py_Initialize().

This closes SF bug #450621.

Added documentation for PyDict_Update() and PyDict_Merge().

Fri, 10 Aug 2001 21:31:12 +0000

Added documentation for PyDict_Update() and PyDict_Merge().

Remove the bogus flags parameter from the PyFile_WriteString() signature;

Fri, 10 Aug 2001 14:27:38 +0000

Remove the bogus flags parameter from the PyFile_WriteString() signature;
it has no such parameter.

This closes SF bug #449761.

Added documentation for PyNumber_FloorDivide(), PyNumber_TrueDivide(),

Wed, 08 Aug 2001 19:14:53 +0000

Added documentation for PyNumber_*FloorDivide(), PyNumber_*TrueDivide(),
PyInterpreterState_*Head(), PyInterpreterState_Next(), and
PyThreadState_Next().

Wrapped some long lines, added some others.

Move away from apply() to using extended call syntax for some example

Thu, 02 Aug 2001 18:00:28 +0000

Move away from apply() to using extended call syntax for some example
fragments when discussing equivalence of thhe C API to what a Python
programmer sees.

Added descriptions of PyEval_SetProfile() and PyEval_SetTrace().

Typo: PyArgs_ParseTuple --> PyArg_ParseTuple

Fri, 20 Jul 2001 20:56:11 +0000

Typo: PyArgs_ParseTuple --> PyArg_ParseTuple

Moved the PyArg_Parse*(), Py_BuildValue() functions to the Utilities
chapter, added a minimal description and reference to the Extending
manual for Py_BuildValue().

Adding what's done of the documentation for the new profiling &

Tue, 17 Jul 2001 19:48:30 +0000

Adding what's done of the documentation for the new profiling &
tracing interface. Incomplete, but better to check it in since I've
been including it in my updates.

Oops, one more caret.

Sat, 14 Jul 2001 03:05:53 +0000

Oops, one more caret.

Fix the markup of the caret charater in a couple of places; LaTeX's

Sat, 14 Jul 2001 03:01:48 +0000

Fix the markup of the caret charater in a couple of places; LaTeX's
special character bite us again. ;-(

This fixes SF bug #440911.

Move the section on concrete numeric objects before the section on

Wed, 11 Jul 2001 20:35:37 +0000

Move the section on concrete numeric objects before the section on
concrete sequence objects, since their API is simpler.

This is in response to a comment in SF bug #440037.

Document PyObject_New(), PyObject_NewVar(), PyObject_Init(),

Tue, 10 Jul 2001 16:10:08 +0000

Document PyObject_New(), PyObject_NewVar(), PyObject_Init(),
PyObject_InitVar(), PyObject_Del(), PyObject_NEW(),
PyObject_NEW_VAR(), and PyObject_DEL().

Add notes to PyMem_Malloc() and PyMem_New() about the memory buffers
not being initialized.

This fixes SF bug #439012.

Added explicit return value information for PyList_SetItem(),
PyDict_SetItem(), and PyDict_SetItemString(). Corrected return type
for PyList_SET_ITEM().

Fixed index entries in the descriptions of PyLong_AsLong() and
PyLong_AsUnignedLong().

This fixes the API manual portion of SF bug #440037.

Note that the headers properly declare everything as 'extern "C"' for
C++ users.

Document _Py_NoneStruct.

Added links to the Extending & Embedding manual for PyArg_ParseTuple()
and PyArg_ParseTupleAndKeywords().

Added note that PyArg_Parse() should not be used in new code.

Fix up a few style nits -- avoid "e.g." and "i.e." -- these make
translation more difficult, as well as reading the English more
difficult for non-native speakers.

Fix for SF bug #436525, reported by Greg Kochanski:

Mon, 09 Jul 2001 14:35:01 +0000

Fix for SF bug #436525, reported by Greg Kochanski:
The block/unblock thread macros are called 'Py_BLOCK_THREADS' and
'Py_UNBLOCK_THREADS', not 'Py_BEGIN_BLOCK_THREADS' and
'Py_BEGIN_UNBLOCK_THREADS'.

Move license information to a less annoying location in the document.

Wed, 20 Jun 2001 21:39:12 +0000

Move license information to a less annoying location in the document.

Add documentation for PyErr_SetFromErrnoWithFilename().

Explained more differences between PyList_SetItem() and PyList_SET_ITEM().

Sun, 03 Jun 2001 03:12:57 +0000

Explained more differences between PyList_SetItem() and PyList_SET_ITEM().
In particular, the affect on existing list content was not sufficiently
explained.

This closes SF bug #429554.

Users of PySequence_GET_FAST() should get the length of the sequence using

Tue, 29 May 2001 18:51:41 +0000

Users of PySequence_GET_FAST() should get the length of the sequence using
PySequence_Size(), not PyObject_Size(): the later considers the mapping
methods as well as the sequence methods, which is not needed here. Either
should be equally fast in this case, but PySequence_Size() offers a better
conceptual match.

Do not start API descriptions with "Does the same, but ..." -- actually

Tue, 29 May 2001 15:13:00 +0000

Do not start API descriptions with "Does the same, but ..." -- actually
state *which* other function the current one is like, even if the
descriptions are adjacent.

Revise the _PyTuple_Resize() description to reflect the removal of the
third parameter.

Add documentation for Py_Main() and PyThreadState_GetDict().

Mon, 21 May 2001 15:56:55 +0000

Add documentation for Py_Main() and PyThreadState_GetDict().

Typo: "that" --> "than"

Mon, 21 May 2001 15:03:35 +0000

Typo: "that" --> "than"
This closes SF bug #425320.

This patch changes the way the string .encode() method works slightly

Tue, 15 May 2001 12:00:02 +0000

This patch changes the way the string .encode() method works slightly
and introduces a new method .decode().

The major change is that strg.encode() will no longer try to convert
Unicode returns from the codec into a string, but instead pass along
the Unicode object as-is. The same is now true for all other codec
return types. The underlying C APIs were changed accordingly.

Note that even though this does have the potential of breaking
existing code, the chances are low since conversion from Unicode
previously took place using the default encoding which is normally
set to ASCII rendering this auto-conversion mechanism useless for
most Unicode encodings.

The good news is that you can now use .encode() and .decode() with
much greater ease and that the door was opened for better accessibility
of the builtin codecs.

As demonstration of the new feature, the patch includes a few new
codecs which allow string to string encoding and decoding (rot13,
hex, zip, uu, base64).

Written by Marc-Andre Lemburg. Copyright assigned to the PSF.

Hmm... better add a version annotation for the Iterator Protocol section.

Mon, 07 May 2001 17:47:07 +0000

Hmm... better add a version annotation for the Iterator Protocol section.

Added documentation for PyIter_Check() and PyIter_Next().

Mon, 07 May 2001 17:42:18 +0000

Added documentation for PyIter_Check() and PyIter_Next().

Wrapped a long line.

This patch originated from an idea by Martin v. Loewis who submitted a

Mon, 23 Apr 2001 14:44:21 +0000

This patch originated from an idea by Martin v. Loewis who submitted a
patch for sharing single character Unicode objects.

Martin's patch had to be reworked in a number of ways to take Unicode
resizing into consideration as well. Here's what the updated patch
implements:

* Single character Unicode strings in the Latin-1 range are shared
(not only ASCII chars as in Martin's original patch).

* The ASCII and Latin-1 codecs make use of this optimization,
providing a noticable speedup for single character strings. Most
Unicode methods can use the optimization as well (by virtue
of using PyUnicode_FromUnicode()).

* Some code cleanup was done (replacing memcpy with Py_UNICODE_COPY)

* The PyUnicode_Resize() can now also handle the case of resizing
unicode_empty which previously resulted in an error.

* Modified the internal API _PyUnicode_Resize() and
the public PyUnicode_Resize() API to handle references to
shared objects correctly. The _PyUnicode_Resize() signature
changed due to this.

* Callers of PyUnicode_FromUnicode() may now only modify the Unicode
object contents of the returned object in case they called the API
with NULL as content template.

Note that even though this patch passes the regression tests, there
may still be subtle bugs in the sharing code.

Add documentation for PyObject_RichCompare() and PyObject_RichCompareBool(),

Thu, 13 Jun 2002 11:53:54 +0000

Add documentation for PyObject_RichCompare() and PyObject_RichCompareBool(),
constributed by David Abrahams.
This closes SF patch #568081.

Document PyType_IS_GC().

Wed, 10 Apr 2002 18:16:32 +0000

Document PyType_IS_GC().
Update description of PyType_Check().

Add the PyObject_As*Buffer() functions that apply, now that the docs have been

Thu, 04 Apr 2002 04:21:23 +0000

Add the PyObject_As*Buffer() functions that apply, now that the docs have been
corrected and I'm dealing with them anyway.

Add a note that Py_None needs the same reference count treatment as any

Tue, 12 Mar 2002 20:18:01 +0000

Add a note that Py_None needs the same reference count treatment as any
other PyObject *.
This closes SF bug #494007.

Document that PyString_FromString() cannot take NULL as a parameter.

Thu, 06 Dec 2001 20:38:15 +0000

Document that PyString_FromString() cannot take NULL as a parameter.
This closes SF bug #489872.

Fix the markup of the caret charater in a couple of places; LaTeX's

Sat, 14 Jul 2001 03:07:55 +0000

Fix the markup of the caret charater in a couple of places; LaTeX's
special character bite us again. ;-(

This fixes SF bug #440911.

Move the section on concrete numeric objects before the section on

Wed, 11 Jul 2001 20:40:05 +0000

Move the section on concrete numeric objects before the section on
concrete sequence objects, since their API is simpler.

This is in response to a comment in SF bug #440037.

(Does this really belong in the bugfix release? Yes: this is a readability
bug, and those are important in the documentation.)

Document PyObject_New(), PyObject_NewVar(), PyObject_Init(),

Tue, 10 Jul 2001 16:11:09 +0000

Fix for SF bug #436525, reported by Greg Kochanski:

Mon, 09 Jul 2001 14:34:16 +0000

Added documentation for PyErr_SetFromErrnoWithFilename().

Thu, 21 Jun 2001 18:56:49 +0000

Added documentation for PyErr_SetFromErrnoWithFilename().

Adjust the documents so that the copyright is at the front of the documents

Thu, 21 Jun 2001 18:52:50 +0000

Adjust the documents so that the copyright is at the front of the documents
and the license statements are at the end. This is less annoying to readers.

Explained more differences between PyList_SetItem() and PyList_SET_ITEM().

Sun, 03 Jun 2001 03:16:04 +0000

Explained more differences between PyList_SetItem() and PyList_SET_ITEM().
In particular, the affect on existing list content was not sufficiently
explained.

This closes SF bug #429554.

Users of PySequence_GET_FAST() should get the length of the sequence using

Tue, 29 May 2001 18:53:11 +0000

Add documentation for Py_Main() and PyThreadState_GetDict().

Mon, 21 May 2001 15:58:54 +0000

Add documentation for Py_Main() and PyThreadState_GetDict().

Typo: "that" --> "than"

Mon, 21 May 2001 15:04:28 +0000

Typo: "that" --> "than"
This closes SF bug #425320.

Michael Hudson:

Fri, 13 Apr 2001 17:55:02 +0000

Michael Hudson:
Update docs for PyDict_Next() based on the most recent changes to the
dictionary code.

This closes SF patch #409864.

Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.

Fri, 13 Apr 2001 14:52:39 +0000

Work around the conversion of ">>" and "<<" to guillemets. Reported by Ping.

Correct the documentation for getreadbufferproc and getwritebufferproc.

Sat, 07 Apr 2001 16:14:49 +0000

Correct the documentation for getreadbufferproc and getwritebufferproc.

Fixes bug #233308 from Travis Oliphant.

Document PySequence_Size(), and describe PySequence_Length() as simply an

Wed, 04 Apr 2001 01:25:17 +0000

Document PySequence_Size(), and describe PySequence_Length() as simply an
alternate name for the same function.

Added documentation for PyObject_IsInstance() and PyObject_IsSubclass().

Wed, 28 Mar 2001 21:14:32 +0000

Added documentation for PyObject_IsInstance() and PyObject_IsSubclass().

Strengthen the constraints on calling PyObject_GC_Fini().

Fri, 23 Mar 2001 17:42:09 +0000

Strengthen the constraints on calling PyObject_GC_Fini().

Be more clear about the specific rules for supporting the cyclic GC in an

Thu, 22 Mar 2001 16:30:17 +0000

Be more clear about the specific rules for supporting the cyclic GC in an
extension object. Also included an example showing exactly what needs to
be done and nothing else.

This closes SF bug #228591.