summaryrefslogtreecommitdiffstats
path: root/Doc/api
Commit message (Collapse)AuthorAgeFilesLines
* Minor clarification about what's actually promised for PyMem_Malloc(0).Tim Peters2002-04-061-6/+8
| | | | | I probably didn't do a correct thing for the LaTeX spelling of the integer 1.
* Move reference material on PyArg_Parse*() out of the Extending & EmbeddingFred Drake2002-04-052-110/+415
| | | | | | | | document to the C API reference. Move some instructional text from the API reference to the Extending & Embedding manual. Fix the descriptions of the es and es# formats for PyArg_Parse*(). This closes SF bug #536516.
* Correct the descriptions of the PyObject_As*Buffer() return values.Fred Drake2002-04-041-6/+6
| | | | This closes SF bug #539081.
* Introduce two new flag bits that can be set in a PyMethodDef methodFred Drake2002-03-281-2/+30
| | | | | | | | | | | | | | | | | | | descriptor, as used for the tp_methods slot of a type. These new flag bits are both optional, and mutually exclusive. Most methods will not use either. These flags are used to create special method types which exist in the same namespace as normal methods without having to use tedious construction code to insert the new special method objects in the type's tp_dict after PyType_Ready() has been called. If METH_CLASS is specified, the method will represent a class method like that returned by the classmethod() built-in. If METH_STATIC is specified, the method will represent a static method like that returned by the staticmethod() built-in. These flags may not be used in the PyMethodDef table for modules since these special method types are not meaningful in that case; a ValueError will be raised if these flags are found in that context.
* fix a typo in PyErr_Format table and add row for 'p' format charSkip Montanaro2002-03-271-1/+2
| | | | closes bug 534495
* Fix example for PyErr_SetFromErrno() (need to pass exception type).Neil Schemenauer2002-03-231-2/+2
|
* 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.
* PyDict_Next: update doc to indicate that pkey and pvalue return values areSkip Montanaro2002-01-231-1/+2
| | | | borrowed references.
* add missing return value info for PyDict_DelItemSkip Montanaro2002-01-231-1/+1
|
* Close an improperly-closed verbatim environment.Fred Drake2001-12-261-3/+6
| | | | | | | | This closes SF patch #496215. Add a little more detail to the example that had not been closed. Bugfix: this should be made part of 2.2.1.
* 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
|
* Document the rule that Python.h must be included before any standardFred Drake2001-09-061-0/+3
| | | | headers. This is the final checkin for SF bug #458768.
* Patch #449815: Set filesystemencoding based on CODESET.Martin v. Löwis2001-09-051-1/+5
|
* At Guido's suggestion, here's a new C API function, PyObject_Dir(), likeTim Peters2001-09-041-0/+10
| | | | __builtin__.dir(). Moved the guts from bltinmodule.c to object.c.
* Update documentation for GC API. Closes SF patch #421893.Neil Schemenauer2001-08-301-29/+48
|
* Refcount info for PyString_FromFormat() and PyString_FromFormatV().Barry Warsaw2001-08-281-0/+8
| | | | Closes SF patch #455666.
* Documentation for PyString_FromFormat() and PyString_FromFormatV().Barry Warsaw2001-08-281-0/+28
| | | | Closes SF patch #455666.
generated by cgit v0.12 at 2025-01-12 13:14:14 (GMT)