Commit Graph

450 Commits

Author SHA1 Message Date
Martin v. Löwis 29fafd8708 Make documentation match the implementation. 2006-03-01 05:16:03 +00:00
Georg Brandl b518d8c7d7 Fix casing of function names. 2006-02-22 11:46:55 +00:00
Georg Brandl 7d42d3cd59 fix typo 2006-02-21 20:41:29 +00:00
Georg Brandl 9b743f514c Bug #1013800: document PyFunction_* functions 2006-02-20 12:57:53 +00:00
Georg Brandl 4caeff9867 Patch #1415507: clarify docs on reference stealing 2006-02-18 22:55:59 +00:00
Georg Brandl 1b6726732c Bug #1432350: arrayobject should use PyObject_VAR_HEAD 2006-02-17 08:56:33 +00:00
Fredrik Lundh 118be0c6ca SF#1383115
added refcount information for PyObject_Call
2005-12-18 19:39:59 +00:00
Neal Norwitz b04747fc50 Add versionadded info 2005-12-18 01:36:44 +00:00
Barry Warsaw 2a38a86c1c Expose Subversion revision number (calculated via "svnversion .") to Python.
Add C API function Py_GetBuildNumber(), add it to the interactive prompt
banner (i.e. Py_GetBuildInfo()), and add it as the sys.build_number
attribute.  The build number is a string instead of an int because it may
contain a trailing 'M' if there are local modifications.
2005-12-18 01:27:35 +00:00
Georg Brandl f06e30af4a bug #1281408: make Py_BuildValue work with unsigned longs and long longs 2005-11-24 15:37:42 +00:00
Martin v. Löwis ab0f947a21 Remove .cvsignore files, as they live in svn:ignore
properties now.
2005-10-30 22:01:41 +00:00
Neal Norwitz 98fcaaf48e SF bug #1323739, C API doc for PySequence_Tuple duplicated 2005-10-12 03:58:14 +00:00
Marc-André Lemburg df4f6e9fa6 Clarify the docs for Py_UNICODE. 2005-10-10 19:08:41 +00:00
Walter Dörwald d1c1e10f70 Part of SF patch #1313939: Speedup charmap decoding by extending
PyUnicode_DecodeCharmap() the accept a unicode string as the mapping
argument which is used as a mapping table.

