Commit Graph

2212 Commits

Author SHA1 Message Date
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
Tim Peters 599db7de63 The list.sort() docs require a function that returns -1, 0 or +1. That's
never been true, and in particular implies cmp() can't be used(!).  Get
closer to the truth.
2001-09-29 01:08:19 +00:00
Fred Drake 7988e0249c Move XML-RPC-related docs to the "Internet Protocols" chapter.
Add entry for the SimpleXMLRPCServer module.
2001-09-28 22:03:40 +00:00
Fred Drake e486e0d066 Preliminary documentation for the SimpleXMLRPCServer module. 2001-09-28 22:02:21 +00:00
Fred Drake 3c10c68c0e Use consistent version annotations instead of something ad hoc. 2001-09-28 16:57:16 +00:00
Fred Drake bbf7a407e8 Added note about non-support of UNC paths on Windows.
This fixes SF bug #465447.
2001-09-28 16:14:18 +00:00
Fred Drake b387860c70 State that encode() and encodestring() append a newline to the input data
if it does not already end with a newline.
This fixes SF bug #463330.
2001-09-28 16:01:46 +00:00
Fred Drake 33f4d6d1db Add entries for the email and compiler packages. 2001-09-27 20:11:07 +00:00
Fred Drake 90e687863b Markup adjustments. 2001-09-27 20:09:39 +00:00
Fred Drake e2f9917f9f Migrate the compiler documentation from the Tools/compiler/doc/ directory.
Changes made to make it work in the new location.
2001-09-27 20:06:07 +00:00
Fred Drake 3fc291a1d7 Fix some markup errors. 2001-09-27 04:17:20 +00:00
Fred Drake b802a1e7fa Markup adjustment: \[...\] is math markup and does not translate well when
used with text as was done here.  Fixed so that the typeset version wraps
the warning text and the HTML version does not create images of the warning
text.
2001-09-27 04:16:27 +00:00
Barry Warsaw c5f8fe3a27 Updates do email package documentation for markup, style, and
organization.
2001-09-26 22:21:52 +00:00
Fred Drake a6a885b6aa Start making some markup adjustments; Barry has indicated he will work on
this before we finish the integration, along with some restructuring.
2001-09-26 16:52:18 +00:00
Barry Warsaw 5e634638e6 The email package documentation, currently organized the way I think
Fred prefers.  I'm not sure I like this organization, so it may change.
2001-09-26 05:23:47 +00:00
Fred Drake 5055545fc0 Clarified some points about the interface to the mmap() function.
This closes SF bug #448918.
2001-09-25 19:00:08 +00:00
Fred Drake c0765c2381 Minor changes. 2001-09-25 16:32:02 +00:00
Fred Drake c825280ea5 Revise the example to be more resiliant in the face of continued use after
the object has been pickled; don't mutate the instance dict in the
__getstate__() method.  Other minor changes for style.  Broke up the
displayed interactive session to get better page-breaking behavior for
typeset versions, and to point out an important aspect of the example.

This closes SF bug #453914.
2001-09-25 16:29:17 +00:00
Fred Drake 9081bb1d21 Added documentation for the SSL interface, contributed by Gerhard Häring.
This closes SF patch #461337.
2001-09-25 15:48:11 +00:00
Tim Peters 2c9aa5ea8d Generalize file.writelines() to allow iterable objects. 2001-09-23 04:06:05 +00:00
Tim Peters 8a9c284437 Make difflib.ndiff() and difflib.Differ.compare() generators. This
restores the 2.1 ability of Tools/scripts/ndiff.py to start producing
output before the entire comparison is complete.
2001-09-22 21:30:22 +00:00
Tim Peters e0b2d7ac9a Add a function to compute a class's method resolution order. This is
easy for 2.2 new-style classes, but trickier for classic classes, and
different approaches are needed "depending".  The function will allow
later code to treat all flavors of classes uniformly.
2001-09-22 06:10:55 +00:00
Fred Drake 038d26410d Note that files are iterable; describe what the iterator returns.
This closes SF bug #463738.
2001-09-22 04:34:48 +00:00
Fred Drake c69205526a Added reference to Tutorial section on user-defined exceptions for
information on defining new exceptions.
This closes SF bug #443559.
2001-09-21 21:12:30 +00:00
Fred Drake e0af35eb69 Fill in a few more descriptions for xml.parsers.expat. 2001-09-20 20:43:28 +00:00
Tim Peters 2e29bfbe1a Document new file() constructor, with the body of open()'s text, plus a
"new in 2.2" blurb at the end.  Replace open()'s text by pointing back
to file().
2001-09-20 19:55:29 +00:00
Marc-André Lemburg 494f2aea8e Docs and News item for the codecs.py additions. 2001-09-19 11:33:31 +00:00
Guido van Rossum 83eeef4b06 SF patch #461781 by Chris Lawrence: os.path.realpath - Resolve symlinks:
Once upon a time, I put together a little function
   that tries to find the canonical filename for a given
   pathname on POSIX. I've finally gotten around to
   turning it into a proper patch with documentation.
   On non-POSIX, I made it an alias for 'abspath', as
   that's the behavior on POSIX when no symlinks are
   encountered in the path.

   Example:
   >>> os.path.realpath('/usr/bin/X11/X')
   '/usr/X11R6/bin/X'
