summaryrefslogtreecommitdiffstats
path: root/Doc/api
Commit message (Collapse)AuthorAgeFilesLines
* Typo: PyArgs_ParseTuple --> PyArg_ParseTupleFred Drake2001-07-201-30/+62
| | | | | | Moved the PyArg_Parse*(), Py_BuildValue() functions to the Utilities chapter, added a minimal description and reference to the Extending manual for Py_BuildValue().
* Added information on Py_BuildValue().Fred Drake2001-07-201-0/+3
|
* Adding what's done of the documentation for the new profiling &Fred Drake2001-07-171-0/+53
| | | | | tracing interface. Incomplete, but better to check it in since I've been including it in my updates.
* Oops, one more caret.Fred Drake2001-07-141-1/+1
|
* Fix the markup of the caret charater in a couple of places; LaTeX'sFred Drake2001-07-141-2/+2
| | | | | | special character bite us again. ;-( This fixes SF bug #440911.
* 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.
* 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'.
* More reference count information.Fred Drake2001-07-061-1/+9
|
* Move license information to a less annoying location in the document.Fred Drake2001-06-201-0/+13
| | | | Add documentation for PyErr_SetFromErrnoWithFilename().
* 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.
* Removed information on the old third parameter to _PyTuple_Resize().Fred Drake2001-05-291-1/+20
| | | | | | Added information on PyIter_Check(), PyIter_Next(), PyObject_Unicode(), PyString_AsDecodedObject(), PyString_AsEncodedObject(), and PyThreadState_GetDict().
* Do not start API descriptions with "Does the same, but ..." -- actuallyFred Drake2001-05-291-10/+13
| | | | | | | | 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().Fred Drake2001-05-211-0/+21
|
* Typo: "that" --> "than"Fred Drake2001-05-211-1/+1
| | | | This closes SF bug #425320.
* This patch changes the way the string .encode() method works slightlyMarc-André Lemburg2001-05-151-7/+21
| | | | | | | | | | | | | | | | | | | | | | | | | 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.Fred Drake2001-05-071-0/+2
|
* Added documentation for PyIter_Check() and PyIter_Next().Fred Drake2001-05-071-1/+39
| | | | Wrapped a long line.
* This patch originated from an idea by Martin v. Loewis who submitted aMarc-André Lemburg2001-04-231-1/+3
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | 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.
* 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.
generated by cgit v0.12 at 2024-11-17 20:34:37 (GMT)