Commit Graph

2233 Commits

Author SHA1 Message Date
Tim Peters c7cb69263d For ratecv, document that None should be the initial state argument (when
I was squashing spurious overflows in the implementation, I got hung up
on this point).
2001-12-06 23:16:09 +00:00
Fred Drake a16433b14e Re-enabled debugging prints in poplib & documented the set_debuglevel()
method.
This closes SF patch #486079.
2001-12-05 22:37:21 +00:00
Fred Drake d761662b66 asyncore.loop() description contributed by Skip Montanaro.
This closes SF bug #489513.
2001-12-05 21:37:50 +00:00
Fred Drake 39368c1053 Added documentation of the sendall() method, and a note to the send() method
that it does not guarantee that all data is sent.
This closes SF patch #474307.
2001-12-05 05:25:59 +00:00
Fred Drake d2a557e51e Added entry for the "cgitb" module docs. 2001-12-04 22:48:17 +00:00
Fred Drake 6e70e8b401 Documentation for the "cgitb" module. 2001-12-04 22:47:42 +00:00
Fred Drake 97e3201220 Add a note that the rgbimg module is only built on 32-bit machines (prompted
by a question to webmaster).
Re-wrapped a long line.
2001-12-04 16:49:00 +00:00
Jeremy Hylton db5a93cd6a Update docs to reflect new compile() and compileFile() 2001-12-04 02:48:52 +00:00
Fred Drake b38784e4a0 Slightly improved indexing for the string-% operator, thanks to comments
from Skip Montanaro.  There is one weirdness in the final index for HTML, but
that is low priority.
2001-12-03 22:15:56 +00:00
Fred Drake 1a76386194 Added documentation on the ScrolledText module. 2001-12-03 21:18:30 +00:00
Fred Drake 5172adca81 Minor clarification of the zip() description, based on a comment sent to
python-docs.
2001-12-03 18:35:05 +00:00
Fred Drake 14f5c5fa01 Make no assumption about how modules are built when referring to them; this
can vary by platform and installation.
Based on suggestion to python-docs.
2001-12-03 18:33:13 +00:00
Fred Drake 1722e4a952 Re-word the intro slightly to avoid reader misunderstanding: strings are not
mutable!  We do not want to shock anyone.
This closes SF bug #483805.

Re-factor so that the description of the "access" keyword parameter is not
repeated in both the descriptions of mmap().  Also, only make sure the first
description of mmap() appears in the index.  The the index link is followed,
the first is now used to locate the page on the screen; chances are really good
both will be visible.  This avoids the problem that the index entry for the
second is selected and the first version is not visible, making the reader
consider that mmap() is not available on Windows.
2001-12-03 18:27:22 +00:00
Fred Drake 3570551d6f Remove most references to __members__ and __methods__, leaving only one pair
of references that now state that these attributes have been removed,
directing the reader to the dir() function.
This closes SF bug #456420.
2001-12-03 17:32:27 +00:00
Fred Drake b22c6720aa Clean up some material that is not part of the standard documentation.
This closes SF bug #487308.
2001-12-03 06:12:23 +00:00
Fred Drake d745b4e7a4 Add reference to the "String Methods" section to make that information
easier to find.  Based on the comment from Steve Alexander on the
zope-coders mailing list.
2001-12-02 15:10:46 +00:00
Fred Drake 0467775715 Add description of tkCommonDialog. 2001-11-30 19:24:49 +00:00
Fred Drake 10cd315963 Change the chapter title to reflect the Tk affinity.
Use the new seealso* environment in the section pointing out other GUI
toolkits.
2001-11-30 18:17:24 +00:00
Fred Drake 89d63cc450 Minor adjustments to markup for the getDOMImplementation() description. 2001-11-30 16:58:15 +00:00
Fred Drake bd34b6bc3d Added the convenience constants that are present in PyXML to make these
more similar.
2001-11-30 15:37:33 +00:00
Fred Drake 38f3b72f9f Updated documentation for the new httplib interface, by Kalle Svensson.
This closes SF bug #458447.
2001-11-30 06:06:40 +00:00
Fred Drake 44b6f84e56 More information about Tix support, contributed by Mike Clarkson. 2001-11-29 21:09:08 +00:00
Fred Drake 6995bb61b6 Various cleanups & markup fixes, mostly relating to the stat and statvfs
result object changes.
2001-11-29 20:48:44 +00:00
Fred Drake ed0a71911c Neil Schemenauer suggested a small improvement to one of the example REs. 2001-11-29 20:23:14 +00:00
Fred Drake 389aa17ad3 writeline() --> writelines()
This closes SF bug #487147.
2001-11-29 19:04:50 +00:00
Fred Drake 1cec7fab1d New section of regular expression examples contributed by Skip Montanaro,
with some extensions and changes from me.
This closes SF patch #472825.
2001-11-29 08:45:22 +00:00
Fred Drake 5107b4cf5f Re-arrange the modules in the "Internet Data Handling" chapter to try to
achieve a more sensible organization.
2001-11-28 07:50:45 +00:00
Fred Drake 6a6bb1828b Clarify that on some systems, lockf() using LOCK_EX requires that the file
is opened for writing; this closes SF bug #485342.

