summaryrefslogtreecommitdiffstats
path: root/Doc/api
Commit message (Collapse)AuthorAgeFilesLines
* Added refcount information for PyObject_GetIter().Fred Drake2002-10-041-0/+3
|
* Ok, read the source this time: PyErr_SetObject() does not steal a reference.Fred Drake2002-09-251-1/+1
|
* Clarify documentation for PyErr_SetObject() to describe the referenceFred Drake2002-09-241-1/+1
| | | | count behavior.
* Fix API typo. Closes SF 606216Raymond Hettinger2002-09-081-1/+1
|
* Fix SF bug 587012, doc mentions inexistent builtin unistrNeal Norwitz2002-07-281-2/+2
|
* Corrected return type and value information for PyUnicode_Count() andFred Drake2002-06-202-16/+20
| | | | | PyUnicode_Find(). This closes SF bug #566631.
* Fix documentation for PyMarshal_WriteObjectToFile() andFred Drake2002-06-171-5/+5
| | | | | PyMarshal_WriteObjectToFile(). This closes SF bug #533735.
* Clean up descriptions of PyObject_RichCompare() and PyObject_RichCompareBool()Fred Drake2002-06-142-8/+18
| | | | | based on comments from David Abrahams. Added refcount information for these functions.
* Add documentation for PyObject_RichCompare() and PyObject_RichCompareBool(),Fred Drake2002-06-131-0/+42
| | | | | constributed by David Abrahams. This closes SF patch #568081.
* backport theller's patch:Anthony Baxter2002-04-301-4/+4
| | | | | | | | | Typo: whcar_t should be wchar_t. Bugfix candidate? Don't know how this is handled in the docs. Original patch(es): python/dist/src/Doc/api/concrete.tex:1.15
* backport tim_one's patch:Anthony Baxter2002-04-301-1/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | Repair widespread misuse of _PyString_Resize. Since it's clear people don't understand how this function works, also beefed up the docs. The most common usage error is of this form (often spread out across gotos): if (_PyString_Resize(&s, n) < 0) { Py_DECREF(s); s = NULL; goto outtahere; } The error is that if _PyString_Resize runs out of memory, it automatically decrefs the input string object s (which also deallocates it, since its refcount must be 1 upon entry), and sets s to NULL. So if the "if" branch ever triggers, it's an error to call Py_DECREF(s): s is already NULL! A correct way to write the above is the simpler (and intended) if (_PyString_Resize(&s, n) < 0) goto outtahere; Bugfix candidate. Original patch(es): python/dist/src/Doc/api/concrete.tex:1.13
* Document PyType_CheckExact(), PyType_IS_GC().Fred Drake2002-04-101-1/+16
| | | | Update description of PyType_Check().
* Correct the descriptions of the PyObject_As*Buffer() return values.Fred Drake2002-04-041-6/+6
| | | | This closes SF bug #539081.
* Backport Skip's patch for SF bug #534495:Fred Drake2002-03-271-1/+2
| | | | | | | exceptions.tex 1.5 fix a typo in PyErr_Format table and add row for 'p' format char closes bug 534495
* Add a note that Py_None needs the same reference count treatment as anyFred Drake2002-03-121-1/+2
| | | | | other PyObject *. This closes SF bug #494007.
* Documentation for PyObject_GetIter(), contributed by Greg ChapmanFred Drake2002-03-111-3/+18
| | | | | (with only minor changes by Fred). This closes SF bug #498607.
* Correct the refcount information for the PyWeakref_GetObject() function.Fred Drake2002-02-201-1/+1
| | | | This closes SF bug #520087.
* Close an improperly-closed verbatim environment.Fred Drake2001-12-281-3/+6
| | | | | | This closes SF patch #496215. Add a little more detail to the example that had not been closed.
* A number of small adjustments.Fred Drake2001-12-111-4/+12
|
* SF bug #491415 PyDict_UpdateFromSeq2() unusedTim Peters2001-12-111-20/+43
| | | | | | | PyDict_UpdateFromSeq2(): removed it. PyDict_MergeFromSeq2(): made it public and documented it. PyDict_Merge() docs: updated to reveal <wink> that the second argument can be any mapping object.
* Document that PyString_FromString() cannot take NULL as a parameter.Fred Drake2001-12-061-1/+2
| | | | This closes SF bug #489872.
* Clarify that the Python runtime may behave mysteriously when an exceptionFred Drake2001-12-031-4/+12
| | | | | is not handled properly. This closes SF bug #485153.
* Remove most references to __members__ and __methods__, leaving only one pairFred Drake2001-12-031-3/+3
| | | | | | of references that now state that these attributes have been removed, directing the reader to the dir() function. This closes SF bug #456420.
* PyErr_Format() does not return a new reference; it always returns NULL.Fred Drake2001-12-031-7/+5
| | | | This closes SF bug #488387.
* Update the signature of PyFile_WriteString().Fred Drake2001-11-292-2/+2
|
* Clean up some markup cruft. A number of the macros that take noFred Drake2001-11-282-3/+3
| | | | | | | | parameters (like \UNIX) are commonly entered using an empty group to separate the markup from a following inter-word space; this is not needed when the next character is punctuation, or the markup is the last thing in the enclosing group. These cases were marked inconsistently; the empty group is now *only* used when needed.
* Add documentation for the PyCell* APIs.Fred Drake2001-11-262-0/+67
|
* Add omitted word for clarity.Fred Drake2001-11-171-1/+1
|
* Fix obvious typos.Thomas Heller2001-11-121-3/+3
|
* Added version annotations, remove hard tabs.Fred Drake2001-11-091-7/+11
|
* Add PyObject_CheckReadBuffer(), which returns true if its argumentJeremy Hylton2001-11-091-0/+39
| | | | | | supports the single-segment readable buffer interface. Add documentation for this and other PyObject_XXXBuffer() calls.
* More refcount information.Fred Drake2001-10-291-0/+40
|
* PyObject_CallFunctionObArgs() ---> PyObject_CallFunctionObjArgs()Fred Drake2001-10-282-14/+14
| | | | PyObject_CallMethodObArgs() ---> PyObject_CallMethodObjArgs()
* Added docs for PyObject_CallFunctionObArgs() and PyObject_CallMethodObArgs().Fred Drake2001-10-261-11/+32
| | | | Minor cleanups & markup consistency fixes.
* Added refcount data for PyObject_CallFunctionObArgs() andFred Drake2001-10-261-0/+9
| | | | PyObject_CallMethodObArgs().
* Generalize dictionary() to accept a sequence of 2-sequences. At theTim Peters2001-10-261-5/+12
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | outer level, the iterator protocol is used for memory-efficiency (the outer sequence may be very large if fully materialized); at the inner level, PySequence_Fast() is used for time-efficiency (these should always be sequences of length 2). dictobject.c, new functions PyDict_{Merge,Update}FromSeq2. These are wholly analogous to PyDict_{Merge,Update}, but process a sequence-of-2- sequences argument instead of a mapping object. For now, I left these functions file static, so no corresponding doc changes. It's tempting to change dict.update() to allow a sequence-of-2-seqs argument too. Also changed the name of dictionary's keyword argument from "mapping" to "x". Got a better name? "mapping_or_sequence_of_pairs" isn't attractive, although more so than "mosop" <wink>. abstract.h, abstract.tex: Added new PySequence_Fast_GET_SIZE function, much faster than going thru the all-purpose PySequence_Size. libfuncs.tex: - Document dictionary(). - Fiddle tuple() and list() to admit that their argument is optional. - The long-winded repetitions of "a sequence, a container that supports iteration, or an iterator object" is getting to be a PITA. Many months ago I suggested factoring this out into "iterable object", where the definition of that could include being explicit about generators too (as is, I'm not sure a reader outside of PythonLabs could guess that "an iterator object" includes a generator call). - Please check my curly braces -- I'm going blind <0.9 wink>. abstract.c, PySequence_Tuple(): When PyObject_GetIter() fails, leave its error msg alone now (the msg it produces has improved since PySequence_Tuple was generalized to accept iterable objects, and PySequence_Tuple was also stomping on the msg in cases it shouldn't have even before PyObject_GetIter grew a better msg).
* Slightly better conformance to the Python C style guide.Fred Drake2001-10-251-4/+8
|
* Documentation for the new PyArg_UnpackTuple() function.Fred Drake2001-10-231-0/+47
|
* Update the description of PyTrace_EXCEPT.Fred Drake2001-10-161-5/+8
|
* Added documentation for the functions listed in marshal.h.Fred Drake2001-10-141-0/+80
| | | | Prompted by Jim Ahlstrom. This closes SF patch #470614.
* Break the Python/C API manual into smaller files by chapter. This manualFred Drake2001-10-1211-6136/+6171
| | | | | | | | 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.Fred Drake2001-10-051-1/+70
|
* Expand the documentation of the low-level tracing/profiling interface.Fred Drake2001-10-031-2/+23
| | | | This reflects what is currently in CVS, which may change before 2.2 is final.
* Typo fix.Greg Ward2001-09-261-1/+1
|
* Add more signature information and some descriptions for the new APIsFred Drake2001-09-241-1/+89
| | | | | | | 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.
* Add more reference count information.Fred Drake2001-09-241-0/+28
|
* Added API information for the PyCallIter_*() and PySeqIter_*() functions.Fred Drake2001-09-232-1/+66
| | | | Added signatures for some new PyType_*() functions.
* Document all the Py*_CheckExact() functions.Fred Drake2001-09-202-26/+174
| | | | Document many more of the PyLong_{As,From}*() functions.
* Fix parameter for PyInt_Check().Fred Drake2001-09-061-1/+31
| | | | Add refcount information for other recently documented APIs.
* Document the PyMethod_* type object, functions, and macros.Fred Drake2001-09-061-0/+58
|
generated by cgit v0.12 at 2025-12-26 23:39:50 (GMT)