summaryrefslogtreecommitdiffstats
path: root/Doc/api
Commit message (Collapse)AuthorAgeFilesLines
* Move the section on concrete numeric objects before the section onFred Drake2001-07-111-249/+249
| | | | | | | | | 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.)
* Corrected the refcount information for PyList_SET_ITEM().Fred Drake2001-07-101-1/+1
|
* Document PyObject_New(), PyObject_NewVar(), PyObject_Init(),Fred Drake2001-07-101-24/+97
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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:Thomas Wouters2001-07-091-2/+2
| | | | | | The block/unblock thread macros are called 'Py_BLOCK_THREADS' and 'Py_UNBLOCK_THREADS', not 'Py_BEGIN_BLOCK_THREADS' and 'Py_BEGIN_UNBLOCK_THREADS'.
* Added documentation for PyErr_SetFromErrnoWithFilename().Fred Drake2001-06-211-0/+10
|
* Adjust the documents so that the copyright is at the front of the documentsFred Drake2001-06-211-0/+3
| | | | and the license statements are at the end. This is less annoying to readers.
* Explained more differences between PyList_SetItem() and PyList_SET_ITEM().Fred Drake2001-06-031-2/+7
| | | | | | | 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 usingFred Drake2001-05-291-1/+1
| | | | | | | 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.
* Add documentation for Py_Main() and PyThreadState_GetDict().Fred Drake2001-05-211-0/+21
|
* Typo: "that" --> "than"Fred Drake2001-05-211-1/+1
| | | | This closes SF bug #425320.
* Michael Hudson:Fred Drake2001-04-131-1/+23
| | | | | | | 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.Fred Drake2001-04-131-4/+4
|
* Correct the documentation for getreadbufferproc and getwritebufferproc.Greg Stein2001-04-071-5/+6
| | | | Fixes bug #233308 from Travis Oliphant.
* Document PySequence_Size(), and describe PySequence_Length() as simply anFred Drake2001-04-041-1/+5
| | | | alternate name for the same function.
* Added documentation for PyObject_IsInstance() and PyObject_IsSubclass().Fred Drake2001-03-281-0/+36
|
* Strengthen the constraints on calling PyObject_GC_Fini().Fred Drake2001-03-231-0/+5
|
* Be more clear about the specific rules for supporting the cyclic GC in anFred Drake2001-03-221-4/+126
| | | | | | | extension object. Also included an example showing exactly what needs to be done and nothing else. This closes SF bug #228591.
* Integrated an expanded version of some text from Neil Schemenauer aboutFred Drake2001-03-211-3/+85
| | | | | | | supporting cyclic garbage collection. (This is not all of it, but I'm taking a break!) Also fixed some markup nits.
* Finally fill in the documentation for the PyDict_Next() function. It isFred Drake2001-03-161-2/+20
| | | | | | different enough to actually require an explanation. ;-) Fix a couple of PyDictObject* types that should be PyObject* types.
* Document PyErr_WarnExplicit().Guido van Rossum2001-02-281-0/+9
|
* PyTuple_*() functions take PyObject* parameters, not PyTupleObject* values.Fred Drake2001-02-121-7/+6
| | | | This closes SF bug #131304.
* Remove an now-false statement about there being only one type flagFred Drake2001-02-031-3/+1
| | | | defined.
* Document the PyInstance_*() functions and data.Fred Drake2001-01-282-2/+39
|
* Fixed a bunch of typos caught by Gilles Civario.Fred Drake2001-01-191-17/+20
|
* Undoing the whitespace patches which sneaked into the earlier patch.Marc-André Lemburg2001-01-171-6/+6
|
* This patch adds a new builtin unistr() which behaves like str()Marc-André Lemburg2001-01-171-6/+14
| | | | | | | | | | except that it always returns Unicode objects. A new C API PyObject_Unicode() is also provided. This closes patch #101664. Written by Marc-Andre Lemburg. Copyright assigned to Guido van Rossum.
* The Python/C API deals in PyObject*, not PyDictObject*.Fred Drake2001-01-081-12/+12
|
* Markup nit: Command line options should be marked with \programopt.Fred Drake2001-01-041-2/+2
|
* Oops. The value "0 or +1" for the category argument of PyErr_Warn()Guido van Rossum2000-12-191-1/+1
| | | | | | doesn't work. Make it 0. (Although it really *should* be 0 or +1 -- the refcount is incremented when it is raised as an exception, but not otherwise.)
* Document Pyerr_Warn().Guido van Rossum2000-12-191-0/+11
| | | | | Add an XXX comment at the beginning expressing disappointment over the confusing way refcount behavior of arguments is documented.
* Document Pyerr_Warn().Guido van Rossum2000-12-191-0/+34
|
* In the first discussion showing how to handle exceptions from C, make theFred Drake2000-11-291-7/+11
| | | | | | | | Python equivalent actually equivalent to the C code. Also, in the C code, place the "goto" statements on a line by themselves for better visibility of statements that affect control flow. This closes bug #123398.
* Added documentation for the Py_InitModule*() family of functions.Fred Drake2000-11-282-1/+47
|
* Updates to reflect pending changes to the XML conversion process.Fred Drake2000-11-221-1/+1
|
* Added exception to the rule that the buffer returned by PyString_AsString()Fred Drake2000-10-231-4/+17
| | | | | | | | | | | | and PyString_AsStringAndSize() for strings that were just created using PyString_FromStringAndSize(NULL, n). This closes bug #117377. Added warning about passing NULL to the concrete object functions; many of them use the appropriate Py<Type>_Check() test, but do not check for NULL. "de-allocated" --> "deallocated"
* For PyErr_Format(), note that the exception parameter can be a string orFred Drake2000-10-141-2/+2
| | | | | class, but not an instance (since an instance will be created using the formatted message string as the constructor parameter).
* Fix a couple of places where the descriptions of *_GET_SIZE() macros saidFred Drake2000-10-071-2/+2
| | | | | | they were similar to *_GetSize(); should be similar to *_Size(). Error noted by William Park <parkw@better.net>.
* The _PyTuple_Resize() last_is_sticky flag must now always be false.Neil Schemenauer2000-10-051-6/+6
|
* Reversely --> ConverselyFred Drake2000-09-291-2/+2
| | | | This closes SourceForge bug #115673.
* Note that including Python.h includes limits.h when available.Fred Drake2000-09-261-2/+2
|
* Added documentation for the new PyModule_*() convenience functions.Fred Drake2000-09-231-0/+26
| | | | This closes SourceForge patch #101233.
* Added refcount information for the *_InPlace*() API series.Fred Drake2000-09-221-0/+53
| | | | This closes SourceForge bug #114287.
* PyNumber_Coerce() returns an int, not a PyObject *.Fred Drake2000-09-221-1/+1
|
* Include the new text on reporting bugs in a few useful places.Fred Drake2000-09-211-0/+4
| | | | This closes SourceForge bug #114792.
* This patch adds a new Python C API called PyString_AsStringAndSize()Marc-André Lemburg2000-09-192-0/+22
| | | | | | | | | | | | | which implements the automatic conversion from Unicode to a string object using the default encoding. The new API is then put to use to have eval() and exec accept Unicode objects as code parameter. This closes bugs #110924 and #113890. As side-effect, the traditional C APIs PyString_Size() and PyString_AsString() will also accept Unicode objects as parameters.
* Document new APIs PyOS_getsig() and PyOS_setsig().Guido van Rossum2000-09-161-0/+15
| | | | | | (Is there no macro to document a typedef?) Fred, please check my latex!
* Use \shortversion in a number of places.Fred Drake2000-09-141-6/+5
| | | | This partially addresses SourceForge bug #114318.
* Avoid reference to specific versions of Python where possible.Fred Drake2000-09-141-3/+3
| | | | This partially addresses SourceForge bug #114318.
* Thomas Wouters <thomas@xs4all.net>:Fred Drake2000-09-121-7/+106
| | | | | Fix up some of the PyNumber_*() documentation. Add documentation for the InPlace API calls.
* Vladimir Marangozov <Vladimir.Marangozov@inrialpes.fr>:Fred Drake2000-09-122-54/+62
| | | | | | | Here are some changes to the C API docs. The memory examples & API have been updated because one malloc family is gone (Py_Malloc). You'll see other small additions to the "building new types" section for completeness and some cleanup at the end of the memory section.
generated by cgit v0.12 at 2025-03-04 06:29:52 (GMT)