This code isn't used by any of the codecs yet.
2005-10-06 20:29:57 +00:00
Georg Brandl e53475ddd1 bug [ 1306449 ] PyString_AsStringAndSize() return value documented wrong 2005-09-28 12:53:12 +00:00
Georg Brandl ff52837445 fix typo 2005-09-15 11:16:28 +00:00
Georg Brandl 99363b6a19 - Correct PyBool_FromLong's return type and its description.
- Unify function description mode ("Return X" vs "Returns X")
2005-09-03 07:27:26 +00:00
Raymond Hettinger 7638249646 Fix PySet_Pop() notes. 2005-08-21 00:08:36 +00:00
Raymond Hettinger 0cbf400419 Add info about the set API. 2005-08-20 23:52:30 +00:00
Raymond Hettinger 94fedf9bfd Expand the API notes. 2005-08-17 12:23:45 +00:00
Raymond Hettinger 0c230b9dac Note that the PyNumber protocol can access most set methods directly. 2005-08-17 10:05:22 +00:00
Raymond Hettinger c47e01d020 Numerous fix-ups to C API and docs. Added tests for C API. 2005-08-16 10:44:15 +00:00
Raymond Hettinger beb3101b05 Add a C API for sets and frozensets. 2005-08-16 03:47:52 +00:00
Georg Brandl 0e03272350 bug [ 1061920 ] "k" specifier in PyArg_ParseTuple incomplete documentated 2005-07-17 20:05:25 +00:00
Michael W. Hudson fb662972e0 Add a(nother) warning about mixing Py_NewInterpreter and the
PyGILState_* functions.
2005-06-20 16:37:03 +00:00
Michael W. Hudson 7b279078c0 fix some silly whitespace stuff (must have hit M-q or something?) 2005-06-20 12:12:45 +00:00
Neil Schemenauer c49322951f Fix grammar (it's -> its). 2005-06-18 17:54:13 +00:00
Thomas Heller 33ceda85d0 Function signatures for tp_descr_get and tp_descr_set. 2005-03-24 07:45:53 +00:00
Brett Cannon 5bbe6ad2b5 Fix name for PyDateTime_FromDateAndTime.
Closes bug #1124278.
2005-02-17 05:17:17 +00:00
Brett Cannon 7706c2da14 Update references specifying "Macintosh" to mean OS X semantics and not Mac OS
9.

Applies patch #1095802.  Thanks Jack Jansen.
2005-02-13 22:50:04 +00:00
Fred Drake 140042446f Clean up discussion of new C thread idiom
(closes SF patch #1031233; modified)
2005-01-19 04:18:39 +00:00
Raymond Hettinger 68804315e0 SF Patch #1093896: miscellaneous doc typos 2005-01-01 00:28:46 +00:00
Raymond Hettinger 8ef9b3e527 SF bug #1082944: Incorrect docs for PyUnicode_TailMatch
* Note correct return type is int.
* Note that -1 returned on failure.
2004-12-10 17:12:32 +00:00
Marc-André Lemburg a9cadcd41b Correct the handling of 0-termination of PyUnicode_AsWideChar()
and its usage in PyLocale_strcoll().

Clarify the documentation on this.

Thanks to Andreas Degert for pointing this out.
2004-11-22 13:02:31 +00:00
Tim Peters 7f468f29f4 SF patch 1044089: New C API function PyEval_ThreadsInitialized(), by Nick
Coghlan, for determining whether PyEval_InitThreads() has been called.
Also purged the undocumented+unused _PyThread_Started int.
2004-10-11 02:40:51 +00:00
Nicholas Bastin 975e725fc7 Fix typo in PyDict_Items doc 2004-09-29 21:39:26 +00:00
Walter Dörwald 69652035bc SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
decoding incomplete input (when the input stream is temporarily exhausted).
codecs.StreamReader now implements buffering, which enables proper
readline support for the UTF-16 decoders. codecs.StreamReader.read()
has a new argument chars which specifies the number of characters to
return. codecs.StreamReader.readline() and codecs.StreamReader.readlines()
have a new argument keepends. Trailing "\n"s will be stripped from the lines
if keepends is false. Added C APIs PyUnicode_DecodeUTF8Stateful and
PyUnicode_DecodeUTF16Stateful.
2004-09-07 20:24:22 +00:00
Martin v. Löwis 336e85f56a Patch #900727: Add Py_InitializeEx to allow embedding without signals. 2004-08-19 11:31:58 +00:00
Andrew M. Kuchling f54ac7e0ee Spelling fix 2004-08-10 19:01:50 +00:00
Andrew M. Kuchling 4eb1a00cc1 [Patch #1003861 from Dima Dorfman] Fix markup in concrete.tex:
PyObject* o -> PyObject *o to be consistent with the
rest of the file
- Correct markup for Py_True
- Remove duplicate description of PyBool_Check
2004-08-07 20:19:24 +00:00
Andrew M. Kuchling 672d2ba773 Use LaTeX markup 2004-08-07 20:17:48 +00:00
Andrew M. Kuchling fe80b63663 [Bug #991883] Document calling condition 2004-08-07 17:53:05 +00:00
Hye-Shik Chang e9ddfbb412 SF #989185: Drop unicode.iswide() and unicode.width() and add
unicodedata.east_asian_width().  You can still implement your own
simple width() function using it like this:
    def width(u):
        w = 0
        for c in unicodedata.normalize('NFC', u):
            cwidth = unicodedata.east_asian_width(c)
            if cwidth in ('W', 'F'): w += 2
            else: w += 1
        return w
2004-08-04 07:38:35 +00:00
Fred Drake 2be406bd9f let's avoid the extra nesting where reasonable 2004-08-03 16:02:35 +00:00
Neal Norwitz 7fdd92f31f Fix typo though 2004-08-02 21:56:33 +00:00
Raymond Hettinger 829d6c4138 Fix doubled word. 2004-08-02 08:36:07 +00:00
Tim Peters fd7dc5169c Typo repair. 2004-08-02 04:30:37 +00:00
Tim Peters 0c6199e8ed Completed a sentence I left dangling. 2004-08-02 04:14:10 +00:00
Tim Peters cfd575d398 PyImport_ImportModule, PyImport_ImportModuleEx, PyImport_ExecCodeModule:
in failure cases, incompletely initalized module objects are no longer
left behind in sys.modules.
2004-08-02 03:46:45 +00:00
Skip Montanaro 6d3db7000e Add missing doc for Py_True/Py_False. Use the correct macro to define
Py_RETURN_FALSE and Py_RETURN_TRUE.
2004-07-29 02:16:04 +00:00
Skip Montanaro 33ee76ae9e A little boolean music if you please, maestro... (Not sure I have the
versionadded{} args quite right).
2004-07-28 14:17:04 +00:00
Andrew M. Kuchling e03664ff22 Two typo fixes 2004-07-26 19:25:54 +00:00
Thomas Heller fe0808382b Fix an uncorrect function prototype.
Will backport to release23-maint.

BTW: Shouldn't it read PY_LONG_LONG instead of 'long long' ?
2004-07-23 14:49:52 +00:00
Tim Peters 8ff9f9f4aa Supply missing word in new datetime docs, aggravated by copy-paste-edit. 2004-07-17 01:42:26 +00:00
Tim Peters eda29306b3 Formalize that the Py_VISIT macro requires that the tp_traverse
implementation it's used in must give its arguments specific names.
2004-07-15 04:05:59 +00:00
Jim Fulton aa6389e13b Documented the new Py_VISIT macro to simplify implementation of
tp_traverse handlers. (Tim made me do it. ;)
2004-07-14 19:08:17 +00:00
Jim Fulton 8c5aeaa277 Implemented a new Py_CLEAR macro. This macro should be used when
decrementing the refcount of variables that might be accessed as a
result of calling Python
2004-07-14 19:07:35 +00:00
Tim Peters e45d5a3b00 Claifications: visit procs are supplied by the core, users aren't
expected to write their own.  A NULL "object" must not be passed to
the visit callback.  A non-zero return from a visit proc isn't
necessarily an error return (and it doesn't matter to the tp_traverse
code *what* it might signify, their only job is to return it).
2004-07-13 17:18:10 +00:00
Tim Peters 183dabcd73 SF patch 986010: add missing doc for datetime C API, from
Anthony Tuininga.

This is a derived patch, taking the opportunity to add some organization
to the now-large pile of datetime-related macros, and to factor out
tedious repeated text.

Also improved some clumsy wording in NEWS.
2004-07-11 19:26:19 +00:00
Brett Cannon 711e7d97e4 Add PyArg_VaParseTupleAndKeywords(). Document this function and
PyArg_VaParse().

Closes patch #550732.  Thanks Greg Chapman.
2004-07-10 22:20:32 +00:00
Andrew M. Kuchling d9dfe0213f Remove a few elderly sentences 2004-07-10 13:48:54 +00:00
Andrew M. Kuchling ff8113f8d0 Replace example with simpler alternative using PyGILState_{Ensure,Require). Can someone please confirm this change is OK? 2004-07-10 13:42:52 +00:00
Andrew M. Kuchling 371d98ab15 [Bug #987835] Add documentation from PEP 311. (Untested TeX code.) 2004-07-10 13:31:18 +00:00
Andrew M. Kuchling ee5e4cd899 [Bug #984017] Incorrect prototype, fixed by Timothy Stranex 2004-07-07 13:07:47 +00:00
Brett Cannon d88471f432 Change signatures for arguments to "s" and friends to be the proper ``const
char *`` instead of just ``char *``.  Also added the mentioning of "const" in
some places where it was left out even when the signature already stated the
fact.

Closes bug #980925.
2004-07-01 20:55:42 +00:00
Andrew M. Kuchling 6d3a0d2dff [Bug #948970] Add PyExc_* symbols to index.
(I ran this through texcheck, but don't have LaTeX installed on this machine and therefore haven't
verified that the changes are accepted by LaTeX.)
2004-06-29 13:52:14 +00:00
Martin v. Löwis ef82d2fdfe Patch #923098: Share interned strings in marshal. 2004-06-27 16:51:46 +00:00
Tim Peters 9ddf40b4e1 SF patch 876130: add C API to datetime module, from Anthony Tuininga.
The LaTeX is untested (well, so is the new API, for that matter).
Note that I also changed NULL to get spelled consistently in concrete.tex.
If that was a wrong thing to do, Fred should yell at me.
2004-06-20 22:41:32 +00:00
Neil Schemenauer d68d3ee3dd Note that memory returned by PyBuffer_New is not specifically aligned.
Closes SF bug #472568.
2004-06-08 02:58:50 +00:00
Andrew M. Kuchling 1b50b43bee [Bug #936837] Add missing word 2004-06-05 19:00:55 +00:00
Martin v. Löwis 9bc4f2def3 Drop claims that Unicode always means UCS-2. Fixes #881861. 2004-06-03 09:55:28 +00:00
Hye-Shik Chang 974ed7cfa5 - SF #962502: Add two more methods for unicode type; width() and
iswide() for east asian width manipulation. (Inspired by David
Goodger, Reviewed by Martin v. Loewis)
- Move _PyUnicode_TypeRecord.flags to the end of the struct so that
no padding is added for UCS-4 builds. (Suggested by Martin v. Loewis)
2004-06-02 16:49:17 +00:00
Martin v. Löwis dd07e59eee Document PyModule_AddIntConstant to take a long. Fixes #962471.
Will backport to 2.3.
2004-06-02 12:45:27 +00:00
Martin v. Löwis e440e47e91 Patch #957398: Add public API for Generator Object/Type. 2004-06-01 15:22:42 +00:00
Fred Drake 043fff0881 minor wording cleanup 2004-05-12 03:20:37 +00:00
Nicholas Bastin e9c2ecfb96 Removed 'U' from the documentation for Py_BuildValue to bring it in line
with the elimination of 'U' in modsupport.c on 2000/04/28 (replaced
with 'u' and 'u#' per fdrake's comments).
2004-05-04 19:25:56 +00:00
Thomas Heller 1328b52c6f Two new public API functions, Py_IncRef and Py_DecRef. Useful for
dynamic embedders of Python.
2004-04-22 17:23:49 +00:00
Raymond Hettinger e5fced781b SF bug #936827: PyNumber_And() 's description
Fix typo.
2004-04-17 11:57:40 +00:00
Fred Drake 34c43202eb Emphasize the requirement that Python.h be included first more strongly.
Closes SF bug #837228; backporting for Python 2.3.4.
2004-03-31 07:45:46 +00:00
Fred Drake d0c3b26bd0 improve the very-high-level API docs (contributed by Jeff Epler)
Closes SF patch #798638.
2004-03-25 15:44:56 +00:00
Fred Drake 85309512ec Remove note that PyErr_SetInterrupt() is obsolete; add comment about the
fact that it was marked obsolete but is still needed.
Closes SF bug #919299.  Someone else should backport this to Python 2.3.
2004-03-25 14:25:28 +00:00
Raymond Hettinger 5232f50b19 SF bug: #921927: Fixed a typo/thinko spelling "parameter" as "paramter" 2004-03-25 08:51:36 +00:00
Nicholas Bastin c69ebe8d50 Enable the profiling of C functions (builtins and extensions) 2004-03-24 21:57:10 +00:00
Brett Cannon 65d63424b4 Minor grammatical fixes. 2004-03-18 01:38:11 +00:00
Brett Cannon 9b976e6636 Extremely minor typo fixed. 2004-03-18 00:49:01 +00:00
Raymond Hettinger c1e4f9dd92 Use a new macro, PySequence_Fast_ITEMS to factor out code common to
three recent optimizations.  Aside from reducing code volume, it
increases readability.
2004-03-12 08:04:00 +00:00
Fred Drake 70a30e8c94 markup correction 2004-02-17 04:17:36 +00:00
Martin v. Löwis d3f4a1a00a Patch #893566: Document that tp_dealloc may be called from any thread. 2004-02-15 21:01:17 +00:00
Thomas Heller 8178a22e20 Documentation for PyDescr_NewClassMethod was missing - here's at least
the function prototype.

Already backported to release23-maint.
2004-02-09 10:47:11 +00:00
Raymond Hettinger 4cd5a08d8b Fix small factual error. 2004-01-04 03:11:45 +00:00
Fred Drake 7a700b873b clean up indexing for None, NotImplemented
closes SF bug #820344
2004-01-01 05:43:53 +00:00
Andrew MacIntyre f72af655c5 At 2.2, the Py<type>_Check() family of API functions (macros) changed
semantics to include subtypes.  Most concrete object APIs then had
a Py<type>_CheckExact() macro added to test for an object's type
not including subtypes.

The PyDict_CheckExact() macro wasn't created at that time, so I've added
it for API completeness/symmetry - even though nobody has complained
about its absence in the time since 2.2 was released.

Not a backport candidate.
2003-12-26 00:07:51 +00:00
Andrew MacIntyre 13cd8898d2 The semantics of PyList_Check() and PyDict_Check() changed at 2.2, along
with most other concrete object checks, but the docs weren't brought into
line.

PyList_CheckExact() was added at 2.2 but never documented.

backport candidate.
2003-12-25 23:57:52 +00:00
Raymond Hettinger 5469324cde Note that \var{ppos} values are not consecutive and should not be altered. 2003-12-13 19:48:41 +00:00
Raymond Hettinger 8f5cdaa784 * Added a new method flag, METH_COEXIST.
* Used the flag to optimize set.__contains__(), dict.__contains__(),
  dict.__getitem__(), and list.__getitem__().
2003-12-13 11:26:12 +00:00
Raymond Hettinger e180307c10 Fix missing paren. 2003-12-07 12:49:48 +00:00
Raymond Hettinger 2619c9ec89 SF patch #838938: Typos in the docs (Extending/Embedding + Python/C API)
(Contributed by Florent Rougon.)
2003-12-07 11:40:17 +00:00
Raymond Hettinger bc0f2ab9bb Expose dict_contains() and PyDict_Contains() with is about 10% faster
than PySequence_Contains() and more clearly applicable to dicts.

Apply the new function in setobject.c where __contains__ checking is
ubiquitous.
2003-11-25 21:12:14 +00:00
Fred Drake 28eae084bf fix use of undefined markup 2003-11-10 14:48:48 +00:00
Brett Cannon 35d8360bf7 Document Py_RETURN_NONE. 2003-11-09 04:15:30 +00:00