Added notes that file objects are also accepted in the place of file
descriptors.
2001-11-28 07:48:32 +00:00
Fred Drake 48704ee478 Add synopsis for the SimpleXMLRPCServer module; used in the chapter-level
list of modules.
2001-11-28 07:32:53 +00:00
Fred Drake c37b65ee10 Clean up some markup cruft. A number of the macros that take no
parameters (like \UNIX) are commonly entered using an empty group to
separate the markup from a following inter-word space; this is not
needed when the next character is punctuation, or the markup is the
last thing in the enclosing group.  These cases were marked
inconsistently; the empty group is now *only* used when needed.
2001-11-28 07:26:15 +00:00
Fred Drake b03d0cc45e Typo, spotted by Detlef Lannert. 2001-11-26 21:39:40 +00:00
Fred Drake fcb05ab512 Tk-related modules should no longer be listed here. 2001-11-26 21:38:50 +00:00
Fred Drake 2744f43f71 Fix typo, extra markup constructs.
This closes SF bug #485252.
2001-11-26 21:30:36 +00:00
Martin v. Löwis 560da62fc7 Rename get_referents to get_referrers. Fixes #483815. 2001-11-24 09:24:51 +00:00
Fred Drake e70dbe0fc5 Update the platform notes for the CGIHTTPServer module; it works on more
platforms now, and has since Python 2.0.
This closes SF bug #482943.
2001-11-19 05:16:35 +00:00
Fred Drake 7064d3b581 Fix the default value for feature_namespaces, per discussions on the XML-SIG
mailing list.  This causes the docs to match the default implementation.
2001-11-19 04:34:50 +00:00
Barry Warsaw 69ab5836ae Paul Rubin reminds me that of course a class's constructor /could/ get
called, if the pickler found a __getinitargs__() method.
2001-11-18 16:24:01 +00:00
Fred Drake ebbd14d7c2 Clarified a couple of issues for the startElement*() handlers:
- the attrs value may be re-used by the parser, so the implementation
  cannot rely on owning the object.
- an element with no namespace encountered in namespace mode will have a URI
  of None, not "" (startElementNS() only).

Fixed a couple of minor markup issues as well.
2001-11-18 04:58:28 +00:00
Tim Peters af0a883041 Relatively large expansion of the docs for gc.garbage. 2001-11-18 04:51:17 +00:00
Barry Warsaw 0c0565dd7f Toughen up the security warnings a bit. 2001-11-16 22:28:17 +00:00
Barry Warsaw 5e17d20743 Add a clarification that the email package always deals in native line
endings, and that it is smtplib's job to convert those to RFC 2821
line endings when sending the message.
2001-11-16 22:16:04 +00:00
Fred Drake 666ca80b63 Clean up some markup a little bit more. Make this work with the PDF format,
which is a little more strict than the other formats on some things (fixable,
but not tonight).
2001-11-16 06:02:55 +00:00
Fred Drake 5545219bf6 Document the urlsplit() and urlunsplit() functions. 2001-11-16 03:22:15 +00:00
Fred Drake c66ff203bb Switched a couple of sections around.
Cleaned up some markup nits.
Add a few more of the Tk-related modules to the list of modules.
2001-11-16 01:05:27 +00:00
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