2001-09-17 15:16:09 +00:00
Tim Peters 5b7759f9db Fixed typo in new 'p' description. 2001-09-15 18:16:27 +00:00
Tim Peters 88091aae7e SF bug [#461674] struct 'p' format doesn't work (maybe)
Rewrote the 'p' description.
2001-09-15 18:09:22 +00:00
Tim Peters ad2dc3fc44 Update the warning about transporting marshals across boxes with different
ideas about sizeof(long).
2001-09-14 20:40:13 +00:00
Fred Drake f2a5f3f721 Markup adjustments for consistency. 2001-09-14 17:48:41 +00:00
Guido van Rossum f7fcf5eea6 SF patch #461413 (Gerhard Häring): Add STARTTLS feature to smtplib
This patch adds the features from RFC 2487 (Secure SMTP
   over TLS) to the smtplib module:

   - A starttls() function
   - Wrapper classes that simulate enough of sockets and
     files for smtplib, but really wrap a SSLObject
   - reset the list of known SMTP extensions at each call
     of ehlo(). This should have been the case anyway.
2001-09-14 16:08:44 +00:00
Fred Drake b9a96282f1 Admit that we'll never add the args for a "call" event to the profile
and trace functions; this now declares that None will be passed for the
"call" event.
This closes SF bug/suggestion #460315.
2001-09-13 16:56:43 +00:00
Fred Drake 098d7fae39 Document clearly that the only way to retrieve the return code from the
child processes is to use the Popen3 and Popen4 classes.
This fixes SF bug #460512.
2001-09-11 19:56:51 +00:00
Fred Drake 1c66f8965a Added entry for the hmac module. 2001-09-11 16:59:42 +00:00
Fred Drake aae8da18fd Documentation for the new login() method of the smtplib.SMTP class,
contributed by Gerhard Häring.
This is part of SF patch #460112.
2001-09-11 16:58:00 +00:00
Fred Drake 42706803cd Documentation for the new hmac module, contributed by Gerhard Häring.
This is part of SF patch #460112.
2001-09-11 16:56:09 +00:00
Fred Drake 2732cb4269 Added documentation on the getfirst() and getlist() methods of the
cgi.FieldStorage class.
This closes SF patch #453691.
2001-09-11 16:27:03 +00:00
Fred Drake 05a73b1f9a Update link to the PyOpenGL project in the "gl" module docs.
This closes SF bug #459256.
2001-09-06 19:23:03 +00:00
Fred Drake 00bb329521 Document the built-in iter() function. 2001-09-06 19:04:29 +00:00
Fred Drake a20c265aba Added an additional link to NIST information on secure hashing.
This closes SF bug #458785.
2001-09-06 18:59:43 +00:00
Fred Drake 4d17b303bb Several updates to cover omissions noted by Rich Salz.
This closes SF bug #458771.
2001-09-06 15:51:56 +00:00
Fred Drake f5072b9314 Document the "unixfrom" attribute of the rfc822.Message class.
Based on a patch by Skip Montanaro, this closes SF bug #458885.
2001-09-06 15:07:55 +00:00
Martin v. Löwis b0162f9afc Patch #416079: fix the debug string output when receiving telnet commands.
added all the telnet options known to arpa/telnet.h
added all the options registered with IANA as of today
added the possibility for the user to have it's own option negotiation callback
2001-09-06 08:51:38 +00:00
Skip Montanaro bb5a465ca9 typo... 2001-09-05 19:27:13 +00:00
Martin v. Löwis 44f8696171 Patch #428326: New class threading.Timer. 2001-09-05 13:44:54 +00:00
Fred Drake 757f7809e1 Add more detail to the descriptions of the shutil functions.
This closes SF bug #458223.
2001-09-04 18:26:27 +00:00
Fred Drake c05fc7dd9d Added documentation for sys.maxunicode and sys.warnoptions.
Fixed a markup error which caused an em dash to be presented as a minus sign.
This closes SF bug #458350.
2001-09-04 18:18:36 +00:00
Tim Peters 32f453eaa4 New restriction on pow(x, y, z): If z is not None, x and y must be of
integer types, and y must be >= 0.  See discussion at
http://sf.net/tracker/index.php?func=detail&aid=457066&group_id=5470&atid=105470
2001-09-03 08:35:41 +00:00
Fred Drake b86677079d Move the long minidom example to a separate file; \verbatiminput does the
right thing with page breaks in long examples, while the verbatim
environment does not.  This causes the example to wrap to the next page
instead of overwriting the page footer and bottom margin.
2001-09-02 06:07:36 +00:00
Fred Drake 481cf2c064 Added the "Host" header to the "GET" example.
This closes SF bug #457100.
2001-09-01 02:35:23 +00:00
Fred Drake 3c0fc84b15 Update the links to the FIPS document that defines the Secure Hash
Algorithm.  This closes SF bug #454917.
2001-08-30 14:42:40 +00:00
Tim Peters 692323488b Add a new function imp.lock_held(), and use it to skip test_threaded_import
when that test is doomed to deadlock.
2001-08-30 05:16:13 +00:00
Fred Drake d800cff80d Added explanation that [...] * n generates shallow copies of [...], so
the contents will be shared by multiple references.

This closes SF bug #455694.
2001-08-28 14:56:05 +00:00
Fred Drake 5cb29a49c8 Fix a number of minor markup errors, and improve the consistency a bit. 2001-08-28 14:25:03 +00:00
Eric S. Raymond 46ccd1dae5 Plant a mention in the description of backreferences of the fact that
while \0 doesn't do what one might expect, \g<0> does.
2001-08-28 12:50:03 +00:00
Michael W. Hudson 53da317801 Docs for the PEP 264 changes. 2001-08-27 20:02:17 +00:00
Guido van Rossum 88e0b5bee0 SF patch #454553 by Walter Dörwald: auto-guess content-type header for
ftp urls.
2001-08-23 13:38:15 +00:00
Skip Montanaro 0f10f84028 indicate that mktime is platform-dependent. See SF bug 434143. 2001-08-22 12:44:27 +00:00
Skip Montanaro 5ff41d16a8 indicate that the years for which the calendar function will work are
platform dependent.  See SF bug 434143.
2001-08-22 12:43:38 +00:00
Fred Drake 31d833d575 Added documentation for BoundedSemaphore(), contributed by Skip Montanaro.
This closes SF patch #452836.
2001-08-20 18:49:00 +00:00
Eric S. Raymond 29bb115bae Clean up some argument profiles, enrich the docstring. 2001-08-20 13:16:30 +00:00
Tim Peters dbec7d2c16 Improve Windows time.clock() blurb; was missing return type and unit. 2001-08-19 01:38:03 +00:00
Eric S. Raymond b60f2d0977 Framework code for compilerlike scripts. 2001-08-18 09:24:38 +00:00
Barry Warsaw dbfe5e8507 Document that uu.decode() will always raise a uu.Error if out_file
isn't given, and the file in the uu header already exists.  Also add a
description of the uu.Error exception class.
2001-08-17 20:01:06 +00:00
Fred Drake 739282da83 Re-write the description of the os.spawn*() functions, and cover the
whole family instead of just two.


This closes SF bug #451630.
2001-08-16 21:21:28 +00:00
Fred Drake ce575bac5e Fix a minor typo and mark an exception name that was missed. 2001-08-14 21:51:50 +00:00
Barry Warsaw 5ef99a0bc5 Describe the new semantics for setting and deleting a function's
__dict__ attribute.  Deleting it, or setting it to a non-dictionary
result in a TypeError.  Note that getting it the first time magically
initializes it to an empty dict so that func.__dict__ will always
appear to be a dictionary (never None).

Closes SF bug #446645.
2001-08-14 18:22:24 +00:00
Fred Drake 280f7253e4 Insert omitted "the". 2001-08-14 11:42:13 +00:00
Fred Drake bf781a95c0 Add the smtpd module to the list of undocumented modules; Barry needs to
write the documentation for this module.
2001-08-14 11:38:35 +00:00
Fred Drake 6943a29cbf David Goodger <dgoodger@atsautomation.com>:
Documentation for difflib/ndiff refactoring: more of the ndiff functionality
has been moved to the underlying library (difflib).

This closes SF patch #445413.
2001-08-13 19:31:59 +00:00
Fred Drake 84e58ab722 For the escape() function, added a reference to the quoteattrs() function
in xml.sax.saxutils, since that is the right function to use for quoting
attribute values.
This closes SF bug #444707.

Cleaned up a variety of other minor markup errors.
2001-08-11 03:28:41 +00:00
Fred Drake 1cf0f1751f Add a note that the quoteattr() function is useful for HTML and SGML
attributes as well.
2001-08-10 22:14:17 +00:00
Fred Drake d635e3c468 Added a warning about reference cycles and memory consumption to the
section on functions which return stack frames.

This closes SF bug #449258.
2001-08-10 17:37:33 +00:00
Fred Drake 6d8d72b0cb Usage fix, problem reported by Keith Briggs. 2001-08-10 16:15:08 +00:00
Fred Drake e89659c02d Added documentation for the new rich comparison support.
This closes SF patch #428320.

Added documentation for the new floordiv() and truediv() functions.
This is part of SF bug #449093.

Re-organized the listing of functions to get better logical grouping.
2001-08-10 15:55:09 +00:00
Martin v. Löwis 9b75dca192 Expose nl_langinfo through locale where available. 2001-08-10 13:58:50 +00:00
Martin v. Löwis 8cc965c1fb Patch #448474: Add support for tell() and seek() to gzip.GzipFile. 2001-08-09 07:21:56 +00:00
Fred Drake 3a5ec57456 Clean up some of the markup here -- be more consistent in the use of
semantic labels instead of presentational markup.
2001-08-08 05:39:29 +00:00
Fred Drake 58212724f2 Add a comment on time.time() returning non-decreasing values except when
the clock is set back.

This closes SF bug #447945.
2001-08-05 15:43:04 +00:00
Martin v. Löwis c9908c4f5c Document IPv6 changes. Contributed by itojun. 2001-08-04 22:22:45 +00:00
Fred Drake b3cc29b493 Note that the mimetypes.MimeTypes class was added in Python 2.2. 2001-08-04 00:48:49 +00:00
Fred Drake d5efb17086 Add documentation for the new aspects of the mimetypes module.
This closes the SF bug (feature request) #439710.
2001-08-03 21:03:14 +00:00
Fred Drake d86038d1be Apply the new \mailheader macro where appropriate, and fix a few small
markup inconsistencies.
2001-08-03 18:39:36 +00:00
Fred Drake 5d54879647 Fix some of the example code; the reference objects do not support a
get() method; just calling them is sufficient.  (There was a get() method
for this in an early version of the implementation.)

Reported by Mats Wichmann.
2001-08-03 03:50:28 +00:00
Fred Drake 51629c245a Add a caveat about boundary conditions and RE concatenation, so that the
documents do not make an overly-strong assertion about the properties of
RE concatenation.

Add an example of RE{m,} syntax and what it will and will not match.
2001-08-02 20:52:00 +00:00
Fred Drake 905dc558f1 Cleaned up the description of readline.set_completer().
Thanks to Nathaniel Gray for reporting the confusion.
2001-08-01 21:42:45 +00:00
Fred Drake e74f8de385 Added an example of a string value for the replacement parameter to
re.sub().
This closes SF bug #446136.

Fixed description of RE modifiers so that RE{#} and RE{#,} are more
clearly described and disambiguated (plain RE{#} had not been described
at all).  Reported by Jeremy Craven via email.
2001-08-01 16:56:51 +00:00
Fred Drake 630a63cafd Fix description of buffer_info(), and add a note that there is a better
way...

This closes SF bug #444842.
2001-08-01 16:50:49 +00:00
Fred Drake 43211ecda2 Make some adjustments to the markup, and fix up some style-guide issues. 2001-07-29 03:41:23 +00:00
Martin v. Löwis 66b6e192b9 Patch #416224: add readline completion to cmd.Cmd. 2001-07-28 14:44:03 +00:00
Greg Ward 54f65094c3 Typo fix. 2001-07-26 21:01:21 +00:00
Tim Peters 7321ec437b SF bug #444510: int() should guarantee truncation.
It's guaranteed now, assuming the platform modf() works correctly.
2001-07-26 20:02:17 +00:00
Martin v. Löwis 4f1cd8bdcb Patch #411138: Rename config.h to pyconfig.h. Closes bug #231774. 2001-07-26 13:41:06 +00:00
Skip Montanaro 41d7d58cc4 trivial rewording in footnote 5. 2001-07-25 16:18:19 +00:00
Fred Drake d61e3eab44 Add entry for the new distutils section. 2001-07-24 16:20:13 +00:00
Fred Drake 4fefcc3ce4 Overview comments for the distutils package, with links to the distutils
manuals for more information.  This is being added to make it easier to
find the documentation for the distutils code.
2001-07-24 16:19:24 +00:00
Fred Drake c547b46c06 Be more specific about corner cases in the description of the $ RE syntax,
and include an example where the MULTILINE flag makes a real difference.

This closes SF bug #441600.
2001-07-23 21:14:59 +00:00
Fred Drake 6fd3b22847 When explaining the enterabs() method, using the modern spelling of apply(),
and relax the type of the argument list from tuple to sequence.
2001-07-23 19:28:09 +00:00
Fred Drake 6fdb90c0ca Remove self-reference from the anydbm module.
This closes SF patch #443788.
2001-07-23 19:22:42 +00:00
Fred Drake 8a2adcf812 Typo: Added missing "if".
This is part of SF patch #442788.
2001-07-23 19:20:56 +00:00
Fred Drake c046e97dc2 Add StopIteration to the list of exceptions *not* derived from StandardError.
Slightly re-word discussion of SystemExit and fork().
This is part of SF patch #443788.
2001-07-23 19:19:39 +00:00
Fred Drake 63bc2e0fcb Convert the use of apply(f, args) to the new spelling: f(*args).
This is part of SF patch #443788.
2001-07-23 19:16:22 +00:00
Fred Drake f69868f304 Add a missing "\" to the markup. 2001-07-20 19:03:44 +00:00
Fred Drake 960fdf9ac3 Added the constants ascii_letters, ascii_lowercase, and ascii_uppercase
to the string module.  This was determined to be the right approach in
SF bug #226706.
2001-07-20 18:38:26 +00:00
Piers Lauder a3a1668904 apply patch item #416254 2001-07-20 11:04:19 +00:00
Fred Drake acd32d3be5 Added function xml.sax.saxutils.quoteattr().
This closes SF bug #440351.  It should not be moved to Python 2.1.1.
2001-07-19 16:10:15 +00:00
Fred Drake 53d285a9af Remove some false statements. 2001-07-19 03:49:33 +00:00
Andrew M. Kuchling 28bafb8b5d Fix a few typos 2001-07-19 01:17:15 +00:00
Fred Drake 72182027a8 "Make small changes, but carry a big diff."
Minor local consistency adjustments.
A couple of small tweaks to the setdlopenflags() description.
For setprofile() and settrace(), convert some references to become
hyperlinks in the HTML version.
2001-07-18 17:52:58 +00:00
Fred Drake 1a2302b3b2 Add some symbolic names to support hyperlinked references. 2001-07-18 17:40:19 +00:00
Fred Drake 5d808fba00 Made a few minor style & markup changes to the new {get,set}dlopenflags()
descriptions; added availability notes.
2001-07-18 16:35:05 +00:00
Martin v. Löwis f0473d511b Patch #412229: Add functions sys.getdlopenflags and sys.setdlopenflags.
Add dlopenflags to PyInterpreterState, and use it in dlopen calls.
2001-07-18 16:17:16 +00:00
Fred Drake efaef13c81 Update the availability information for os.tempnam(), os.tmpfile(), and
os.tmpnam().
2001-07-17 20:39:18 +00:00
Fred Drake e78661bf90 Fix a couple of minor markup nits.
Footnotes should be added *after* punctuation, not before.
(Yes, this should be merged with the descr branch.  Sorry, Tim!)
2001-07-17 05:17:58 +00:00
Barry Warsaw 95400a28e4 Updated the documentation in several respects:
- This module, despite its name, now should conform to RFC 2822, the
  update to RFC 822.

- This module doesn't just represent "email headers", but entire email
  messages.

- Added documentation for other useful public functions such as
  quote(), unquote(), praseaddr(), and dump_address_pair().
2001-07-16 20:47:58 +00:00
Fred Drake 687a17deaa Revise the description of time.clock() so that it correctly describes the
Windows version of the function as well as the Unix flavor.

This fixes SF bug #441357.
2001-07-16 15:40:57 +00:00
Fred Drake 8ee679f0ce Minor changes to match the style guide. 2001-07-14 02:50:55 +00:00
Fred Drake 4124a0b343 Correct a couple of errors noted by Alex Martelli. 2001-07-14 02:46:01 +00:00
Fred Drake 7fc8abb396 Remove comments about XML and HTML; those sections are no
longer part of this chapter.

Minor change to match the style guide.
2001-07-14 02:44:43 +00:00
Fred Drake 3d97e35a20 Add entry for xmlrpclib documentation. 2001-07-12 23:40:13 +00:00
Fred Drake 5ddf7adf84 Several markup adjustments so this will format and be more consistent with
the rest of the documnentation.
2001-07-12 23:39:24 +00:00
Fred Drake f4bdb57e15 Fix return value for m.group() for groups not in the part of the RE that
matched; reported by Paul Moore.

Wrapped several long lines.
2001-07-12 14:13:43 +00:00
Guido van Rossum bf5a774bcb On int/long to the negative int/long power, let float handle it
instead of raising an error.  This was one of the two issues that the
VPython folks were particularly problematic for their students.  (The
other one was integer division...)  This implements (my) SF patch
#440487.
2001-07-12 11:27:16 +00:00
Eric S. Raymond e304bb9eec First version of xmlrpclib docs. Probably has markup errors; is not complete,
could probably stand to have some of the internal things like Marshaller
documented.  But I think it does a decent job on the entry points and
externally visible things.

Fred and Fredrik, do your stuff!  You both need to proof this.
2001-07-12 02:39:45 +00:00
Fred Drake 682d5f3cda Follow the recommended practices for keystroke representation; this
improves internal consistency in the documentation.
2001-07-12 02:09:51 +00:00
Fred Drake 9bbc933fcb Added information about the timeout parameter to the poll() method for
polling objects.  This closes SF bug #439823.

Fixed a minor markup bug.
2001-07-11 18:48:39 +00:00
Fred Drake 907e76b620 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.
2001-07-06 20:30:11 +00:00
Fred Drake ab1df4fe88 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.

Add an index entry for the Telnet protocol.

Always refer to the protocol as Telnet instead of telnet.
2001-07-06 20:23:02 +00:00
Fred Drake 91f2f26d75 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.
2001-07-06 19:28:48 +00:00
Fred Drake 45c23e61d8 Explain the exit code for the wait() method, including a reference to
the os.W*() functions used to interpret the return value.

This fixes SF bug #429361.
2001-07-06 17:17:12 +00:00
Fred Drake bcd1df746d The fpectl module does not work on Windows, so remove Windows from the
\platform statement.

Also fix a minor style consistency nit in an example.
2001-07-05 21:17:08 +00:00
Fred Drake a939911345 Fix a markup error: do not omit a method's parameter list if it is
empty.
2001-07-05 21:14:03 +00:00
Fred Drake 25211f5724 Added more information on the differences between the htmllib and HTMLParser
modules.
2001-07-05 16:34:36 +00:00
Guido van Rossum 5fe2c139d5 List constraints on xrange() objects. 2001-07-05 15:27:19 +00:00
Guido van Rossum 3f56166b1a Rip out the fancy behaviors of xrange that nobody uses: repeat, slice,
contains, tolist(), and the start/stop/step attributes.  This includes
removing the 4th ('repeat') argument to PyRange_New().
2001-07-05 13:27:48 +00:00
Fred Drake 20006b2d51 Marked the parameters to Stats.print_*() as optional.
This closes SF bug #438032.
2001-07-02 21:22:39 +00:00
Tim Peters 4efb6e9643 Turns out Neil didn't intend for *all* of his gen-branch work to get
committed.

tokenize.py:  I like these changes, and have tested them extensively
without even realizing it, so I just updated the docstring and the docs.

tabnanny.py:  Also liked this, but did a little code fiddling.  I should
really rewrite this to *exploit* generators, but that's near the bottom
of my effort/benefit scale so doubt I'll get to it anytime soon (it
would be most useful as a non-trivial example of ideal use of generators;
but test_generators.py has already grown plenty of food-for-thought
examples).

inspect.py:  I'm sure Ping intended for this to continue running even
under 1.5.2, so I reverted this to the last pre-gen-branch version.  The
"bugfix" I checked in in-between was actually repairing a bug *introduced*
by the conversion to generators, so it's OK that the reverted version
doesn't reflect that checkin.
2001-06-29 23:51:08 +00:00
Fred Drake 0c209047ba Correct a markup error for an accented character.
Reported by Milan Zamazal <pdm@zamazal.org>.
2001-06-29 16:25:07 +00:00
Fred Drake 58c95391fa Removed some stray periods, and fix up a number of visible markup
consistency errors (mostly omitted "()" at the end of function and
method names).

Reported by Milan Zamazal <pdm@zamazal.org>.
2001-06-29 16:21:47 +00:00
Fred Drake f29ca18df3 SourceForge bug #437041:
Use a portable format in the example that creates a timestamp suitable for
use in email, also updating it and the footnote from RFC 822 to RFC 2822.
2001-06-29 15:39:53 +00:00
Fred Drake 9f9bd6af78 Simplify an example based on comment from Thomas Holenstein <thomas@hex.ch>:
Do not use an extra flag variable to test only once in one subsequent if
statement.
2001-06-29 14:59:01 +00:00
Thomas Wouters 69940973db Remove duplicate ', ' in dbhash.open()'s argument list. 2001-06-27 13:49:59 +00:00
Barry Warsaw e9218a1a8e Remove the restriction on a mapping's .update() method. 2001-06-26 20:32:59 +00:00
Tim Peters 3e7b1a04a0 Teach the types module about generators. Thanks to James Althoff on the
Iterators list for bringing it up!
2001-06-25 19:46:25 +00:00
Fred Drake b037d33245 Updated link to zlib's home page. 2001-06-25 15:30:13 +00:00
Andrew M. Kuchling e7e03cd0cf Fix typo 2001-06-23 16:26:44 +00:00
Eric S. Raymond ff00fdae23 Correct erroneous description of precmd. 2001-06-23 14:42:43 +00:00
Fred Drake 8058bfa6fc Contributed updates from Harald Hanche-Olsen, giving details of the branch
cuts for the complex math functions.  Includes a brief description of
what branch cuts are.
2001-06-23 03:16:29 +00:00
Fred Drake 307cb05764 Re-organize a little, clean up some markup.
Added some comments about sys.exit(), SystemExit, and preventing restricted
code from exiting the interpreter.

This closes SF bug #434743.
2001-06-22 18:21:53 +00:00
Fred Drake f66cb5d0eb Corrected an error in the information on supporting weak references in
extension types (the docs reflected a development version of the API).

This closes SF bug #435066.
2001-06-22 17:20:29 +00:00
Fred Drake 93438bf0a2 Fix & clean up the information about building Python with large file support
for Linux.

This closes SF bug #434975.
2001-06-22 16:01:20 +00:00
Fred Drake d5df09cfb6 Update to include the license information in a less annoying place. 2001-06-20 21:37:34 +00:00
Barry Warsaw 6016e39250 Document the new encodestring() and decodestring() functions. Also,
add some description of what the quotetabs argument does for the
encode*() functions.  Finally, add a "see also" pointing to the base64
module.
2001-06-19 19:44:42 +00:00
Martin v. Löwis 918f2c722a Document that filter is added in 2.2. 2001-06-16 08:14:04 +00:00
Fred Drake 54d10fd2cd Add a version annotation for the Q and q format codes. 2001-06-15 14:13:07 +00:00
Fred Drake 8fcd4b5ab3 Fix an improperly placed comma. 2001-06-14 13:57:16 +00:00
Fred Drake 4a6c5c568f Fixed reference to table notes for {}.keys() and {}.items() -- these
references did not get updated when the notes were renumbered in a
previous update.

This fixes SF bug #432208.
2001-06-12 03:31:56 +00:00
Tim Peters 7a3bfc3a47 Added q/Q standard (x-platform 8-byte ints) mode in struct module.
This completes the q/Q project.

longobject.c _PyLong_AsByteArray:  The original code had a gross bug:
the most-significant Python digit doesn't necessarily have SHIFT
significant bits, and you really need to count how many copies of the sign
bit it has else spurious overflow errors result.

test_struct.py:  This now does exhaustive std q/Q testing at, and on both
sides of, all relevant power-of-2 boundaries, both positive and negative.

NEWS:  Added brief dict news while I was at it.
2001-06-12 01:22:22 +00:00
Fred Drake 0b9bc20e66 Add the appropriate availability annotations for the popen*() family of
functions -- these are not available on traditional Mac OS platforms.

Corrected the version annotations for the spawn*() functions and related
constants; these were added in Python 1.6, not 1.5.2.
2001-06-11 18:25:34 +00:00
Fred Drake 046f4d810d Fixed parameter order for os.popen2(), os.popen3(), and os.popen(4). Added
a reference to these functions and popen() from the "Process Management"
section.

Based on a suggestion from comp.lang.python.
2001-06-11 15:21:48 +00:00
Fred Drake c115835457 Fix recent changes so that this section will format again. 2001-06-11 14:55:01 +00:00
Tim Peters 7b9542a3f7 Initial support for 'q' and 'Q' struct format codes: for now, only in
native mode, and only when config #defines HAVE_LONG_LONG.  Standard mode
will eventually treat them as 8-byte ints across all platforms, but that
likely requires a new set of routines in longobject.c first (while
sizeof(long) >= 4 is guaranteed by C, there's nothing in C we can rely
on x-platform to hold 8 bytes of int, so we'll have to roll our own;
I'm thinking of a simple pair of conversion functions, Python long
to/from sized vector of unsigned bytes; that may be useful for GMP
conversions too; std q/Q would call them with size fixed at 8).

test_struct.py:  In addition to adding some native-mode 'q' and 'Q' tests,
got rid of unused code, and repaired a non-portable assumption about
native sizeof(short) (it isn't 2 on some Cray boxes).

libstruct.tex:  In addition to adding a bit of 'q'/'Q' docs (more needed
later), removed an erroneous footnote about 'I' behavior.
2001-06-10 23:40:19 +00:00
Skip Montanaro 1dc98c44fe add warning about situation where code may be executed twice, once when
module is __main__ and once when module is imported.
2001-06-08 14:40:28 +00:00
Fred Drake 62f9d7c021 In the section on extending the profiler, add some additional discussion
about setting up the dispatch table, and update the OldProfile and
HotProfile classes to the current implementations, showing the adjusted
construction for the dispatch table.
2001-06-08 05:04:19 +00:00
Martin v. Löwis e2ccb89513 Document filter. 2001-06-07 19:01:24 +00:00
Martin v. Löwis e24fef0dd2 Fix bug #422702: Make flag argument to open optional, and document it that way. 2001-06-05 05:33:19 +00:00
Skip Montanaro b9d973dac5 is -> if in rename description 2001-06-04 15:31:17 +00:00
Fred Drake 81e142b907 Document os.getenv().
This closes SF bug #429059.
2001-05-31 20:27:46 +00:00
Fred Drake c19f39272e Some general cleanup of the threading module documentation, including
fixing the reference to Thread.getDeamon() (should be isDaemon()).

This closes SF bug #429070.
2001-05-31 20:24:07 +00:00
Fred Drake 6cba3d0e64 Added entry for HTMLParser documentation. 2001-05-30 04:59:50 +00:00
Fred Drake 3b755d43ac Michel Pelletier <michel@digicool.com>:
Documentation for the HTMLParser module, with small changes by FLD.
2001-05-30 04:59:00 +00:00
Fred Drake dc9e7e42c8 readlink() description: Added note that the return value may be either
absolute or relative.

remove(), rename() descriptions:  Give more information about the cross-
    platform behavior of these functions, so single-platform developers
    can be aware of the potential issues when writing portable code.

This closes SF patch #426598.
2001-05-29 18:13:06 +00:00
Fred Drake c80d4dd695 The parameter to the listen() method is not optional, but was marked as
optional in the documentation.

This closes SF bug #427985.
2001-05-29 15:37:45 +00:00
Fred Drake 56a71eee65 Add a version annotation for splitdrive(); old, but as long as I managed
to end up with the information, it is better recorded than lost.
2001-05-25 16:21:00 +00:00
Fred Drake c6d8f8d2ac Add descriptions of {}.iteritems(), {}.iterkeys(), and {}.itervalues()
in the table of mapping object operations.  Re-numbered the list of
notes to reflect the move of the "Added in version 2.2." note to the list
of notes instead of being inserted into the last column of the table.
2001-05-25 04:24:37 +00:00
Fred Drake 98cfab6523 One more update related to the new get() and setdefault() methods on the
Message object.
2001-05-22 22:00:40 +00:00