Commit Graph

2189 Commits

Author SHA1 Message Date
Barry Warsaw 69b2d75fc7 A few minor updates to make it clear(er) that pickle should be used
instead of marshal for object serialization.

Fred, please proofread!
2001-11-15 23:55:12 +00:00
Barry Warsaw f595fd975d A massive rewrite affecting both the pickle and cPickle module
documentation.  This addresses previously undocumented parts of the
public interfaces, the differences between pickle and cPickle,
security concerns, and on and on.

Fred please proofread!
2001-11-15 23:39:07 +00:00
Barry Warsaw d44e7ad702 Minor updates to add more pointers to the pickle documentation, and to
clarify some of the interface.
2001-11-15 23:37:26 +00:00
Fred Drake fd4f069b12 The turtle docs will be moving to another location in the Tkinter chapter. 2001-11-15 22:10:46 +00:00
Fred Drake 482b9a8c0c Clean up the descriptions of multi-signature functions so we do the right
thing in the index.
2001-11-15 20:41:03 +00:00
Fred Drake 53556861df Add entries for the new Tkinter chapter. 2001-11-15 17:25:29 +00:00
Fred Drake 7cf4e5b329 Tkinter chapter, contributed by Mike Clarkson. Based in part on the "Tkinter
Life Preserver" by Matt Conway.
2001-11-15 17:22:04 +00:00
Tim Peters 5ebfd36afa CVS patch #477161: New "access" keyword for mmap, from Jay T Miller.
This gives mmap() on Windows the ability to create read-only, write-
through and copy-on-write mmaps.  A new keyword argument is introduced
because the mmap() signatures diverged between Windows and Unix, so
while they (now) both support this functionality, there wasn't a way to
spell it in a common way without introducing a new spelling gimmick.
The old spellings are still accepted, so there isn't a backward-
compatibility issue here.
2001-11-13 23:11:19 +00:00
Fred Drake da4ffeecf5 No need to have documentation for a module which not accepted in the library. 2001-11-09 21:45:55 +00:00
Barry Warsaw 3b0c82a2f1 Updated the documentation for formatdate(). 2001-11-09 17:08:13 +00:00
Fred Drake 30bd666c35 Cleaned up some markup stupidity and a usage problem reported by Detlef
Lannert.  Added descriptions of HTTP_PORT and HTTPS_PORT.
2001-11-09 05:03:05 +00:00
Fred Drake 399bc8c281 Fix a variety of typographical, grammatical, and clarity problems reported
by Detlef Lannert.
2001-11-09 03:49:29 +00:00
Fred Drake 0b66310476 When referring to a formal parameter from the description, use the name given
with the signature, not an ad hoc abbreviated form.
2001-11-07 06:28:47 +00:00
Fred Drake 66ded524ba apply() documentation: Remove a detail about the implementation that does
not affect the API.  Clean up the text about call syntax apply() is
equivalent to.  Based on comments by Thomas Guettler.
2001-11-07 06:22:25 +00:00
Fred Drake 1a670c8414 Adjust the module synopsis to avoid margin overruns in the PDF format. 2001-11-06 22:14:35 +00:00
Fred Drake 10b81ce4e5 A variety of small cleanups, including one to avoid a margin overrun in the
PDF version.
2001-11-06 22:13:19 +00:00
Fred Drake 5976816698 Remove stray quotes; probably left over from conversion from docstrings. 2001-11-06 22:11:34 +00:00
Fred Drake 806d332f02 Remove extra period. 2001-11-06 22:10:47 +00:00
Andrew M. Kuchling 1f774b062e Update obsolete e-mail address, and remove myself as a module author 2001-11-05 21:34:36 +00:00
Andrew M. Kuchling 4794f0b234 Update obsolete e-mail address 2001-11-05 21:31:33 +00:00
Andrew M. Kuchling 47ccfe2d8f Remove obsolete e-mail address 2001-11-05 21:31:15 +00:00
Andrew M. Kuchling f010df4ee5 Update URL, and remove e-mail address reference (readers can get it from
the Web page)
2001-11-05 21:30:10 +00:00
Barry Warsaw 2bb077f630 Finally fleshed out the examples section with 4 code samples! Some of
my own doing, some originally written by Matthew Dixon Cowles.
2001-11-05 17:50:53 +00:00
Andrew M. Kuchling c44403995e Remove email*.tex subsections; they're all \input by email.tex 2001-11-05 01:55:43 +00:00
Andrew M. Kuchling 43dc1fc926 Minor grammar and typo fixes 2001-11-05 01:55:03 +00:00
Tim Peters 169ded0d68 Finish SF patch 477059: __del__ on new classes vs. GC.
Just doc and NEWS here, about the change in gc.garbage meaning.
2001-11-03 19:57:21 +00:00
Tim Peters 7533587d43 Improved error msg when a symbolic group name is redefined. Added docs
and NEWS.  Bugfix candidate?  That's a dilemma for Anthony <wink>:  /F
did fix a longstanding bug here, but the fix can cause code to raise an
exception that previously worked by accident.
2001-11-03 19:35:43 +00:00
Andrew M. Kuchling bc4a1c2588 [Patch #476612] Change docs to describe PEP247 interface 2001-11-02 21:44:09 +00:00
Fred Drake d9272d6f11 Add deprecation notice to statcache. 2001-11-02 20:20:19 +00:00
Fred Drake 67bd68392c Make sure there are no weird nesting behaviors; the PDF version will not
format if there are (building the "bookmarks" for the reader breaks).
2001-11-02 19:41:23 +00:00
Fred Drake 99de218cfc Promote file objects out of the "Other Objects" category, so they become
visible in the table of contents.
2001-10-30 06:23:14 +00:00
Fred Drake b4ea9d0502 Promote built-in functions to come before built-in types. 2001-10-30 06:22:02 +00:00
Tim Peters 003047a5f2 Mention the new file() builtin in the section on file objects. 2001-10-30 05:54:04 +00:00
Tim Peters a427a2b8d0 Rename "dictionary" (type and constructor) to "dict". 2001-10-29 22:25:45 +00:00
Fred Drake 589abb7212 Add additional information on exceptions from time.mktime() and related to
improper time tuples passed to various functions.  Based on comments from
Andreas Jung.
2001-10-29 18:01:24 +00:00
Fred Drake e21e2bb121 Fix up a number of small problems with the DOM documentation.
There's still a lot to do, but it's better now.
2001-10-26 20:09:49 +00:00
Fred Drake 41cf5e0069 Remove unused variable. 2001-10-26 19:50:26 +00:00
Fred Drake ef428a292a Explain what [].insert() does when the target index is negative. 2001-10-26 18:57:14 +00:00
Fred Drake d5be3b75dd Add notes pointing out that these classes are kept for backward compatibility
and suggeest that new code that does not require compatibility with older
Python versions subclass dictionary, list, or str.
2001-10-26 18:37:27 +00:00
Fred Drake 7408da54e2 Many, many small fixes and improvements, most suggested by Detlef Lannert. 2001-10-26 17:40:22 +00:00
Fred Drake ef7d08a661 Some style changes and typo fixes. 2001-10-26 15:04:33 +00:00
Fred Drake de3d060eb2 Typo: destuction --> destruction
Reported by Thomas Heller.
2001-10-26 11:27:54 +00:00
Tim Peters 1fc240e851 Generalize dictionary() to accept a sequence of 2-sequences. At the
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).
2001-10-26 05:06:50 +00:00
Fred Drake 7f10cce4c1 Enforce a bit of markup consistency.
When describing a Boolean return value, use "true" and "false" instead of
"1" and "0".
Style-guide conformance:  no "iff" -- to obscure for many readers.  ;-(
2001-10-26 03:04:23 +00:00
Fred Drake 3a2c462436 Minor textual adjustment, and style-guide conformance (no use of "iff"). 2001-10-26 03:00:39 +00:00
Barry Warsaw 107771a228 Applying proposed patch for bug #474583, optional support for
non-standard but common types.  Including Martin's suggestion to add
rejected non-standard types from patch #438790.  Specifically,

guess_type(), guess_extension(): Both the functions and the methods
grow an optional "strict" flag, defaulting to true, which determines
whether to recognize non-standard, but commonly found types or not.

Also, I sorted, reformatted, and culled duplicates from the big
types_map dictionary.  Note that there are a few non-equivalent
duplicates (e.g. .cdf and .xls) for which the first will just get
thrown away.  I didn't remove those though.

Finally, use of the module as a script as grown the -l and -e options
to toggle strictness and to do guess_extension(), respectively.

Doc and unittest updates too.
2001-10-25 21:49:18 +00:00
Fred Drake 61f794918f Typo: NamedNodeList --> NamedNodeMap 2001-10-25 20:42:57 +00:00
Fred Drake bc006af3d0 Make the deprecation notice use the same form as other such notices.
This has sat around in a deprecated state for a *long* time!
2001-10-24 21:56:59 +00:00
Fred Drake 0559d95fd6 Minor revision of the text. 2001-10-24 21:10:52 +00:00
Tim Peters 98791affc8 Doc and NEWS changes due to Jeremy adding traceback objects to gc. 2001-10-23 01:59:54 +00:00
Barry Warsaw d05e051aa7 Fixed an example in the use of email.Utils.getaddresses(). The
failobj has to be a list or the `+' can fail.
2001-10-22 20:53:45 +00:00
Fred Drake 5d9a6b575c Clarify that the resource module does not attempt to mask platform
differences by defining symbols not defined on particular platforms.
This closes SF bug #473433.
2001-10-22 14:18:23 +00:00
Andrew M. Kuchling 9dbc0bcf9d Update description of border() 2001-10-20 16:07:41 +00:00
Fred Drake 0aa811c527 Use the \note and \warning macros where appropriate. 2001-10-20 04:24:09 +00:00
Fred Drake aad8bb5d7a When stating that some parameters to makefile() are similar to the open()
parameters, given a hyperlink to the right part of the documentation to
make it easier to look those up.  Also, refer to the file() function/
constructor instead of open() now that that is where the actual docs for
those parameters live.
This closes SF bug #472004.
2001-10-19 17:22:29 +00:00
Marc-André Lemburg b5507ecd3c Additional test and documentation for the unicode() changes.
This patch should also be applied to the 2.2b1 trunk.
2001-10-19 12:02:29 +00:00
Barry Warsaw e736d93eab Added a note about the somewhat kludgey behavior of the message
epilogue, based on the discussion in this SF bug report:

https://sourceforge.net/tracker/index.php?func=detail&aid=472481&group_id=25568&atid=384678
2001-10-19 04:34:42 +00:00
Guido van Rossum b6c1d5239c SF patch #443759: Add Interface to readline's add_history
This was submitted by Moshe, but apparently he's too busy to check it
in himself.  He wrote:

    Here is a function in GNU readline called add_history,
    which is used to manage the history list. Though Python
    uses this function internally, it does not expose it to
    the Python programmer. This patch adds direct interface
    to this function with documentation.

    This could be used by friendly modules to "seed" the
    history with commands.
2001-10-19 01:18:43 +00:00
Fredrik Lundh a5e616510e changed misleading argument name 2001-10-18 20:58:25 +00:00
Barry Warsaw 91b81c4802 Some minor clarifications for find()'s arguments based on SF bug
#463572.  Closing.
2001-10-18 19:41:48 +00:00
Fred Drake db7287c0f5 Straighten out the exec*() function descriptions a bit, and clarify a few
points in the spawn*() description.
2001-10-18 18:58:30 +00:00
Fred Drake ca836f7e65 Function descriptions must end as well as start! 2001-10-18 14:26:08 +00:00
Martin v. Löwis c405133fce Elaborate on types and meaning of the setgroups arguments. 2001-10-18 14:07:12 +00:00
Martin v. Löwis 61c5edf6fc Expose setgroups. Fixes feature request #468116. 2001-10-18 04:06:00 +00:00
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
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 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
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 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
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
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
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
Fred Drake 6c81e2a44f "boolean" --> "Boolean" (per the style guide). 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 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
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
Skip Montanaro c7ba0c4c24 added description of StringTypes object 2001-09-29 13:49:41 +00:00
Fred Drake 2b05ca3454 Minor markup improvement. 2001-09-29 05:01:59 +00:00