summaryrefslogtreecommitdiffstats
path: root/Doc/api
Commit message (Collapse)AuthorAgeFilesLines
* New functions for extension writers on Windows:Thomas Heller2002-07-291-0/+16
| | | | | | | | | | PyErr_SetExcFromWindowsErr(), PyErr_SetExcFromWindowsErrWithFilename(). Similar to PyErr_SetFromWindowsErrWithFilename() and PyErr_SetFromWindowsErr(), but they allow to specify the exception type to raise. Available on Windows. See SF patch #576458.
* Fix SF bug 587012, doc mentions inexistent builtin unistrNeal Norwitz2002-07-281-2/+2
|
* The Py_REF_DEBUG/COUNT_ALLOCS/Py_TRACE_REFS macro minefield: addedTim Peters2002-07-091-1/+1
| | | | | | | | | | | | | | | | | | | | | more trivial lexical helper macros so that uses of these guys expand to nothing at all when they're not enabled. This should help sub- standard compilers that can't do a good job of optimizing away the previous "(void)0" expressions. Py_DECREF: There's only one definition of this now. Yay! That was that last one in the family defined multiple times in an #ifdef maze. Py_FatalError(): Changed the char* signature to const char*. _Py_NegativeRefcount(): New helper function for the Py_REF_DEBUG expansion of Py_DECREF. Calling an external function cuts down on the volume of generated code. The previous inline expansion of abort() didn't work as intended on Windows (the program often kept going, and the error msg scrolled off the screen unseen). _Py_NegativeRefcount calls Py_FatalError instead, which captures our best knowledge of how to abort effectively across platforms.
* Minor markup adjustments, consistency changes, and shorten a longFred Drake2002-07-021-12/+13
| | | | line.
* Add refcount info for PyErr_SetFromWindowsErr() andFred Drake2002-07-021-0/+7
| | | | PyErr_SetFromWindowsErrWithFilename().
* Docs for PyErr_SetFromWindowsErrWithFilename() andThomas Heller2002-07-021-0/+23
| | | | | PyErr_SetFromWindowsErr(). Fixes SF# 576016, with additional markup.
* 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.
* This is my nearly two year old patchMichael W. Hudson2002-06-111-0/+26
| | | | | | | | | [ 400998 ] experimental support for extended slicing on lists somewhat spruced up and better tested than it was when I wrote it. Includes docs & tests. The whatsnew section needs expanding, and arrays should support extended slices -- later.
* Explain that tp_basicsize must provide alignment for the items.Guido van Rossum2002-05-311-0/+8
|
* Add refcount information for PySequence_ITEM().Fred Drake2002-05-231-0/+4
|
* Add version annotation for PySequence_ITEM().Fred Drake2002-05-231-1/+2
|
* Patch #552433: Special-case tuples. Avoid sub-type checking for lists.Martin v. Löwis2002-05-081-0/+7
| | | | | Avoid checks for negative indices and duplicate checks for support of the sequence protocol.
* Typo: whcar_t should be wchar_t.Thomas Heller2002-04-291-4/+4
| | | | Bugfix candidate? Don't know how this is handled in the docs.
* Small markup adjustments for consistency.Fred Drake2002-04-291-2/+2
|
* Repair widespread misuse of _PyString_Resize. Since it's clear peopleTim Peters2002-04-271-1/+10
| | | | | | | | | | | | | | | | | | | | | | 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.
* Fix a small mistake and complete some function prototypes.Thomas Heller2002-04-241-4/+4
| | | | SF Patch #547813.
* Clarify the return value of PyObject_IsInstance().Fred Drake2002-04-231-8/+9
|
* Add text on tp_as_buffer that refers tothe section that covers the topic.Fred Drake2002-04-171-3/+9
| | | | Additional material is still needed in that section.
* Minor wording change.Fred Drake2002-04-161-1/+1
|
* Add more text from Guido on the type structure fields.Fred Drake2002-04-161-23/+442
| | | | Small additional changes.
* Add documentation for PyObject_Call().Fred Drake2002-04-151-0/+16
| | | | | Note that PyObject_Size() is a synonym for PyObject_Length(). This closes SF patch #544330 (contributed by Thomas Heller).
* Integrated more text from Guido.Fred Drake2002-04-151-2/+359
|
* Integrate a bunch of new text from Guido.Fred Drake2002-04-121-6/+262
|
* Warn people away from PyModule_GetDict(), but not too strongly.Fred Drake2002-04-121-0/+3
| | | | | | | (The real issue is whether modules can benefit from an alternate implementation strategy rather than using a dictionary. We should migrate away from direct dictionary manipulation to allow more room for Jeremy to flex the implementation with changes in globals lookup.)
* Add a (very) simple description of PyType_Ready().Fred Drake2002-04-121-0/+4
|
* Document PyType_CheckExact(), PyType_IS_GC().Fred Drake2002-04-101-1/+16
| | | | Update description of PyType_Check().
* Started filling in the information about some of the basic types and macrosFred Drake2002-04-091-2/+69
| | | | used to define Python objects.
* Update to use the new \csimplemacro macroFred Drake2002-04-091-17/+19
|
* 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
|