Commit Graph

4308 Commits

Author SHA1 Message Date
Tim Peters 61acf067ac SF bug [#471111] inspect.getframeinfo() needs docs.
TeX-ified its docstring.
2001-10-16 23:01:06 +00:00
Guido van Rossum 3c28863e08 Partial patch from SF #452266, by Jason Petrone.
This changes Pythread_start_thread() to return the thread ID, or -1
for an error.  (It's technically an incompatible API change, but I
doubt anyone calls it.)
2001-10-16 21:13:49 +00:00
Jeremy Hylton 511e2cacc4 [ #403753 ] zlib decompress; uncontrollable memory usage
Mostly by Toby Dickenson and Titus Brown.

Add an optional argument to a decompression object's decompress()
method.  The argument specifies the maximum length of the return
value.  If the uncompressed data exceeds this length, the excess data
is stored as the unconsumed_tail attribute.  (Not to be confused with
unused_data, which is a separate issue.)

Difference from SF patch: Default value for unconsumed_tail is ""
rather than None.  It's simpler if the attribute is always a string.
2001-10-16 20:39:49 +00:00
Guido van Rossum 7a59445e37 Document required return values -1, 0, 1 for tp_compare handler, as
suggested in SF patch #424475.  Also document exception return.
2001-10-16 20:32:05 +00:00
Fred Drake 5bf1ecd503 Update the description of PyTrace_EXCEPT. 2001-10-16 19:23:55 +00:00
Fred Drake ab9b238ced Fix a few usage and style-guide conformance issues. 2001-10-16 19:22:51 +00:00
Fred Drake 64d7863797 Added information about setprofile() and settrace() hooks being thread-
specific, and updated some of the comments about the profile hook.
This closes SF bug #471725.
2001-10-16 14:54:22 +00:00
Fred Drake a815916472 Fix thinko in a comment about seeking with a file object.
Reported by Francesco Trentini.
2001-10-16 03:25:00 +00:00
Fred Drake 327798ca4a Added notes to clarify that binascii.crc32(), zlib.crc32(), and
zlib.adler32() are not suitable as general hash functions.
2001-10-15 13:45:49 +00:00
Fred Drake 0fae49fc7b Added documentation for the functions listed in marshal.h.
Prompted by Jim Ahlstrom.  This closes SF patch #470614.
2001-10-14 04:45:51 +00:00
Fred Drake c65b3d95b6 Add entries for the newly split C API manual. 2001-10-12 19:02:35 +00:00
Fred Drake 3adf79e3e2 Break the Python/C API manual into smaller files by chapter. This manual
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.
2001-10-12 19:01:43 +00:00
Jeremy Hylton cb43c085e2 Document that keyfile and certfile are now optional.
XXX Forgot to mention this in the last socketmodule.c checkin.
2001-10-11 16:17:22 +00:00
Barry Warsaw c7f8b86307 Describe the HeaderParser class. 2001-10-11 15:45:05 +00:00
Tim Peters 8cd015c701 A copy-and-paste job forget the "paste" half. 2001-10-09 20:54:23 +00:00
Tim Peters 659a60311d Allow the profiler's calibration constant to be specified in the constructor
call, or via setting an instance or class vrbl.
Rewrote the calibration docs.
Modern boxes are so friggin' fast, and a profiler event does so much work
anyway, that the cost of looking up an instance vrbl (the bias constant)
per profile event just isn't a big deal.
2001-10-09 20:51:19 +00:00
Barry Warsaw dca939899d Fix minor cut-and-paste typo. 2001-10-09 19:37:51 +00:00
Fred Drake e0063d20a7 Update the documentation for the isinstance() function to reflect recent
changes in the implementation.
Indented all descriptions consistently.
2001-10-09 19:31:08 +00:00
Barry Warsaw a55d132f08 Add documentation for the MIMEAudio class/module, contributed by
Anthony Baxter.
2001-10-09 19:14:17 +00:00
Fred Drake 938a8d723c Improve the documentation for the os.P_* constants used with the os.spawn*()
functions to include information about how they affect the operation of
those functions when used as the "mode" parameter.
This closes SF bug #468384.

Added warnings to the os.tempnam() and os.tmpnam() functions regarding their
security problem.  These warning mirror the warnings added to the runtime
by Skip Montanaro.
2001-10-09 18:07:04 +00:00
Fred Drake 92350b3a1f New markup: \note{...} and \warning{...} 2001-10-09 18:01:23 +00:00
Fred Drake 6959a2fcd7 Note that the values for Boolean options are case-insensitive. 2001-10-09 14:58:24 +00:00
Fred Drake b35f0ce2b8 Update the description of getboolean() to reflect the changes made by
SF patch #467580.
2001-10-08 16:03:20 +00:00
Tim Peters 0a1fc4e389 Remove code and docs for the OldProfile and HotProfile classes: code
hasn't worked in years, docs were wrong, and they aren't interesting
anymore regardless.
2001-10-07 03:12:08 +00:00
Fred Drake 8c2c3d301b Update the documentation to reflect the changes to ReferenceError. 2001-10-06 06:10:54 +00:00
Fred Drake bf88b68f38 Add documentation for the public API for weak reference objects. 2001-10-05 22:03:58 +00:00
Tim Peters 9835206268 A regexp example was rendered as
foo\d
when it was clearly intended to render as
    foo$
Fred, is this a right way to fix it?  If not, the earlier place in the
same paragraph that does render as
    foo$
is also wrong.
2001-10-05 20:06:47 +00:00
Fred Drake e8f47bb93a Remove some long-unsupported Mac OS modules.
This closes SF patch #460737.
2001-10-05 16:49:31 +00:00
Martin v. Löwis 244edc8985 Add chroot call. Implements feature #459267. 2001-10-04 22:44:26 +00:00
Fred Drake fcc16330a4 Update a couple of old addresses that point to CNRI. 2001-10-04 20:40:07 +00:00
Tim Peters 3899d74c10 Make clear that tuple() accepts the same kind of arguments as list(). 2001-10-04 06:53:20 +00:00
Fred Drake 6f3d82693a Expand the documentation of the low-level tracing/profiling interface.
This reflects what is currently in CVS, which may change before 2.2 is final.
2001-10-03 21:52:51 +00:00
Tim Peters 0481d24dd5 CVS patch [#466628] Doc changes for doctest patch (#466616), from
Tim Hochberg.  Doctest no longer searches imported objects.
2001-10-02 21:01:22 +00:00
Fred Drake d90f509b8f Fredrik tells me the truefalse parameter for boolean() is not part of the
public interface, so we can simplify the documentation.
2001-10-01 21:05:30 +00:00
Tim Peters 1350c07de3 Removed stray backslash (a typo -- my fault). 2001-10-01 20:25:26 +00:00
Tim Peters 20524dbf36 The description of dictionary comparison was out of date. Rather than
try to explain the complex general scheme we actually use now, I decided
to spell out only what equality means (which is easy to explain and
intuitive), leaving the other outcomes unspecified beyond consistency.
2001-10-01 20:22:45 +00:00
Fred Drake 6c81e2a44f "boolean" --> "Boolean" (per the style guide). 2001-10-01 17:04:10 +00:00
Fred Drake 0f0380a25f Fix some minor style-guide conformance bugs. 2001-10-01 17:04:10 +00:00
Fred Drake fe95e65668 Straighten out some markup.
"boolean" --> "Boolean" (per the style guide).
2001-10-01 17:03:48 +00:00
Fred Drake 73921b0eec Refer to the objects which define __len__(), __*item__(), and __iter__()
as container objects rather than as mapping objects (in the index entries).
Change the section heading and intro sentence to be a little more general,
since that's how things have actually evolved.
2001-10-01 16:32:13 +00:00
Fred Drake e9ba525c2b Clarify comments about mailbox objects being iterable. 2001-10-01 15:49:56 +00:00
Guido van Rossum e7877df595 Docs for SF patch #462628 2001-10-01 13:50:15 +00:00
Martin v. Löwis 0daad598d0 Patch #462122: add readline startup and pre_event hooks. 2001-09-30 21:09:59 +00:00
Martin v. Löwis 16dc7f44b1 Patch #462190, patch #464070: Support quoted printable in the binascii module.
Decode and encode underscores for header style encoding. Fixes bug #463996.
2001-09-30 20:32:11 +00:00
Tim Peters af5910f025 The execfile() docs imply it acts on locals same as exec. But in truth
it acts more like assigning to keys in locals(), i.e. modifications to
function locals aren't reflected in the locals when execfile() returns.
2001-09-30 06:32:59 +00:00
Tim Peters 1c33daf143 Correct docs for long(float). 2001-09-30 06:18:26 +00:00
Tim Peters d38b1c74f3 SF [#466125] PyLong_AsLongLong works for any integer.
Generalize PyLong_AsLongLong to accept int arguments too.  The real point
is so that PyArg_ParseTuple's 'L' code does too.  That code was
undocumented (AFAICT), so documented it.
2001-09-30 05:09:37 +00:00
Fred Drake ac1af8093e Handle PEP references the same way RFC references. 2001-09-29 19:07:22 +00:00
Guido van Rossum 0d68246f01 Fix two typos in the text about compile(), and add two caveats from
recent user feedback: you must end the input with \n and you must use
\n, not \r\n to represent line endings.
2001-09-29 14:28:52 +00:00
Skip Montanaro a1c3662e84 forgot to mark use of StringType and UnicodeType in the text. 2001-09-29 13:53:21 +00:00