Commit Graph

4215 Commits

Author SHA1 Message Date
Skip Montanaro fb85739494 Point out that %p has no effect on the output hour in strptime unless %I is
used to parse the hour.
2004-05-10 18:53:00 +00:00
Raymond Hettinger e7169eb9ed Add more examples. 2004-05-09 01:15:01 +00:00
Fred Drake e143bbb610 fix documentation for ContentHandler.ignorableWhitespace()
(closes SF bug #881707)
2004-05-06 03:47:48 +00:00
Andrew M. Kuchling 99872c1342 [Bug #810879] Document that copyfile() can fail if you don't have permissions; also, fix a double negative. 2004-05-05 17:21:51 +00:00
Brett Cannon 0fefc140aa Fix small grammatical mistake. 2004-05-05 16:49:11 +00:00
Fred Drake 8aa8c84d18 add an index entry for __getnewargs__() 2004-05-05 04:56:06 +00:00
Fred Drake 0de77d1d6e - note that __getinitargs__() is only for old-style classes
- describe __getnewargs__()
(closes SF bug #873246)
2004-05-05 04:54:37 +00:00
Fred Drake 04d92c37f2 Remove list of pickle protocol names used by the copy module; there
are enough subtleties to pickling that we don't want misunderstanding
to spread because we don't provide all the information twice.  The
reference to the pickle module for information will have to suffice;
at least only one portion of the docs will be out of date.  ;-(
2004-05-05 04:24:30 +00:00
Fred Drake cee8879a7d note that the error code for socket.gaierror will be one of the EAI_*
constants
(closes SF bug #837929)
2004-05-05 04:18:11 +00:00
Greg Ward 4fe97ca4ce SF #814606: merge from release23-maint branch: clarify/cleanup
mixer docs; trim \platform{}, add \versionadded{}.
2004-05-05 01:36:16 +00:00
Phillip J. Eby 5068c873e6 Document readline module functions added in Python 2.3. See:
http://mail.python.org/pipermail/python-dev/2003-September/037922.html

for background.  It appears I forgot to ever submit a bug report or patch.
2004-05-04 19:20:22 +00:00
Raymond Hettinger d7911a3317 Minor documentation nits. 2004-05-01 08:31:36 +00:00
Raymond Hettinger f5f9a370d4 Add an example application to the docs. 2004-04-30 22:52:50 +00:00
Fred Drake 6fbf703fa2 the headers in an HTTP request are HTTP headers, not MIME headers 2004-04-29 02:47:38 +00:00
Fred Drake ceeb1918a1 remove out-of-date count of the functions in winsound 2004-04-28 03:57:47 +00:00
Fred Drake 0ed663443e really scream out that people should use the file objects instead of
file descriptor operations for normal applications
2004-04-16 15:20:01 +00:00
Skip Montanaro 10659f2540 bring description of optional and keyword args for DictReader and DictWriter
classes into line with the actual code.  I didn't see any obvious examples
of latex formatting for *args and **kwds so I just guessed.
2004-04-16 03:21:01 +00:00
Fred Drake 8efc74d35e remove bogus markup that caused the docs to be wrong 2004-04-15 06:18:48 +00:00
Fred Drake 6b3b046ab0 fix up some markup 2004-04-09 18:26:40 +00:00
Fred Drake 94ffbb71a8 give rational filenames to some of the generated HTML 2004-04-08 19:44:31 +00:00
Neal Norwitz ba813e2089 #928751, fix typos in socket doc 2004-04-03 18:02:37 +00:00
Fred Drake 8123ff6bca remove out-of-date warning 2004-03-26 17:11:10 +00:00
Fred Drake 504ca68e20 Note that reading from a socket may not always return all of the
remaining content of a stream when expected to do so.
Closes SF bug #725265.  Should be backported to Python 2.3.x.
2004-03-25 16:51:12 +00:00
Fred Drake 267b062432 - make sure the methods minidom adds to the basic DOM are attributed
to Node objects in the index (closes SF bug #832251)
- fix a variety of markup nits

Someone should backport this patch to Python 2.3.x.
2004-03-25 16:39:46 +00:00
Fred Drake 2f00c5453e fix typo 2004-03-25 16:14:17 +00:00
Fred Drake f39c3c7a6b note that distutils API docs are included in "Distributing Python
Modules"
2004-03-25 16:12:08 +00:00
Nicholas Bastin c69ebe8d50 Enable the profiling of C functions (builtins and extensions) 2004-03-24 21:57:10 +00:00
Fred Drake fee6f33e08 more markup nits 2004-03-23 21:40:07 +00:00
Fred Drake e05c3e0fbb fix markup nits 2004-03-23 20:30:59 +00:00
Nicholas Bastin 824b1b2da8 Added command line options for profile.py - one for stats output file
and one for sort order when using stdout.  Uses optparse.
2004-03-23 18:44:39 +00:00
Nicholas Bastin 1eb4bfc657 Added global runctx function to profile to fix SF Bug #716587 2004-03-22 20:12:56 +00:00
Nicholas Bastin 07973dab97 Modified string.split documentation to reflect behaviour of splitting emtpy string. Closes SF bug #811604 2004-03-21 16:59:59 +00:00
Skip Montanaro 20a8336ff7 concrete example of why retaining old objects is good 2004-03-21 16:05:30 +00:00
Brett Cannon 8b6cc2e7f2 Removed extra period from \versionchanged entry; macro adds period
automatically.
2004-03-21 14:10:18 +00:00
Brett Cannon 508c57d544 Clarify docs on where .pth files can exist. 2004-03-20 21:41:28 +00:00
Raymond Hettinger fe703e0650 SF bug #918371: hasattr()'s return type
Replace 1 and 0 with True and False.
2004-03-20 18:25:31 +00:00
Skip Montanaro 8e6ad6fbe9 Expand on the semantics of reload(). Closes #919099. 2004-03-19 15:20:16 +00:00
Hye-Shik Chang 5c5316f111 Add a new unicode codec: ptcp154 (Kazakh) 2004-03-19 08:06:07 +00:00
Brett Cannon d1de45f549 Fix capitalization of title for subsection 2. 2004-03-18 07:37:15 +00:00
Skip Montanaro bdda9f389a The example files need to be opened with the "b" flag. 2004-03-17 01:24:17 +00:00
Raymond Hettinger 49f9bd15ff SF feature request #686323: Minor array module enhancements
array.extend() now accepts iterable arguments implements as a series
of appends.  Besides being a user convenience and matching the behavior
for lists, this the saves memory and cycles that would be used to
create a temporary array object.
2004-03-14 05:43:59 +00:00
Hye-Shik Chang 9168c70438 SF Patch #912462: Relocate \end tag to the right place.
(Submitted by George Yoshida)
2004-03-09 05:53:15 +00:00
Raymond Hettinger 31017aed36 SF #904720: dict.update should take a 2-tuple sequence like dict.__init_
(Championed by Bob Ippolito.)

The update() method for mappings now accepts all the same argument forms
as the dict() constructor.  This includes item lists and/or keyword
arguments.
2004-03-04 08:25:44 +00:00
Brett Cannon d1080a3418 Have strftime() check its time tuple argument to make sure the tuple's values
are within proper boundaries as specified in the docs.

This can break possible code (datetime module needed changing, for instance)
that uses 0 for values that need to be greater 1 or greater (month, day, and
day of year).

Fixes bug #897625.
2004-03-02 04:38:10 +00:00
Raymond Hettinger 0a4977c2f3 Replace left(), right(), and __reversed__() with the more general purpose
__getitem__() and __setitem__().

Simplifies the API, reduces the code size, adds flexibility, and makes
deques work with bisect.bisect(), random.shuffle(), and random.sample().
2004-03-01 23:16:22 +00:00
Raymond Hettinger 738ec90ca1 Improvements to collections.deque():
* Add doctests for the examples in the library reference.
* Add two methods, left() and right(), modeled after deques in C++ STL.
* Apply the new method to asynchat.py.
* Add comparison operators to make deques more substitutable for lists.
* Replace the LookupErrors with IndexErrors to more closely match lists.
2004-02-29 02:15:56 +00:00
Neal Norwitz fb0521f153 Use versionadded for new features 2004-02-28 16:00:23 +00:00
Neal Norwitz 3e0877ef88 Add version changed/added to doc 2004-02-28 15:19:33 +00:00
Fred Drake 59e02c110d fix typo in reference to RFC 3464 DSN MIME type 2004-02-24 20:58:10 +00:00
David Ascher e2b4b32025 Implementation of patch 869468
Allow the user to create Tkinter.Tcl objects which are
just like Tkinter.Tk objects except that they do not
initialize Tk. This is useful in circumstances where the
script is being run on machines that do not have an X
server running -- in those cases, Tk initialization fails,
even if no window is ever created.

Includes documentation change and tests.

Tested on Linux, Solaris and Windows.

Reviewed by Martin von Loewis.
2004-02-18 05:59:53 +00:00
Walter Dörwald 70a6b49821 Replace backticks with repr() or "%r"
From SF patch #852334.
2004-02-12 17:35:32 +00:00
Raymond Hettinger 5de33786a9 SF patch #892821: example for urllib2 has SyntaxError
(Contributed by George Yoshida.)
2004-02-08 20:25:01 +00:00
Raymond Hettinger 4c9800d663 SF bug #892854: typo in textwrap doc page
(Reported by Drew Perttula.)
2004-02-08 18:09:32 +00:00
Raymond Hettinger 5c5eb86347 * Incorporate Skip's suggestions for documentation (explain the word deque
comes from and show the differences from lists).
* Add a rotate() method.
2004-02-07 21:13:00 +00:00
Skip Montanaro 7209294112 a couple other sunos4 support items removed 2004-02-07 12:50:19 +00:00
Raymond Hettinger c058fd14a9 * Fix ref counting in extend() and extendleft().
* Let deques support reversed().
2004-02-07 02:45:22 +00:00
Raymond Hettinger 3ba85c2e8a Have deques support high volume loads. 2004-02-06 19:04:56 +00:00
Fred Drake 21ae4f983e minor markup adjustments 2004-02-03 20:55:15 +00:00
Fred Drake 4458ece4d7 Clarify minor point about the ref() and proxy() constructors.
This matches what is already documented for corresponding feature of the C API.
2004-02-03 19:44:26 +00:00
Raymond Hettinger dd256d97cc Add documentation for collections.deque(). 2004-01-29 07:35:45 +00:00
Raymond Hettinger e52f3b1e56 Add documentation for collections.deque(). 2004-01-29 07:27:45 +00:00
Raymond Hettinger 756b3f3c15 * Move collections.deque() in from the sandbox
* Add unittests, newsitem, and whatsnew
* Apply to Queue.py mutex.py threading.py pydoc.py and shlex.py
* Docs are forthcoming
2004-01-29 06:37:52 +00:00
Fred Drake bd12b181c8 fix whitespace style (inconsistent with the rest of the docs) 2004-01-27 21:08:04 +00:00
Fred Drake fcc51767bd update signature of the socket constructor
(could someone backport this to Python 2.3.x please?)
2004-01-27 18:21:26 +00:00
Fred Drake ee3c6074c3 add missing period 2004-01-26 19:40:18 +00:00
Fred Drake 913829cb1d fix markup 2004-01-26 19:39:13 +00:00
Skip Montanaro db8d1c26d3 add references between getopt and optparse docs 2004-01-26 19:30:21 +00:00
Fred Drake 226f697560 fix method name in example code 2004-01-23 04:05:27 +00:00
Fred Drake 1fe9750200 add direct link to the article in DDJ
closes SF bug #871402
2004-01-21 18:30:28 +00:00
Skip Montanaro ba0485a92d expand on notion of row object type 2004-01-21 13:47:04 +00:00
Skip Montanaro 7895146c40 typo 2004-01-21 13:34:35 +00:00
Raymond Hettinger 734fb5724f Add a Guido inspired example for groupby(). 2004-01-20 20:04:40 +00:00
Hye-Shik Chang 3e2a306920 Add CJK codecs support as discussed on python-dev. (SF #873597)
Several style fixes are suggested by Martin v. Loewis and
Marc-Andre Lemburg. Thanks!
2004-01-17 14:29:29 +00:00
Fred Drake 621b443b8d - add warning that hotshot doesn't work well with threads
- fix some markup
2004-01-16 17:30:16 +00:00
Fred Drake 990a46b732 minor markup improvements 2004-01-16 16:07:04 +00:00
Fred Drake 3bbd115735 markup changes 2004-01-13 23:41:32 +00:00
Andrew M. Kuchling 44a98237d8 [Bug #873205] Update URL 2004-01-11 23:00:16 +00:00
Sjoerd Mullender 7e6bbe1516 The format of the string data used in the imageop module is described
as "This is the same format as used by gl.lrectwrite() and the imgfile
module."  This implies a certain byte order in multi-byte pixel
formats.  However, the code was originally written on an SGI
(big-endian) and *uses* the fact that bytes are stored in a particular
order in ints.  This means that the code uses and produces different
byte order on little-endian systems.

This fix adds a module-level flag "backward_compatible" (default not
set, and if not set, behaves as if set to 1--i.e. backward compatible)
that can be used on a little-endian system to use the same byte order
as the SGI.  Using this flag it is then possible to prepare
SGI-compatible images on a little-endian system.

This patch is the result of a (small) discussion on python-dev and was
submitted to SourceForge as patch #874358.
2004-01-10 20:43:43 +00:00
Andrew M. Kuchling c62af02ced Fix some digicool addresses I noticed 2004-01-08 15:01:08 +00:00
Fred Drake 115147921c add link to the red-dove.com page about the logging package 2004-01-08 14:59:02 +00:00
Raymond Hettinger 91f5cbe264 SF bug #872461: list.extend() described as experimental 2004-01-08 00:31:50 +00:00
Raymond Hettinger c14149e6ef Show how to re-enable GC during timings. 2004-01-04 21:19:18 +00:00
Barry Warsaw ad9aaeea6d Documentation for new RFC 3548 functions. 2004-01-04 01:14:01 +00:00
Fred Drake 6237ef1ddc in the section "The interpreter stack":
- rearranged a bit to avoid duplicated information
- provide more complete (and hopefully less confusing) descriptions of
  the return values for most of these functions
  (close SF bug #563298)
2004-01-01 07:21:14 +00:00
Raymond Hettinger 621c53ee9f Add sets to list of picklable objects. 2004-01-01 05:53:51 +00:00
Fred Drake fcadf6bdaf fix reference to File Object documentation
closes SF bug #825810
2004-01-01 03:41:27 +00:00
Raymond Hettinger 9b4dab4da1 SF patch #859286: documentation bool change fix
(Contributed by George Yoshida.)
2003-12-31 18:37:28 +00:00
Fred Drake a180581511 use conventional whitespace in interactive example 2003-12-31 07:41:52 +00:00
Guido van Rossum 50e7a11af1 Correct misrepresentation of print (it uses str(), not `...` for
conversion).  Hopefully I've not messed up the formatting.
2003-12-31 06:32:38 +00:00
Fred Drake af78512712 - general markup cleanup
- rearrange so two small sections become one; this avoids an extra
  page in the HTML format
2003-12-31 05:18:46 +00:00
Fred Drake 7f8d17a50c general markup improvements 2003-12-31 05:01:23 +00:00
Fred Drake 188b2d6cfa - add link to the datetime module 2003-12-31 04:52:36 +00:00
Fred Drake ceb1fd2177 - update description of isleap()
- add link to the datetime module
2003-12-31 04:51:56 +00:00
Fred Drake 6f51a72a61 - use the same markup for the deprecation as for that of
file.xreadlines()
2003-12-31 04:41:47 +00:00
Fred Drake ae55d5f3cb - add a "See also" reference to the doctest module
- slightly simplify a couple of examples
- clean up some markup
2003-12-31 04:34:50 +00:00
Fred Drake 32fef9f477 fix truly evil markup typo 2003-12-30 23:08:14 +00:00
Fred Drake ea49de34c9 minor cleanup of example 2003-12-30 23:01:19 +00:00
Fred Drake ff381e13e0 - we *really* don't care about Python 1.5 alphas any more!
- note the interpreter's -S option
2003-12-30 22:51:32 +00:00
Fred Drake 401d1e3cbf fix a variety of markup bugs 2003-12-30 22:21:18 +00:00
Fred Drake f161c915bd work around whitespace bugs in the HTML version 2003-12-30 22:17:16 +00:00
Fred Drake dcf32a676e fix markup errors 2003-12-30 20:48:59 +00:00
Fred Drake b0e8f5d0fe lots of markup adjustments 2003-12-30 20:36:20 +00:00
Fred Drake 7c67cb8fba markup fix 2003-12-30 17:17:17 +00:00
Fred Drake 4922cae1e1 - remove crufty markup that's no longer needed to make the
presentation work right (and didn't work anyway)
- fix minor typo
2003-12-30 16:18:23 +00:00
Fred Drake 42713109d9 use consistent email address for Tim 2003-12-30 16:15:35 +00:00
Fred Drake 34929f23f5 - update Tim's email address
- remove spurious blank lines
2003-12-30 16:12:27 +00:00
Andrew M. Kuchling 91ca8de6f4 [Bug #850818] Accept Gregory H. Ball's suggested rewrite of a confusing description 2003-12-23 17:01:38 +00:00
Andrew M. Kuchling 7a3786cc55 [Bug #857821] Remove mention of deprecated string.{atol,atof} functions. (Patch from Gerrit Holl) 2003-12-23 16:53:34 +00:00
Fred Drake 828f847d66 minor markup adjustment 2003-12-18 20:58:34 +00:00
Andrew M. Kuchling 3435820842 Fix typo 2003-12-18 13:28:35 +00:00
Fred Drake 852fe0689a fix loss of a space after indexing markup 2003-12-18 06:26:56 +00:00
Raymond Hettinger b606b3d08a Guido grants a Christmas wish:
sorted() becomes a regular function instead of a classmethod.
2003-12-17 20:50:46 +00:00
Raymond Hettinger 64958a15d7 Guido grants a Christmas wish:
sorted() becomes a regular function instead of a classmethod.
2003-12-17 20:43:33 +00:00
Hye-Shik Chang c6f066f9a3 Update documentations for str.rsplit() with Alex Martelli's rewrite. 2003-12-17 02:49:03 +00:00
Hye-Shik Chang 3ae811b57d Add rsplit method for str and unicode builtin types.
SF feature request #801847.
Original patch is written by Sean Reifschneider.
2003-12-15 18:49:53 +00:00
Skip Montanaro 6485a87b9a missing word (should backport - is release23-maint still locked?) 2003-12-15 14:38:57 +00:00
Jeremy Hylton c1be59f40a SF patch 852995: add processors feature to urllib2
John J. Lee writes: "the patch makes it possible to implement
functionality like HTTP cookie handling, Refresh handling,
etc. etc. using handler objects. At the moment urllib2's handler
objects aren't quite up to the job, which results in a lot of
cut-n-paste and subclassing. I believe the changes are
backwards-compatible, with the exception of people who've
reimplemented build_opener()'s functionality -- those people would
need to call opener.add_handler(HTTPErrorProcessor).

The main change is allowing handlers to implement
methods like:

http_request(request)
http_response(request, response)

In addition to the usual

http_open(request)
http_error{_*}(...)
"

Note that the change isn't well documented at least in part because
handlers aren't well documented at all.  Need to fix this.

Add a bunch of new tests.  It appears that none of these tests
actually use the network, so they don't need to be guarded by a
resource flag.
2003-12-14 05:27:34 +00:00
Neal Norwitz 378f7b5dca Add a versionadded tag for traceback.format_exc() 2003-12-13 22:34:09 +00:00
Guido van Rossum 5a92175fbc After hearing from someone who gave up on timeout sockets due to a
mistake in his code, I'm adding a note explaining that you should call
settimeout() before connect().
2003-12-13 22:12:53 +00:00
Brett Cannon 35415da67c Fix broken link (closes bug #852236). Thanks to Fedor Baart for bug file and
finding proper link.
2003-12-11 04:37:24 +00:00
Raymond Hettinger ff294fea40 SF patch #855195: fix typos
(Contributed by George Yoshida.)
2003-12-07 13:00:25 +00:00
Raymond Hettinger 295530585b Fix double hyphen markup. 2003-12-07 12:46:16 +00:00
Raymond Hettinger e3d5f98180 Put str() in alphabetical order. 2003-12-07 11:24:03 +00:00
Raymond Hettinger a4ce2f5116 SF bug #855317: unittest: 5.3.9 Getting Extended Error Information
The example code did not work and could not easily be made to work.
Since the docs were already complex and the feature was not used
(it took two years for the errors to surface), we decided to dedocument
it entirely, leaving unittest cleaner than before.
2003-12-07 10:48:03 +00:00
Andrew M. Kuchling db7dcffa27 Edit description a bit 2003-12-06 22:29:43 +00:00
Raymond Hettinger d25c1c6351 Implement itertools.groupby()
Original idea by Guido van Rossum.
Idea for skipable inner iterators by Raymond Hettinger.
Idea for argument order and identity function default by Alex Martelli.
Implementation by Hye-Shik Chang (with tweaks by Raymond Hettinger).
2003-12-06 16:23:06 +00:00
Raymond Hettinger ff6dd0b7d0 SF bug #844123: "up" instead of "down" in turtle module documentation 2003-12-06 01:35:56 +00:00
Fred Drake f96dd83bb4 - fix markup in the bool() description
- note the behavior of bool() with no arg in the main body of the
  description
2003-12-05 18:57:00 +00:00
Walter Dörwald c8de4585a6 Add parameters indent, width and depth to pprint.pprint() and pprint.pformat()
and pass them along to the PrettyPrinter constructor.
2003-12-03 20:26:05 +00:00
Raymond Hettinger 166958b5df As discussed on python-dev, added two extractor functions to the
operator module.
2003-12-01 13:18:39 +00:00
Martin v. Löwis ccabed35ee Patch #849350: Update to document bool return values. Backported to 2.3. 2003-11-27 19:48:03 +00:00
Martin v. Löwis 94681fc4a3 Patch #849595: Add socket.shutdown() constants. 2003-11-27 19:40:22 +00:00
Raymond Hettinger d4462300db Nits from a review of the documentation update. 2003-11-26 17:52:45 +00:00
Neal Norwitz 72452650af Add version changed doc for addition of fillchar to ljust/rjust/center 2003-11-26 14:54:56 +00:00
Raymond Hettinger 4f8f976576 Add optional fillchar argument to ljust(), rjust(), and center() string methods. 2003-11-26 08:21:35 +00:00
Raymond Hettinger bd93b3ea8f As discussed on python-dev, banish apply(), buffer(), coerce(), and
intern() to a separate region in the docs.
2003-11-25 21:48:21 +00:00
Raymond Hettinger f5f41bf087 * Checkin remaining documentation
* Add more tests
* Refactor and neaten the code a bit.
* Rename union_update() to update().
* Improve the algorithms (making them a closer to sets.py).
2003-11-24 02:57:33 +00:00
Tim Peters 5a5b243043 More words: gave more motivation, and added cautions about the special
dangers of trying to iterate over weak dicts.
2003-11-21 22:20:57 +00:00
Barry Warsaw 65367ca41e Add a missing import. Closes SF # 816344. 2003-11-21 20:28:15 +00:00
Martin v. Löwis af7dc8d8b8 Patch #831747: Add skip_accept_encoding parameter to putrequest. 2003-11-19 19:51:55 +00:00
Barry Warsaw f8d3bcc77e Generator's constructor: The documentation was incorrect regarding how
header wrapping gets done when maxheaderlen <> 0.  The header really
gets wrapped via the email.Header.Header class, which has a more
sophisticated algorithm than just splitting on semi-colons.
2003-11-19 02:22:36 +00:00
Martin v. Löwis 8bafb2aaca Patch #843088: Fix typos. Backported to 2.3. 2003-11-18 19:48:57 +00:00
Raymond Hettinger a690a9967e * Migrate set() and frozenset() from the sandbox.
* Install the unittests, docs, newsitem, include file, and makefile update.
* Exercise the new functions whereever sets.py was being used.

Includes the docs for libfuncs.tex.  Separate docs for the types are
forthcoming.
2003-11-16 16:17:49 +00:00
Raymond Hettinger d456849f19 Fix typo 2003-11-16 13:44:19 +00:00
Gregory P. Smith b845ef056a remove "support" for BerkeleyDB 3.1, it hasn't worked for a long time 2003-11-13 08:30:03 +00:00
Raymond Hettinger ad983e79d6 Improve the implementation of itertools.tee().
Formerly, underlying queue was implemented in terms of two lists.  The
new queue is a series of singly-linked fixed length lists.

The new implementation runs much faster, supports multi-way tees, and
allows tees of tees without additional memory costs.

The root ideas for this structure were contributed by Andrew Koenig
and Guido van Rossum.
2003-11-12 14:32:26 +00:00
Fred Drake d85ed1b7fc fix typo in markup 2003-11-10 14:50:54 +00:00
Fred Drake dbe7980d6a add missing "if" 2003-11-10 14:43:16 +00:00
Martin v. Löwis 75aa4db04b Mention that getsid is new in 2.4. 2003-11-10 06:46:15 +00:00
Martin v. Löwis d8921379e9 Patch #798297: Add IMAP THREAD command. 2003-11-10 06:44:44 +00:00
Martin v. Löwis 49ee14dac5 Patch #839038: Add getsid(2). 2003-11-10 06:35:36 +00:00
Alex Martelli 37dc334276 Add docs for readmodule_ex and its function-descriptors, fixing
sf bug#812818.
(same as commit of Sun Nov 2 to the release23-maint branch)
2003-11-09 16:32:54 +00:00
Alex Martelli 50324a604c Avoid giving advice that's bad for security, as per SF bug #823515
(same as commit of Sun Nov 2 to the release23-maint branch)
2003-11-09 16:31:18 +00:00
Raymond Hettinger 85c20a41df Implement and apply PEP 322, reverse iteration 2003-11-06 14:06:48 +00:00
Neil Schemenauer f607fc5395 Add traceback.format_exc(). 2003-11-05 23:03:00 +00:00
Raymond Hettinger 83c187460e SF patch #834444: add versionadd to new functions
(Contributed by George Yoshida.)
2003-11-02 09:50:56 +00:00
Andrew M. Kuchling b4b9ced1b6 [Bug #817178] Fix incorrect arguments in example, noted by Terry Reedy 2003-10-31 19:52:30 +00:00
Martin v. Löwis 893ffa4372 Patch #830858: Correct the number of is-functions. Backported to 2.3 and 2.2. 2003-10-31 15:35:53 +00:00
Martin v. Löwis 45394c281d Patch #531629: Add multicall support. 2003-10-31 13:49:36 +00:00
Martin v. Löwis 48440b7c27 Patch #: Add POP3 over SSL support. 2003-10-31 12:52:35 +00:00
Raymond Hettinger 9885c93b99 Fix typo. 2003-10-30 06:08:32 +00:00
Brett Cannon 82b24827f6 Minor grammatical fix. 2003-10-30 05:42:15 +00:00
Raymond Hettinger 0a9b9da0c3 Add list.sorted() classmethod. 2003-10-29 06:54:43 +00:00
Raymond Hettinger c43a7e7c37 SF bug #827902: ctime is not creation time
New fix for this bug recognizes differing definitions on various systems.
2003-10-29 00:46:19 +00:00
Armin Rigo 3be6d5d320 Documented gc.get_referrers() as dangerous.
SF bug 793822
2003-10-28 12:10:38 +00:00
Raymond Hettinger 8476c4df92 SF bug #827902: ctime is not creation time
Document the correct definition of os.path.getctime()
2003-10-27 20:00:36 +00:00
Andrew M. Kuchling b546be2448 Fix inaccuracy: all entities from XHTML 1.0 are supported (according to text further down in this file) 2003-10-27 15:46:16 +00:00
Raymond Hettinger d591f666de Replace the window() example with pairwise() which demonstrates tee(). 2003-10-26 15:34:50 +00:00
Raymond Hettinger 6a5b027742 Added itertools.tee()
It works like the pure python verion except:
* it stops storing data after of the iterators gets deallocated
* the data queue is implemented with two stacks instead of one dictionary.
2003-10-24 08:45:23 +00:00
Andrew M. Kuchling 38afcef3f5 [Bug #809174] loads() and dumps() not documented 2003-10-22 14:12:03 +00:00
Fred Drake d22bb6584d Avoid confusing name for the 3rd argument to str.replace().
This closes SF bug #827260.
2003-10-22 02:56:40 +00:00
Fred Drake 4e21dc9efd - make this section format
- start cleaning up the markup for consistency
- comment out the reference to a MS KnowledgeBase article that doesn't
  seem to be present at msdn.microsoft.com; hopefully someone can
  point out an alternate source for the relevant information
2003-10-21 17:58:55 +00:00
Fred Drake 5b6150e066 markup fixes; this would not format 2003-10-21 17:04:21 +00:00
Fred Drake 86c60ed198 ConfigParser.items() and SafeConfigParser.items() no longer return a
generator.  See SF bug #818861.
2003-10-21 16:50:55 +00:00
Guido van Rossum 0c9a318d64 Use 'predicate = bool' as the default predicate for ifilter[false]. 2003-10-20 17:01:07 +00:00
Walter Dörwald f0dfc7ac5c Fix a bunch of typos in documentation, docstrings and comments.
(From SF patch #810751)
2003-10-20 14:01:56 +00:00
Gustavo Niemeyer d969775d9c Fixed \versionadded for the (?(id/name)yes|no) expression support. 2003-10-18 15:28:22 +00:00
Martin v. Löwis 6828e18a6a Patch #825679: Clarify semantics of .isfoo on empty strings.
Backported to 2.3.
2003-10-18 09:55:08 +00:00
Martin v. Löwis 849a972f35 Patch #809535: Mention behaviour of seek on text files. Backported to 2.3. 2003-10-18 09:38:01 +00:00
Gustavo Niemeyer ad3fc44ccb Implemented non-recursive SRE matching. 2003-10-17 22:13:16 +00:00
Raymond Hettinger 42b1ba31af * list.sort() now supports three keyword arguments: cmp, key, and reverse.
key provides C support for the decorate-sort-undecorate pattern.
  reverse provide a stable sort of the list with the comparisions reversed.

* Amended the docs to guarantee sort stability.
2003-10-16 03:41:09 +00:00
Brett Cannon 4fc3855fb2 Initial checkin of docs for Lib/platform.py .
Closes patch #785752 and bug #726911.

Should be backported after correctness and such has been verified by Fred.
2003-10-14 21:45:59 +00:00
Raymond Hettinger c2a2832bee SF bug #821701: reduce docs neglect a very important piece of information.
Add a note showing which argument is the accumulator.
2003-10-13 17:52:35 +00:00
Raymond Hettinger aac6ae9f26 SF patch #819955: Erroneous \seemodule in tarfile docs
(Contributed by Johannes Gijsbers.)
2003-10-12 02:02:16 +00:00
Raymond Hettinger dbe3d280e7 Adopt Christian Stork's suggested argument order for the logic quantifiers.
Adopt Jeremy Fincher's suggested function name, "any", instead of "some".
2003-10-05 16:47:36 +00:00
Raymond Hettinger 2f726e9093 SF bug #812202: randint is always even
* Added C coded getrandbits(k) method that runs in linear time.
* Call the new method from randrange() for ranges >= 2**53.
* Adds a warning for generators not defining getrandbits() whenever they
  have a call to randrange() with too large of a population.
2003-10-05 09:09:15 +00:00
Skip Montanaro dffeed3ffa Make the fieldnames argument optional in the DictReader. If self.fieldnames
is None, the next row read is used as the fieldnames.  In the common case,
this means the programmer doesn't need to know the fieldnames ahead of time.
The first row of the file will be used.  In the uncommon case, this means
the programmer can set the reader's fieldnames attribute to None at any time
and have the next row read as the next set of fieldnames, so a csv file can
contain several "sections", each with different fieldnames.
2003-10-03 14:03:01 +00:00
Fred Drake 1dc3bb4722 Work around minor markup issue: we don't want markup to escape into
the module index.
2003-09-30 20:00:43 +00:00
Andrew M. Kuchling 7cf4d9bf19 [Bug #812936] Correct the documentation for RotatingFileHandler.
[2.3 bugfix candidate]
2003-09-26 13:45:18 +00:00
Raymond Hettinger 9a80c5dbc4 Added codec for bz2 compression. 2003-09-23 20:21:01 +00:00
Raymond Hettinger 7e43110f34 SF 810242. Fix doubled word errors. 2003-09-22 15:00:55 +00:00
Raymond Hettinger 1e80359733 Clean-up example code: remove string module and backticks. 2003-09-22 06:25:10 +00:00
Martin v. Löwis e7a9796a0f Patch #800697: Add readline.clear_history. 2003-09-20 16:08:33 +00:00
Martin v. Löwis 7bdc484c97 Patch #808362: Fix typos. 2003-09-20 11:09:28 +00:00
Raymond Hettinger d21fd7bd86 * Minor wording change
* Reference the doctest.DocTestSuite() conversion tool.
2003-09-16 22:04:31 +00:00
Raymond Hettinger 3404034a21 Minor fixups 2003-09-16 21:45:22 +00:00
Raymond Hettinger 1e4cf67c32 SF bug #804113: Crypto terminology for crypto hash function
Noted that the SHA algorithm is really SHA-1.
(Contributed by Ronald Rivest.)
2003-09-15 18:20:52 +00:00
Raymond Hettinger deadbf50e4 SF #662923
Add support for the iterator and mapping protocols.
For Py2.3, this was done for shelve, dumbdbm and other mapping objects, but
not for bsddb and dbhash which were inadvertently missed.
2003-09-12 06:33:37 +00:00
Raymond Hettinger 74c8e55f3b SF bug #804280: fromkeys is not listed in index 2003-09-12 00:02:37 +00:00
Fred Drake 614438ab06 fix markup buglets 2003-09-11 18:18:54 +00:00
Fred Drake 7c4d8f3ca9 - add version annotation for HIGHEST_PROTOCOL
- cleaned up some markup
2003-09-10 20:47:43 +00:00
Brett Cannon 62dba4c277 select.select() now accepts a sequence (as defined by PySequence_Fast()) for
its first three arguments.

Closes RFE #798046 .
2003-09-10 19:37:42 +00:00
Skip Montanaro fd4fa8801a mention new module doc display feature of pydoc in libref and NEWS 2003-09-10 19:04:13 +00:00
Raymond Hettinger 6e380cd1d8 SF bug #803679: Missing section number in csv module documentation 2003-09-10 18:54:49 +00:00
Raymond Hettinger 5bcc933211 SF bug #803842: Wrong description of regexp concatenation 2003-09-10 18:45:12 +00:00
Raymond Hettinger 0d6e8cde1a SF bug #802302: Invalid documentation for dbhash.
The documentation severely departed for the actual implementation.
2003-09-10 04:44:29 +00:00
Raymond Hettinger bed92ee2b2 SF patch #800899: Making "|" directive from REs a bit clearer. 2003-09-10 03:54:50 +00:00
Raymond Hettinger 9756f388c0 Fix typo. 2003-09-10 00:11:28 +00:00
Fred Drake f5f0c17b85 end-of-sentence punctuation comes *before* \footnote, not after 2003-09-09 19:49:18 +00:00
Raymond Hettinger dfa7bd97ff SF #801306: Bad RE in scanf example 2003-09-09 01:30:13 +00:00
Raymond Hettinger 74923d73ee SF bug #560286: Add docs for 'basestring' 2003-09-09 01:12:18 +00:00
Raymond Hettinger a098b33c93 Add an example to address a common question of how to split iterators. 2003-09-08 23:58:40 +00:00
Raymond Hettinger b67449d31d Fix spacing markup and other sundries. 2003-09-08 18:52:18 +00:00
Fred Drake 60e868abd2 - reorganize sections
- correct section level error (module references are always \section)
- many markup revisions, including some minor rewordings
2003-09-06 17:51:16 +00:00
Raymond Hettinger 99812134be SF bug 799191: fix markup 2003-09-06 05:47:31 +00:00
Raymond Hettinger 1c90a6754c SF bug 799367: grammar error 2003-09-06 05:36:13 +00:00
Raymond Hettinger 951976dc9f SF bug #801486: Markup error. 2003-09-06 04:39:54 +00:00
Fred Drake 74530ff4f9 markup updates 2003-09-05 15:50:20 +00:00
Martin v. Löwis ef36537b81 Patch #792338: Correct documentation for timetuple return type. 2003-09-04 18:29:53 +00:00
Martin v. Löwis 25f90d5c5d Use de_DE in example, change message for unknown locale. Fixes #797447.
Will backport to 2.3.
2003-09-03 04:50:13 +00:00
Raymond Hettinger 09c7b6075c SF patch #798255: Document httplib.HTTPResponse.read "amt" argument
(Contributed by Jeff Epler.)
2003-09-02 02:32:54 +00:00
Raymond Hettinger aa1178b811 Minor typo 2003-09-01 23:13:04 +00:00
Raymond Hettinger c75c3e0392 SF patch #791153: inconsistency with implementation(logging)
(Contributed by George Yoshida.)
2003-09-01 22:50:52 +00:00
Raymond Hettinger 6f6d7b93bc SF bug #797853: Small problems with the csv module's documentation 2003-08-31 05:44:54 +00:00
Raymond Hettinger 2f3e5483a3 SF bug #732120:An extended definition of "non-overlapping" would save time.
Clarified the meaning of non-overlapping in patterns with zero length
matches.
2003-08-31 05:29:02 +00:00
Raymond Hettinger 0a6aa28681 SF patch #797157: Bug 794658: os.chmod docs, stat constants
(Contributed by Christos Georgiou.)

Reference the symbol definitions in the stat module.
2003-08-31 05:09:52 +00:00
Raymond Hettinger 9d12ab5c3c Fix long option markup. 2003-08-31 04:20:12 +00:00
Raymond Hettinger 8170200ce2 SF patch #797180: Bug 792656: slicing explained 2003-08-30 23:31:31 +00:00
Fred Drake 4f4dbef2ca remove extra word occurance; reported to webmaster 2003-08-27 15:11:40 +00:00
Raymond Hettinger 9e3864190c Make the derived tools amendable to cut and paste. 2003-08-25 05:06:09 +00:00
Raymond Hettinger 999b57c872 Fix double word typos. 2003-08-25 04:28:05 +00:00
Raymond Hettinger 9ac25ec025 SF bug #793702: Section 13.1 HTMLParser documentation error
The -- is special to TeX and was printing as just -.
2003-08-25 03:31:28 +00:00
Barry Warsaw 463c5a868f Update get_param() description to reflect changes to the docstring. 2003-08-19 04:26:59 +00:00
Raymond Hettinger 6a1801271a Improvements to set.py:
* Relaxed the argument restrictions for non-operator methods.  They now
  allow any iterable instead of requiring a set.  This makes the module
  a little easier to use and paves the way for an efficient C
  implementation which can take better advantage of iterable arguments
  while screening out immutables.

* Deprecated Set.update() because it now duplicates Set.union_update()

* Adapted the tests and docs to include the above changes.

* Added more test coverage including testing identities and checking
  to make sure non-restartable generators work as arguments.

Will backport to Py2.3.1 so that the interface remains consistent
across versions.  The deprecation of update() will be changed to
a FutureWarning.
2003-08-17 08:34:09 +00:00
Raymond Hettinger 7ceb29e4a5 Incorporate documentation suggestions from feedback on comp.lang.python.
* Positive wording for the description of why < and > and = can all
  be False.

* Move to a three column table format that puts long method names
  side-by-side with their operator equivalents

* Mention that KeyError can be raised by Set.pop() and Set.remove().

* Minor tweaks to the examples.

Will backport as soon as Fred rebuilds the docs so I can confirm
the tables formatted properly
2003-08-16 00:56:40 +00:00
Raymond Hettinger fb857893a2 SF patch #787929: reflect the introduce of boolean type(libcfgparser.tex)
(Contributed by George Yoshida.)
2003-08-14 19:58:35 +00:00
Fred Drake 8fd8def1fa fix markup 2003-08-14 04:51:24 +00:00
Andrew M. Kuchling 69f31eb80c [Patch #739124] Add use_default_colors() to curses module 2003-08-13 23:11:04 +00:00
Raymond Hettinger f17d65da3a SF patch#786531 'the the' typo. Contributed by George Yoshida 2003-08-12 00:01:16 +00:00
Skip Montanaro bc961e5714 add a statement identifying StringI and StringO objects. 2003-08-11 15:06:07 +00:00
Raymond Hettinger 6e13bcc7b1 SF bug #775836: change 0,1 to False,True in dict.has_key doc 2003-08-08 11:07:59 +00:00
Raymond Hettinger b5a420883c Modified itertools.izip() to match the behavior of __builtin__.zip()
which can now take zero arguments.
2003-08-08 05:10:41 +00:00
Raymond Hettinger c7d7766fda Improve docs:
* Simplify the pure python examples
* Add a quantify() example
2003-08-08 02:40:28 +00:00
Raymond Hettinger f8a52d38ad Removed deprecated functions 2003-08-05 12:23:19 +00:00
Raymond Hettinger 02771c174c SF patch #782810: typo in libfuture.tex
(Contributed by George Yoshida)
2003-08-05 11:40:21 +00:00
Martin v. Löwis cebcc61d4d Patch #781126: Fix markup for add_fallback. Will backport to 2.3. 2003-08-05 05:54:15 +00:00
Brett Cannon b278ac4e46 Add note about fileno not being usable as a normal file descriptor in Windows. 2003-08-05 03:51:24 +00:00
Raymond Hettinger 4ee2ff36d0 Clarified that TypeErrors can be raised by any
function (not just builtins).

The issue arose in a thread on comp.lang.python.
2003-08-04 08:33:50 +00:00
Raymond Hettinger eaef615116 As discussed on python-dev, changed builtin.zip() to handle zero arguments
by returning an empty list instead of raising a TypeError.
2003-08-02 07:42:57 +00:00
Fred Drake 9d843087b6 update the documentation contact address 2003-07-30 02:55:28 +00:00
Fred Drake d50bd6cf00 Update URL. 2003-07-28 14:39:13 +00:00
Raymond Hettinger 88821f7c20 Important usability fix in itertools documentation. 2003-07-22 06:33:13 +00:00
Fred Drake ef13949e00 Avoid a 301 permanent redirect.
Part of SF patch #773007.
2003-07-22 00:49:11 +00:00
Fred Drake 6c4970995a Merge the old dumbdbm documetation into the new docs that have been added.
Make some module references hyperlinks.
2003-07-21 15:30:15 +00:00
Raymond Hettinger 476fcae4d7 SF bug #774411: Typo in socket documentation 2003-07-20 01:10:15 +00:00
Fred Drake 7a6b4f0284 more markup chages 2003-07-17 16:00:01 +00:00
Fred Drake 8836e567b9 - remove mention of the isprivate flag, since that isn't directly
documented here, and according to Tim, should never have been there
- misc. cleanups for consistency
2003-07-17 15:22:47 +00:00
Raymond Hettinger 943277ecd3 Minor corrections. 2003-07-17 14:47:12 +00:00
Fred Drake 38d7c1bb78 Note that Unicode strings are now supported in sys.path.
SF patch #764594.
2003-07-17 04:22:44 +00:00
Skip Montanaro bfa6872260 Zap the C API subsection altogether for now. It's not actually usable from
C yet anyway.
2003-07-16 21:14:35 +00:00
Skip Montanaro 2491cd98c4 expose the C API subsection which was hidden from LaTeX in a comment. In
the info conversion the \comment LaTeX macro mapped to a Texinfo @ignore
macro.  Unfortunately, py2texi.el is not smart enough to avoid generating
links to the @ignore'd section, which causes makeinfo to croak.

Exposing this text is probably not the most correct thing to do, as this
documentation really belongs in the C API manual.  This does get the info
files generated, however, which is a more practical goal considering the
impending release of 2.3rc1.
2003-07-16 19:46:07 +00:00
Raymond Hettinger 71adf7e9d8 Doctest now examines all docstrings by default. Previously, it would
skip over functions with private names (as indicated by the underscore
naming convention).  The old default created too much of a risk that
user tests were being skipped inadvertently.  Note, this change could
break code in the unlikely case that someone had intentionally put
failing tests in the docstrings of private functions.  The breakage
is easily fixable by specifying the old behavior when calling testmod()
or Tester().  The more likely case is that the silent failure was
unintended and that the user needed to be informed so the test could be
fixed.
2003-07-16 19:25:22 +00:00
Fred Drake 853276e16d Lots of markup cleanups to avoid warnings from the GNU info generation;
these make sense even without that processing chain.
2003-07-16 17:58:38 +00:00
Fred Drake 788617f8f0 Remove \versionchanged; the text was too complex for the GNU info
conversion to support.  Keep the content as normal content, with a
note that this applies starting in Python 2.3.
2003-07-16 16:19:08 +00:00
Fred Drake d24c767d5b A variety of markup-level adjustments. 2003-07-16 05:17:23 +00:00
Raymond Hettinger 46f681cc07 Discussion of signatures for unicode.translate() and str.translate()
were in the wrong file.  Moved out of libstring.tex and into
libstdtypes.tex.
2003-07-16 05:11:27 +00:00
Fred Drake d9cf8e7e7c Markup consistency nits. 2003-07-14 21:07:05 +00:00
Fred Drake 9753ae1237 Added missing markup. 2003-07-14 20:53:57 +00:00
Raymond Hettinger 708c2a877e Fix unbalanced parenthesis in text. 2003-07-14 18:36:47 +00:00
Raymond Hettinger 0e53d234eb Fix missing parenthesis 2003-07-14 18:24:26 +00:00
Skip Montanaro 7233117960 update norobots link 2003-07-14 17:04:50 +00:00
Skip Montanaro a2d3d93ee3 + libdumdbm 2003-07-14 12:13:27 +00:00
Skip Montanaro d54c5ddd28 minimal dumdbm module doc 2003-07-14 12:12:37 +00:00
Raymond Hettinger 9bb33868af SF bug #738090: Section 13.3: htmllib.HTMLParser constructor definition
amendment

Add a clarifying cross-reference to the formatter module.
2003-07-14 08:15:47 +00:00
Raymond Hettinger 5c5fca9844 SF bug #706546: u''.translate not documented
Clarified the difference between translate methods for string objects and
Unicode objects.
2003-07-13 02:06:47 +00:00
Raymond Hettinger 627273733f SF bug #770107: Typo in documentation of resource module 2003-07-13 00:46:40 +00:00
Martin v. Löwis 162f081fb3 Patch 549151, rev4: redirect posts for 301 also. Will backport to 2.2. 2003-07-12 07:33:32 +00:00
Raymond Hettinger 92f21b13ea Document Jim Fulton's docttest extensions. 2003-07-11 22:32:18 +00:00
Raymond Hettinger 9de3c21865 SF #767592: unittest docs don't suggest "unittest.main()"
Expanded docs to have a quick start example showing how
to create and run tests.
2003-07-10 22:14:41 +00:00
Neal Norwitz a4d2b869b9 Add versionadded. Remove duplicate "to" 2003-07-09 12:41:55 +00:00
Kurt B. Kaiser 0b1782f7c0 Document interrupt_main()
Remove obsolete reference to deprecated exit_thread() function
2003-07-08 17:07:20 +00:00
Neal Norwitz dd3afa75b3 add missing ' 2003-07-08 16:26:34 +00:00
Fred Drake 9a5b6a6f08 - clean up table markup for readability
- don't use \constant for literals; it's for "defined" constants
- fix various consistency issues
2003-07-08 15:38:40 +00:00
Fred Drake 8120995b56 Update Tkinter3000 notes based on text from Fredrik Lundh. 2003-07-08 13:44:27 +00:00
Anthony Baxter a6b7d3411f Fixed a table that wasn't in a tableii block, and added a very simple
example to show how to log to a file.
2003-07-08 08:40:20 +00:00
Neal Norwitz 7cb229df18 add versionadded for getcheckinterval 2003-07-07 14:11:53 +00:00
Tim Peters e5e065b669 New function sys.getcheckinterval(), to complement setcheckinterval(). 2003-07-06 18:36:54 +00:00
Neal Norwitz b25229d823 Fix SF bug #766288, property() example gives syntax error 2003-07-05 17:37:58 +00:00
Skip Montanaro eec26f982a Correct documentation of check interval - it's 100 by default, not 10 any
longer.  Pointed out by Alex Martelli.
2003-07-02 21:38:34 +00:00
Skip Montanaro 5e4e39f12a Note that csv files (when they are actual files) must be opened in 'b'inary
mode.  Note that the only restriction on the csvfile passed to writer
objects is that it have a write method.
2003-07-02 15:32:48 +00:00
Raymond Hettinger 774816f817 SF bug #764616: execfile(filename,...) not execfile(file,...)
Clarify parameter name.
2003-07-02 15:31:54 +00:00
Raymond Hettinger f8020e0211 Grammar nit. SF bug #757822 2003-07-02 15:10:38 +00:00
Fred Drake c5528b1f5c Revert the previous change; this is now dealt with in a better way. 2003-07-02 14:44:55 +00:00
Fred Drake 1ec0bdf899 The datetime C API really isn't usable outside the datetime module
implementation, so remove this decoy (it break formatting of the GNU
info version of the docs).
2003-07-02 13:42:51 +00:00
Fred Drake 2884d6de15 Fix a variety of small markup nits. 2003-07-02 12:27:43 +00:00
Fred Drake 3ede7848a9 - note that super() only applies to new-style classes;
closes SF bug #764003
- fix markup for consistency
2003-07-01 16:31:26 +00:00
Tim Peters 93ceaea01f showwarning() calls formatwarning(), not showwarning().
Bugfix candidate.
2003-07-01 14:37:59 +00:00
Raymond Hettinger 9c8f78deab Improve the wording a bit 2003-07-01 07:19:17 +00:00
Raymond Hettinger 69d6356eb9 Fix spelling, grammar, usage, and markup. 2003-07-01 06:29:18 +00:00
Brett Cannon 20def8bb19 Make temporary change of using _strptime for time.strptime permanent.
Flesh out docs to better explain time.strptime (closes bug #697990).
2003-07-01 05:16:08 +00:00
Neal Norwitz ecc7171007 Add versionadded info for the 2 new threading module functions 2003-06-30 21:47:47 +00:00
Fred Drake 5728815e7b Fix broken markup, & tweak a couple of things for consistency. 2003-06-29 18:12:23 +00:00
Jeremy Hylton bfccb35b58 Add settrace() and setprofile() functions to the threading library. 2003-06-29 16:58:41 +00:00
Raymond Hettinger be2528d866 SF patch #760257: add socket.timeout exception
(Contributed by Bob Halley)

Add documentation for the new socket.timeout exception.
2003-06-29 04:55:59 +00:00
Raymond Hettinger 3567a876c7 Add take() to examples. Tighten the islice() example 2003-06-28 05:44:36 +00:00
Fred Drake 5d2f515dd4 fix markup nits 2003-06-28 03:09:06 +00:00
Raymond Hettinger 6f3eaa67e5 SF patch #761519: Fixes for bugs 760703 and 757821
SF bug #760703: SocketHandler and LogRecord don't work well together
SF bug #757821: logging module docs

Applied Vinay Sajip's patch with a few minor fixups and a NEWS item.

Patched __init__.py - added new function
makeLogRecord (for bug report 760703).

Patched handlers.py - updated some docstrings and
deleted some old commented-out code.

Patched test_logging.py to make use of makeLogRecord.

Patched liblogging.tex to fill documentation gaps (both
760703 and bug 757821).
2003-06-27 21:43:39 +00:00
Tim Peters 6ebe61fa80 A hack to ease compatibility with pre-2.3 Pythons: by default, doctest
now accepts "True" when a test expects "1", and similarly for "False"
versus "0".  This is un-doctest-like, but on balance makes it much
more pleasant to write doctests that pass under 2.2 and 2.3.  I expect
it to go away again, when 2.2 is forgotten.  In the meantime, there's
a new doctest module constant that can be passed to a new optional
argument, if you want to turn this behavior off.

Note that this substitution is very simple-minded:  the expected and
actual outputs have to consist of single tokens.  No attempt is made,
e.g., to accept [True, False] when a test expects [1, 0].  This is a
simple hack for simple tests, and I intend to keep it that way.
2003-06-27 20:48:05 +00:00
Fred Drake f91888bb46 markup consistency nits 2003-06-26 03:11:57 +00:00
Raymond Hettinger 2b9bc08ee7 Removed useless intra-section references which jump to the top of the
section instead of the specific item being referenced.
2003-06-25 20:36:20 +00:00
Raymond Hettinger 2dd8c42638 SF bug #696777: How to make a class iterable using a member generator.
* Added a note that a container class can implement the iterator protocol
  by defining its __iter__() method as a generator.
2003-06-25 19:03:22 +00:00
Raymond Hettinger 35fd926195 SF bug #757822: Additional index items, other minor details
* Minor grammatical fix.
2003-06-25 15:07:45 +00:00
Martin v. Löwis 9e9a7c3dd7 Patch #640236: Better eplain unused data. 2003-06-21 14:15:25 +00:00
Barry Warsaw 47db252786 Add some documentation which describes how to use the email package
instead of rfc822 as the Message factory.
2003-06-20 22:04:03 +00:00
Neal Norwitz 3a03de4a27 SF #757229, fix libsocket.tex typo 2003-06-20 17:11:39 +00:00
Skip Montanaro f5ed9819b0 Avoid using 'dir' as a variable name and use os.path.join() to create
paths.
2003-06-19 18:10:37 +00:00
Raymond Hettinger befa37dd05 Minor updates:
* Updated comment on design of imap()
* Added untraversed object in izip() structure
* Replaced the pairwise() example with a more general window() example
2003-06-18 19:25:37 +00:00
Raymond Hettinger b5155e30ce Fix typo. 2003-06-18 01:58:31 +00:00
Walter Dörwald 93719b56ed Updated documentation for the new slice arguments for list.index(). 2003-06-17 16:19:56 +00:00
Skip Montanaro 364ca40c2a SF Patch 569574 - enhancements to cgitb for plain text display 2003-06-17 12:58:31 +00:00
Neal Norwitz 938b7a0f63 Fix some markup nits 2003-06-17 02:37:06 +00:00
Tim Peters 9ca3f02dc0 ^D means EOF on Unix but not on Windows. Expand the example's prompt to
tell Windows Truth too.

Bugfix candidate.
2003-06-15 23:08:45 +00:00
Raymond Hettinger 7e902b27e0 * Added missing documentation for object().
* Noted the Py2.3 in the optional arg for bool().
2003-06-11 09:15:26 +00:00
Raymond Hettinger 3985df2c99 SF bug #660022: parameters for int(), str(), etc.
* Indicate that arguments are optional for most builtin type constructors.
* Replace e.g. in staticmethod() and classmethod() docs.
* Add \code{} markup to some in-line code examples.
2003-06-11 08:16:06 +00:00
Raymond Hettinger 132fa373d1 Add docs for get_grouped_opcodes(). 2003-06-11 07:50:44 +00:00
Raymond Hettinger 80b3f685b4 SF bug: 751941 Invisible HTML tag
Added missing jump target labels.
2003-06-10 21:41:22 +00:00
Barry Warsaw 9caa0d1642 guess_all_extensions(): Return the empty list instead of None when
there are no matching types.  Updated the docs and docstrings.  Added
some unit tests.
2003-06-09 22:27:41 +00:00
Raymond Hettinger e07b83591f Document context_diff() and unified_diff() 2003-06-09 21:44:59 +00:00
Neal Norwitz 305908cffd SF #735051, add time.tzset documentation 2003-06-08 13:57:19 +00:00
Gustavo Niemeyer 9556fba685 - urllib2.py now knows how to order proxy classes, so the user doesn't
have to insert it in front of other classes, nor do dirty tricks like
  inserting a "dummy" HTTPHandler after a ProxyHandler when building an
  opener with proxy support.
2003-06-07 17:53:08 +00:00
Skip Montanaro a1045567e0 QUOTE_ALWAYS -> QUOTE_ALL 2003-06-04 15:30:13 +00:00
Martin v. Löwis 19a5a710fc Patch #744238: Explain that different string types also may compare equal. 2003-05-31 08:05:49 +00:00
Martin v. Löwis 7472336444 Patch #744877: Explain filter in terms of list comprehension. Remove
explanation of int in terms of string.atoi. Explain sum in terms of
reduce.
2003-05-31 08:02:38 +00:00
Neal Norwitz 847207acff SF bug #719367, string exceptions are deprecated
Remove references to string based exceptions in the doc.
2003-05-29 02:17:23 +00:00
Neal Norwitz d3d5768e5e isdatadescriptor() was added recently. 2003-05-29 02:10:31 +00:00
Greg Ward fb1b5a164d Rewrite the description of setparameters() so it actually reflects the
code (which has also been recently overhauled, so that it can be
documented without embarassment).

'error' has been renamed to 'OSSAudioError'.

Minor wordsmithing.
2003-05-29 01:39:32 +00:00
Gregory P. Smith dad58601a0 Remove the note about the BerkeleyDB license. Barry indicates that
sleepycat has told him that since python is OSS and berkeleydb is
being distributed with python for the bsddb library all is fine.
2003-05-28 16:20:03 +00:00
Jeremy Hylton c428112d29 Rename lib__future__.tex to libfuture.tex and add link in lib.tex. 2003-05-28 11:57:52 +00:00
Gregory P. Smith 5772513f0f Include a link to the pybsddb web documentation for the modern object
oriented DbEnv & Db object BerkeleyDB interface.

Include a note about Sleepycat's BerkeleyDB license with regards to
distributing it within non-opensource applications and include a link
to their website for license details.

Document that 'r' is the default flag for the legacy bsddb btopen(),
hashopen(), and rnopen() functions.  This is apparently different than the
dbm libraries in other languages according to Bug #732951.  Changing
the default from 'r' to 'c' would break backwards compatibility with
legacy bsddb applications; documenting the default should suffice.
2003-05-28 07:56:45 +00:00
Greg Ward 451a766953 More wordsmithing and cleanup. 2003-05-26 01:51:33 +00:00
Greg Ward c316d0d391 Lots of wordsmithing and typographical improvement. 2003-05-23 02:44:46 +00:00
Jeremy Hylton e41195fab6 Add documentation for __future__ 2003-05-21 21:45:01 +00:00
Fred Drake 15eac1f95c Fix markup nits. 2003-05-20 16:21:51 +00:00
Tim Peters dbaf04ead6 Straighten out the docs for os.system(); the Unix and Windows behaviors
really can't be smushed together.

Bugfix candidate.
2003-05-20 16:15:58 +00:00
Fred Drake e5a55519a8 Remove unused line numbers from example code.
Line numbering of examples is not used elsewhere.
2003-05-20 15:21:08 +00:00
Brett Cannon 235d1efe12 Add docs for key_file and cert_file arguments for HTTPSConnection. Copied from socket.ssl docs. 2003-05-20 02:56:35 +00:00
Skip Montanaro 7789237331 * Correct Sniffer doc to correspond to the implementation.
* Add optional delimiters arg to Sniffer.sniff() which restricts the set of
  candidate field delimiters.
2003-05-19 15:33:36 +00:00
Walter Dörwald 9e46abed50 Fix array.array.insert(), so that it treats negative indices as
being relative to the end of the array, just like list.insert() does.
This closes SF bug #739313.
2003-05-18 03:15:10 +00:00
Guido van Rossum 8f512a22cd Add docs for MessageBeep. 2003-05-16 01:42:22 +00:00
Andrew M. Kuchling 7696344182 [Bug #471893] Replace security material with a warning against unpickling
untrusted data.
2003-05-14 16:51:46 +00:00
Fred Drake 126d366ea6 document Stats.dump_stats(), new for Python 2.3 2003-05-14 14:29:27 +00:00
Guido van Rossum bf1bef820c Add optional 'onerror' argument to os.walk(), to control error
handling.
2003-05-13 18:01:19 +00:00
Andrew M. Kuchling c85bf58276 [Bug #732124] Clarify .pos, .endpos by saying 'method' instead of 'function'
Also, put match() description before search(); search() refers to match()
2003-05-13 14:40:24 +00:00
Andrew M. Kuchling eabd9a1314 [Bug #729817] Document the rexec and Bastion modules as dead 2003-05-13 14:16:18 +00:00
Andrew M. Kuchling 032bd0a9a8 Fix typo 2003-05-13 14:13:58 +00:00
Brett Cannon 1213bdd16d Fix and add reference to urllib.urlencode for parse_qsl? functions. 2003-05-13 02:50:36 +00:00
Raymond Hettinger bf3a75283c Fix minor typos. 2003-05-12 03:23:51 +00:00
Fred Drake 8f53cdcfce - object is a class type, not a function
- when marking a function, the trailing () should be included
  consistently
2003-05-10 19:46:39 +00:00
Raymond Hettinger b4c1d9be8f Fix unbalanced parethesis. 2003-05-10 08:51:28 +00:00
Raymond Hettinger 0dfd7a9361 Missing parenthesis found by texcheck.py 2003-05-10 07:40:56 +00:00
Martin v. Löwis 5467d4c0e3 Patch #612627: Add encoding attribute to file objects, and determine
the terminal encoding on Windows and Unix.
2003-05-10 07:10:12 +00:00
Raymond Hettinger eca984fcce Fix missing parenthesis. 2003-05-10 04:21:08 +00:00
Raymond Hettinger 52136a8bea Fixed spacing and unbalanced brackets or parenthesis. 2003-05-10 03:35:37 +00:00
Fred Drake 9f545c489a Make this format again. 2003-05-09 19:10:12 +00:00
Skip Montanaro a30dffbb53 add a note about accessing user-defined functions with an import statement
in the setup parameter
2003-05-09 18:21:02 +00:00
Fred Drake 3ec4dfd812 Make this format again. 2003-05-09 18:18:46 +00:00
Fred Drake 8b6ed26dc7 - remove bogus \end{description}
- fix two typos
2003-05-09 15:04:56 +00:00
Greg Ward 86e1790cad Clarify the dedent() example a bit by indenting the input lines unevenly. 2003-05-08 02:12:35 +00:00
Greg Ward 8f6329c547 SF patch #598163 (Ville Vainio, vvainio@users.sourceforge.net):
document dedent() function.
2003-05-08 02:09:49 +00:00
Brett Cannon 066f3928b2 Library documentation for the 'test' package. Still needs to be checked by Fred. 2003-05-07 22:02:17 +00:00
Skip Montanaro 6d9f45bc3f add a note about the undocumented bsddb185 module 2003-05-06 20:40:17 +00:00
Jeremy Hylton 6cb52ddc3c Refer reader to platform library docs for specific semantics.
Resolves SF bugs 697989, 697988, 697986.
2003-05-05 16:46:26 +00:00
Greg Ward d72312857e Scattered wording and typographical improvements (up to but not
including the "Callback Options" section).
2003-05-03 21:22:58 +00:00
Greg Ward 649625bc05 Rename "The Tao of Option Parsing" section to "Philosophy".
Remove first-person usage from it.  Various wording tweaks.
2003-05-03 20:41:37 +00:00
Greg Ward 1f53517a8c Use True/False instead of 1/0 when talking about store_true/store_false.
Particularly important since they now store True and False rather than 1
and 0!
2003-05-03 20:13:08 +00:00
Greg Ward c50b088cfd Add a big comment about cross-platform issues (especially OpenBSD).
This should be turned into a footnote by someone who actually
understands OSS and its relationship to Linux, FreeBSD, OpenBSD, NetBSD,
etc.
2003-05-03 19:45:47 +00:00
Greg Ward bf8f1b55a8 Use TeX quotes -- ``foo'' -- as appropriate.
Remove whitespace around em-dashes.
2003-05-03 19:41:45 +00:00
Greg Ward b4e3319302 Fix various markup errors: use \longprogramopt{} more, and use it
correctly.  (Closes SF #731689.)  Use \emph{} in a few places.
2003-05-03 19:16:36 +00:00
Martin v. Löwis ec31047c0c Use \versionchanged, not \versionadded. 2003-05-03 10:59:13 +00:00
Martin v. Löwis 7829e5661c Patch #731514: Update recursion documentation to mention simple recursion. 2003-05-03 10:57:53 +00:00
Martin v. Löwis e59e2bab8f Patch #711902: Cause pydoc to show data descriptor __doc__ strings. 2003-05-03 09:09:02 +00:00
Raymond Hettinger 341deb74e7 The previous made the stop argument optional.
It is better to be explicit and just allow stop to be None.
2003-05-02 19:44:20 +00:00
Raymond Hettinger 14ef54cd83 SF bug #730685: itertools.islice stop argument is not optional
* itertools.islice() stop argument did not perform as documented.
* beefed-up test suite
2003-05-02 19:04:37 +00:00
Fred Drake 90fc0b356f At the site of an indexed reference to print, point to the relevant
documentation.  Closes SF bug #723136.
2003-04-30 16:44:36 +00:00
Fred Drake d4be747e1e - comment out \moduleauthor that broke formatting until the formatting
tools can be fixed; added XXX comment
- general markup fixes
2003-04-30 15:02:07 +00:00
Fred Drake c95628e3f2 - clean up some extra punctuation hidden in indexing markup
- fix a typo and one markup nit
- normalize whitespace
2003-04-29 13:56:40 +00:00
Fred Drake 83c19ee06b Clarify that the timeout argument to read_until() is in seconds. 2003-04-29 13:39:05 +00:00
Raymond Hettinger 6e887bb05f SF bug #729096: getopt online documentation example improvement
A newbie found it difficult to translate the exampe into a
case that used only short options or long options but not both.
He tried to shorten the tuple search but forgot the trailing comma,
The appropriate pattern is an equality check.

Revised the example to point him in the right direction.

Backport candidate.
2003-04-29 04:35:36 +00:00
Brett Cannon a2f8737faf Add comment that urlopen opens local files without universal newlines 2003-04-29 04:11:12 +00:00
Tim Peters a1af767c4d Reworded fabs() for consistency with the others. Noted that all
return values are floats.
2003-04-28 21:32:03 +00:00
Tim Peters a390c6e194 walk() docs: Emphasize that the recursive-delete example is dangerous. 2003-04-28 19:15:10 +00:00
Tim Peters 5501b5e3d7 SF bug 728097: tmpnam problems on windows 2.3b, breaks test.test_os.
tmpnam() appears essentially useless on Windows, and it finally broke
the test for Irmen de Jong.  Read the long new comment in test_tmpnam()
for details.  Since the MS implementation is insane, it might be good
if we supplied a different implementation.

Bugfix candidate.
2003-04-28 03:13:03 +00:00
Tim Peters bf89b3a1f7 walk() docs: Worked "walking" into the description and the text. Added
a brief example where bottom-up walking is essential.
2003-04-28 02:09:43 +00:00
Tim Peters 965697fc4b Clarified new text about math exceptions.
Bugfix candidate.
2003-04-26 15:11:08 +00:00
Skip Montanaro 5118341530 Add note about platform-specific behavior arising from discussion on bug
711019.
2003-04-26 02:59:00 +00:00
Fred Drake 9635268ea9 organizational and markup cleansing 2003-04-25 18:02:34 +00:00
Fred Drake d198f38505 - add availability statements for some of the new APIs
- lots of general cleanup
2003-04-25 16:16:02 +00:00
Fred Drake 53e5b71bbc Add modified versions of the examples from Sean Reifschneider
(SF patch #545480).
2003-04-25 15:27:33 +00:00
Guido van Rossum b016752d8b Fix a copy-paste error: the paragraph about inet_ntop's use was copied
literally from inet_pton.
2003-04-25 15:26:58 +00:00
Skip Montanaro 5d0136e297 reflect csv's change back to a module. Document the new sniffer api. 2003-04-25 15:14:49 +00:00
Fred Drake 9f48045ec0 Use a simpler \note instead of a "See also" section to refer to the
os.walk() generator.
2003-04-25 15:12:47 +00:00
Neal Norwitz 6eb502f267 Add versionadded for has_ipv6 attribute 2003-04-25 14:53:48 +00:00
Neal Norwitz cabf56f8b4 Fix markup 2003-04-25 14:52:41 +00:00
Fred Drake 2194a4eede markup adjustments 2003-04-25 14:50:06 +00:00
Tim Peters c4e0940042 New generator os.walk() does a bit more than os.path.walk() does, and
seems much easier to use.  Code, docs, NEWS, and additions to test_os.py
(testing this sucker is a bitch!).
2003-04-25 07:11:48 +00:00
Guido van Rossum 47dfa4a89a Patch by Jp Calderone:
- The socket module now provides the functions inet_pton and inet_ntop
  for converting between string and packed representation of IP addresses.
  See SF patch #658327.

This still needs a bit of work in the doc area, because it is not
available on all platforms (especially not on Windows).
2003-04-25 05:48:32 +00:00
Andrew M. Kuchling f8d0c075b2 [Patch #628208] Document the allow_none argument 2003-04-25 00:29:31 +00:00
Skip Montanaro 3bd3c8403a * minor tweaks relating to the package nature of the beast
* added an (incomplete) description of the utils.Sniffer class
2003-04-24 18:47:31 +00:00
Barry Warsaw 50889239c3 Updated a bunch of docs to describe how message ids and strings are
Unicode in GNUTranslations.  Also provide better descriptions of
*gettext() overridden methods, esp. w.r.t. the behavior in the face of
fallbacks.
2003-04-24 18:14:49 +00:00
Fred Drake d859d470a1 Add cross-references between urllib.urlencode() and cgi.parse_qs[l]().
Closes SF bug #724751.
2003-04-24 16:22:47 +00:00
Raymond Hettinger 024aaa1bfe SF Patch 549151: urllib2 POSTs on redirect
(contributed by John J Lee)
2003-04-24 15:32:12 +00:00
Fred Drake 1d5854fdc4 Note the platform module. 2003-04-24 15:24:46 +00:00
Andrew M. Kuchling bbb9a55327 [Patch #679505] Document that this module is deprecated 2003-04-24 13:19:09 +00:00
Brett Cannon 317ad7a5ee Fixed docs for urlretrieve() to match code in the case of opening a local file.
Also some typos and removed trailing whitespace on the lines.
2003-04-24 02:31:14 +00:00
Skip Montanaro 54a234a566 clarify - restrict version mention to the trunk version 2003-04-23 20:35:14 +00:00
Skip Montanaro 1bd1d858ae added note about character set limitations in passwords. 2003-04-23 20:22:12 +00:00
Tim Peters 2d1c846b73 Clarified new fsync() docs. 2003-04-23 19:47:14 +00:00
Tim Peters 11b2306960 Enable os.fsync() for Windows, mapping it to MS's _commit() there. The
docs here are best-guess:  the MS docs I could find weren't clear, and
some even claimed _commit() has no effect on Win32 systems (which is
easily shown to be false just by trying it).
2003-04-23 02:39:17 +00:00
Raymond Hettinger 863983e8e5 Add comment on performance.
Fix missing right parenthesis.
Add three examples.
2003-04-23 00:09:42 +00:00
Fred Drake 70995830a6 markup corrections 2003-04-22 18:54:53 +00:00
Fred Drake 282be3ab89 - explain the start argument to sum()
- various adjustments to sum() markup and explanation
2003-04-22 14:52:08 +00:00
Alex Martelli a70b19147f Adding new built-in function sum, with docs and tests. 2003-04-22 08:12:33 +00:00
Gustavo Niemeyer 48f3dcc93e - Changed shlex.split() method to have more useful and
meaningful parameters.
2003-04-20 01:57:03 +00:00
Gustavo Niemeyer cf146d31e7 - Included examples documenting how the lastindex member of
match objects work.
2003-04-20 01:48:59 +00:00
Martin v. Löwis 153c9e493e Patch #553171: Add writeback parameter. Also add protocol parameter. 2003-04-19 20:59:03 +00:00
Guido van Rossum a26854095b - Several methods of nntplib.NNTP have grown an optional file argument
which specifies a file where to divert the command's output
  (already supported by the body() method).  (SF patch #720468)
  Thanks to Terry Carroll.
2003-04-19 18:04:57 +00:00
Barry Warsaw b05df5796a Added some more documentation to as_string() to make it clear that
it's a convenience only.  Give an example of what to do for more
flexibility.
2003-04-18 23:03:53 +00:00
Martin v. Löwis 338bcbccfa Change email address. 2003-04-18 22:04:34 +00:00
Martin v. Löwis faf71ea5b3 Fix spelling of cedillas. 2003-04-18 21:48:56 +00:00
Martin v. Löwis 07d4fb6f17 Correct methoddesc environments. 2003-04-18 21:48:13 +00:00
Martin v. Löwis 281b2c6211 Patch #536883: SimpleXMLRPCServer auto-docing subclass. 2003-04-18 21:04:39 +00:00
Fred Drake cf6d74aedd - accepted (slightly) modified version of docs for the OptionGroup
class; closes SF patch #697941
- use em-dashes intead of en-dashes
- section references: use a "tie" between the word "section" and the
  section number, use quotation marks around section titles
- other minor markup corrections/cleanups
2003-04-18 15:50:13 +00:00
Martin v. Löwis 2548c730c1 Implement IDNA (Internationalized Domain Names in Applications). 2003-04-18 10:39:54 +00:00
Neal Norwitz 10cf21802d Use True in a few more places.
Use isinstance(somestring, basestring) instead of type() as per PEP 8
2003-04-17 23:09:08 +00:00
Neal Norwitz a6bdf2aef6 Oops, missed updating doc to correct version for split 2003-04-17 23:07:13 +00:00
Fred Drake 30b6e8230b Added documentation for the handle_pi() method, based on SF patch #662464.
Closes SF bug #659188, patch #662464.
2003-04-17 22:36:52 +00:00
Fred Drake aa3b5d2ec5 markup banalities 2003-04-17 21:49:04 +00:00
Gustavo Niemeyer 68d8cef89a Implemented posix-mode parsing support in shlex.py, as dicussed in
mailing list, and in patch #722686.
2003-04-17 21:31:33 +00:00
Neal Norwitz 1475c49211 Add version info for name2codepoint and codepoint2name 2003-04-16 13:21:06 +00:00
Walter Dörwald 5688b7ac3e Add two dictionaries to htmlentitydefs: name2codepoint maps
HTML entity names to Unicode codepoints (as integers).
codepoint2name is the reverse mapping. From SF patch #722017.
2003-04-16 09:46:13 +00:00
Guido van Rossum 3a3cca5b82 - list.insert(i, x) now interprets negative i as it would be
interpreted by slicing, so negative values count from the end of the
  list.  This was the only place where such an interpretation was not
  placed on a list index.
2003-04-14 20:58:14 +00:00
Andrew M. Kuchling 44c62ef5ee Typo fix 2003-04-14 15:32:18 +00:00
Barry Warsaw 125b9b0736 Back out of setting the default charset to iso-8859-1. 2003-04-11 21:28:10 +00:00
Neal Norwitz 06c7b62a83 Fix markup 2003-04-11 18:48:03 +00:00
Barry Warsaw a1ce93f87c From http://mail.python.org/pipermail/i18n-sig/2003-April/001557.html
- Expose NullTranslations and GNUTranslations to __all__

- Set the default charset to iso-8859-1.  It used to be None, which
would cause problems with .ugettext() if the file had no charset
parameter.  Arguably, the po/mo file would be broken, but I still think
iso-8859-1 is a reasonable default.

- Add a "coerce" default argument to GNUTranslations's constructor.  The
reason for this is that in Zope, we want all msgids and msgstrs to be
Unicode.  For the latter, we could use .ugettext() but there isn't
currently a mechanism for Unicode-ifying msgids.

The plan then is that the charset parameter specifies the encoding for
both the msgids and msgstrs, and both are decoded to Unicode when read.
For example, we might encode po files with utf-8. I think the GNU
gettext tools don't care.

Since this could potentially break code [*] that wants to use the
encoded interface .gettext(), the constructor flag is added, defaulting
to False.  Most code I suspect will want to set this to True and use
.ugettext().

- A few other minor changes from the Zope project, including asserting
that a zero-length msgid must have a Project-ID-Version header for it to
be counted as the metadata record.
2003-04-11 18:36:43 +00:00
Neal Norwitz ffe33b7f24 Attempt to make all the various string *strip methods the same.
* Doc - add doc for when functions were added
 * UserString
 * string object methods
 * string module functions
'chars' is used for the last parameter everywhere.

These changes will be backported, since part of the changes
have already been made, but they were inconsistent.
2003-04-10 22:35:32 +00:00
Fred Drake fcd845a7ed Lots of small markup adjustments. 2003-04-09 04:06:37 +00:00
Anthony Baxter fda5e27ec9 extra punctuation removed 2003-04-09 03:03:46 +00:00
Skip Montanaro d6e9fe386a + libtimeit 2003-04-09 01:39:06 +00:00
Skip Montanaro ca652746ff doc for timeit module/script - mostly just a recast of Tim's docstring 2003-04-09 01:38:53 +00:00
Fred Drake 2c2068c4d1 Added example of using positional and keyword args with atexit.register().
Based on a suggestion from a reader.
2003-04-08 17:46:53 +00:00
Fred Drake de7ad2caac Markup fix. 2003-04-08 17:37:47 +00:00
Tim Peters 730f5535ba s/referrents/referents/g. Gotta love that referrers remains rife with rs. 2003-04-08 17:17:17 +00:00
Tim Peters 0f81ab6d88 Finished implementing gc.get_referrents(): dealt with error and end
cases, wrote docs, added a test.
2003-04-08 16:39:48 +00:00
Anthony Baxter cb8ed53014 add note suggested by rhettinger about example. 2003-04-07 12:21:56 +00:00
Anthony Baxter b3303efec6 patch [ 698505 ] docs for hotshot module 2003-04-07 12:19:15 +00:00
Martin v. Löwis 3ae0f7a7cf Replace criterium with criterion. Fixes #705120. 2003-03-27 16:59:38 +00:00
Barry Warsaw bfa893f3ac email is at version 2.5 now 2003-03-21 21:14:48 +00:00
Skip Montanaro 5fbf8362a3 include csv doc section - Fred, you may want to change the location 2003-03-20 23:35:00 +00:00
Skip Montanaro b4a0417e91 new CSV file processing module - see PEP 305 2003-03-20 23:29:12 +00:00
Fred Drake 4cee220ff3 - added example of using a comparison function with list.sort(), and
explained the construction of a [(key, value), ...] list as an
  alternative
- note that support for cmpfunc=None was added in 2.3
2003-03-20 22:17:59 +00:00
Skip Montanaro 2a403e8a7e add descriptions of {get,set}defaulttimeout. 2003-03-20 17:58:12 +00:00
Fred Drake 5c7b2487cd - explain what a UNC path is in the makedirs() description, since
they're actually mentioned there
- remove some extraneous paragraph separations
- \versionadded --> \versionchanged in one place
2003-03-20 17:39:38 +00:00
Michael W. Hudson 43ed43bfc1 Take out my (long since disabled) POSIX signal mask handling code.
I'm not going to have the time or energy to get this working x-platform
-- anyone who does is welcome to the code!
2003-03-13 13:56:53 +00:00
Barry Warsaw 45c3941510 Update the package version number 2003-03-12 03:43:09 +00:00
Barry Warsaw a996d4f137 For email 2.5b1, we no longer add a trailing newline to
MIMEText.__init__()'s _text argument if it doesn't already end in a
newline.  This may be controversial.
2003-03-11 05:03:25 +00:00
Barry Warsaw 52b39f5b47 body_line_iterator() now takes a decode argument. 2003-03-11 04:40:14 +00:00
Barry Warsaw 20ebc37013 Describe what happens when decode=True and the payload has bogus
base64 data.
2003-03-10 16:13:50 +00:00
Greg Ward cd930f5258 openmixer()'s 'mode' parameter has been removed. 2003-03-10 03:18:19 +00:00
Greg Ward f882c77d70 Expand description of ossaudiodev.error exception.
Improve descriptions of open(), openmixer().
2003-03-10 03:05:21 +00:00
Greg Ward 3e34f59ce2 Rewrite intro paragraphs and add a "See also" box for the link to the
official OSS docs.

Markup fixes: change \code{} variously to \function{}, \method{}, or
\constant{} as appropriate.
2003-03-10 02:09:51 +00:00
Greg Ward 074472ba98 Fix two unformatted lists: one is now an 'enumerate' environment, the
other a 'tableii'.

Formatting/typo fix.
2003-03-10 00:24:42 +00:00
Greg Ward 41a28e374c Add libossaudiodev.tex. 2003-03-10 00:07:14 +00:00
Greg Ward 33bcd987dd Wrap all paragraphs to 72 columns.
Two spaces between sentences.
Fix em-dashes -- should be "---" not " - ".
Spelling fix.
2003-03-09 23:57:34 +00:00
Greg Ward 620e343c0a Documentation for the ossaudiodev module.
Initial revision supplied by Nicholas FitzRoy-Dale <wzdd@lardcave.net>
(emailed to me [gward@python.net] 2003-03-08 23:37 +1100).
2003-03-09 23:34:52 +00:00
Raymond Hettinger 42182ebaf6 SF 698520: Iterator for urllib.URLOpener
Contributed by Brett Cannon.
2003-03-09 05:33:33 +00:00
Raymond Hettinger a3e1e4cd79 SF patch #693753: fix for bug 639806: default for dict.pop
(contributed by Michael Stone.)
2003-03-06 23:54:28 +00:00
Barry Warsaw 1a2c37316b Describe Charset.__repr__(). 2003-03-06 06:07:34 +00:00
Barry Warsaw f32e313914 Describe the new Header.encode() argument "splitchars". 2003-03-06 06:06:54 +00:00
Martin v. Löwis 73d538b9c6 Always initialize Py_FileSystemDefaultEncoding on Unix in Py_Initialize,
and not as a side effect of setlocale. Expose it as sys.getfilesystemencoding.
Adjust test case.
2003-03-05 15:13:47 +00:00
Michael W. Hudson 9c20615d4f Back in June in revision 1.98 Steve (accidentally, presumably) wiped
out a month's worth of checkins to libstdtypes.tex (including my
extended slice docs).

I think this checkin merges them all back in, but if you make one of
these checkins:

    revision 1.97
    date: 2002/06/14 00:27:13;  author: nnorwitz
    Use \code{True} (or False) instead of true/false.
    Not sure if code is correct, but that is what's in this file.
    I've seen \constant{True} in other places.
    ----------------------------
    revision 1.95
    date: 2002/05/22 20:39:43;  author: bwarsaw
    Jack's documentation for the U mode character on the file()
    constructor, vetted by Barry.
    ----------------------------
    revision 1.94
    date: 2002/05/21 18:19:15;  author: rhettinger
    Patch 543387.  Document deprecation of complex %, //,and divmod().
    ----------------------------
    revision 1.93
    date: 2002/05/15 15:45:25;  author: rhettinger
    Added missing index entries for mapping methods.  Closes patch
    #548693.

some checking may be in order.
2003-03-05 14:42:09 +00:00
Andrew M. Kuchling 69700ef573 Weaken recommendation of Friedl book; fix reference 2003-03-04 14:17:05 +00:00
Andrew M. Kuchling 02a0b3b81a [bug #692016] update description of {m,n} modifier; you can omit the lower bound 2003-03-04 14:12:24 +00:00
Andrew M. Kuchling 85f3227a74 [bug #696771] Remove misleading parenthetical aside 2003-03-04 14:07:51 +00:00
Just van Rossum 96b1c903f5 Patch #683592 revisited, after discussions with MvL:
- Implement the behavior as specified in PEP 277, meaning os.listdir()
  will only return unicode strings if it is _called_ with a unicode
  argument.
- And then return only unicode, don't attempt to convert to ASCII.
- Don't switch on Py_FileSystemDefaultEncoding, but simply use the
  default encoding if Py_FileSystemDefaultEncoding is NULL. This means
  os.listdir() can now raise UnicodeDecodeError if the default encoding
  can't represent the directory entry. (This seems better than silcencing
  the error and fall back to a byte string.)
- Attempted to decribe the above in Doc/lib/libos.tex.
- Reworded the Misc/NEWS items to reflect the current situation.

This checkin also fixes bug #696261, which was due to os.listdir() not
using Py_FileSystemDefaultEncoding, like all file system calls are
supposed to.
2003-03-03 17:32:15 +00:00
Michael W. Hudson f008998668 Fix bug
[ 555817 ] Flawed fcntl.ioctl implementation.

with my patch that allows for an array to be mutated when passed
as the buffer argument to ioctl() (details complicated by
backwards compatibility considerations -- read the docs!).
2003-03-03 12:29:42 +00:00
Guido van Rossum 46d3dc37e4 - New function sys.exc_clear() clears the current exception. This is
rarely needed, but can sometimes be useful to release objects
  referenced by the traceback held in sys.exc_info()[2].  (SF patch
  #693195.)  Thanks to Kevin Jacobs!
2003-03-01 03:20:41 +00:00
Neal Norwitz 7aba3d471f Fix SF bug #691276, shutil.copytree documentation bug 2003-02-23 21:36:47 +00:00
Raymond Hettinger 61fe64d5de User requested changes to the itertools module.
Subsumed times() into repeat().
Added cycle() and chain().
2003-02-23 04:40:07 +00:00
Michael W. Hudson f5dd753f4d I'm am the PyPy sprint waiting for a Grand Renaming so I killed a few
seconds making the doc for get_completer marginally less minimal :)
2003-02-21 20:11:09 +00:00
Neal Norwitz b7d1d3cf23 Add some minimal doc for get_completer added for patch 676342 2003-02-21 18:57:05 +00:00
Raymond Hettinger 1b56de05d5 Fill in missing table entries. 2003-02-21 05:42:13 +00:00
Raymond Hettinger a97e4f3a49 SF bug #685775: turtle circle() documentation error 2003-02-21 03:14:08 +00:00
Raymond Hettinger 1b18ba49ab Markup and nits. 2003-02-21 01:45:34 +00:00
Neal Norwitz d08baa9504 Add some notes about HIGHEST_PROTOCOL. 2003-02-21 00:26:33 +00:00
Neal Norwitz 6fa635df7a SF patch #687683, Patches to logging (updates from Vinay)
Mostly rename WARN -> WARNING
Other misc tweaks
Update tests (not in original patch)
2003-02-18 14:20:07 +00:00
Neal Norwitz f927f14eda Fix SF bug #687655, String formatting conversions misleading 2003-02-17 18:57:06 +00:00
Skip Montanaro 117910dc44 Migrate definitions of several platform-dependent path-related variables
into the relevant path modules.  See patch #686397.
2003-02-14 19:35:31 +00:00
Fred Drake 002a5de202 extsep description:
- avoid "e.g." in text
- record version information
(should be backported)
2003-02-14 06:39:37 +00:00
Skip Montanaro 47e46e2347 add missing description of os.extsep 2003-02-14 05:45:31 +00:00
Raymond Hettinger 2835e37be5 SF bug #663701: sets module review
Renamed hook methods to use the double underscore convention.
2003-02-14 03:42:11 +00:00
Raymond Hettinger e544f6f682 SF bug #663701. The caret wasn't printing well in the PDF documentation. 2003-02-14 01:49:09 +00:00
Neal Norwitz 12d31e2e9d Try to doc the new pickle details being implemented as part of PEP 307.
Needs review.
2003-02-13 03:12:48 +00:00
Neal Norwitz 2294c0d4ec Cleanup from patch #683257:
Add missing INCREFs and re-indent returns to be consistent.
 Add \n\ for lines in docstring
 Add a pathetic test
 Add docs
2003-02-12 23:02:21 +00:00
Gustavo Niemeyer a33d0aa693 Unparenting BZ2File, as discussed in SF patch #661796.
* Modules/bz2module.c
  (BZ2FileObject): Now the structure includes a pointer to a file object,
   instead of "inheriting" one. Also, some members were copied from the
   PyFileObject structure to avoid dealing with the internals of that
   structure from outside fileobject.c.

  (Util_GetLine,Util_DropReadAhead,Util_ReadAhead,Util_ReadAheadGetLineSkip,
   BZ2File_write,BZ2File_writelines,BZ2File_init,BZ2File_dealloc,
   BZ2Comp_dealloc,BZ2Decomp_dealloc):
   	These functions were adapted to the change above.

  (BZ2File_seek,BZ2File_close): Use PyObject_CallMethod instead of
   getting the function attribute locally.

  (BZ2File_notsup): Removed, since it's not necessary anymore to overload
   truncate(), and readinto() with dummy functions.

  (BZ2File_methods): Added xreadlines() as an alias to BZ2File_getiter,
   and removed truncate() and readinto().

  (BZ2File_get_newlines,BZ2File_get_closed,BZ2File_get_mode,BZ2File_get_name,
   BZ2File_getset):
   	Implemented getters for "newlines", "mode", and "name".

  (BZ2File_members): Implemented "softspace" member.

  (BZ2File_init): Reworked to create a file instance instead of initializing
   itself as a file subclass. Also, pass "name" object untouched to the
   file constructor, and use PyObject_CallFunction instead of building the
   argument tuple locally.

  (BZ2File_Type): Set tp_new to PyType_GenericNew, tp_members to
   BZ2File_members, and tp_getset to BZ2File_getset.

  (initbz2): Do not set BZ2File_Type.tp_base nor BZ2File_Type.tp_new.


* Doc/lib/libbz2.tex
  Do not mention that BZ2File inherits from the file type.
2003-02-11 18:46:20 +00:00
Michael W. Hudson eb189934ce Fix so it compiles at least.
"make lib" takes a while, doesn't it?
2003-02-11 14:24:13 +00:00
Michael W. Hudson aab0260682 Remove erroneous period. 2003-02-10 19:21:16 +00:00
Raymond Hettinger 60eca9331a C Code:
* Removed the ifilter flag wart by splitting it into two simpler functions.
* Fixed comment tabbing in C code.
* Factored module start-up code into a loop.

Documentation:
* Re-wrote introduction.
* Addede examples for quantifiers.
* Simplified python equivalent for islice().
* Documented split of ifilter().

Sets.py:
* Replace old ifilter() usage with new.
2003-02-09 06:40:58 +00:00
Tim Peters 07534a607b Comparison for timedelta, time, date and datetime objects: __eq__ and
__ne__ no longer complain if they don't know how to compare to the other
thing.  If no meaningful way to compare is known, saying "not equal" is
sensible.  This allows things like

    if adatetime in some_sequence:
and
    somedict[adatetime] = whatever

to work as expected even if some_sequence contains non-datetime objects,
or somedict non-datetime keys, because they only call __eq__.

It still complains (raises TypeError) for mixed-type comparisons in
contexts that require a total ordering, such as list.sort(), use as a
key in a BTree-based data structure, and cmp().
2003-02-07 22:50:28 +00:00
Raymond Hettinger 2012f174ea SF bug #681003: itertools issues
* Fixed typo in exception message for times()
* Filled in missing times_traverse()
* Document reasons that imap() did not adopt a None fill-in feature
* Document that count(sys.maxint) will wrap-around on overflow
* Add overflow test to islice()
* Check that starmap()'s argument returns a tuple
* Verify that imap()'s tuple re-use is safe
* Make a similar tuple re-use (with safety check) for izip()
2003-02-07 05:32:58 +00:00
Neal Norwitz 2b09bc4d57 Fix SF bug #675259, os.environ leaks under FreeBSD and Mac OS X
Even with the extra work to cleanup the env, *BSD still leaks.  Add a note.

Will backport.
2003-02-07 02:27:36 +00:00
Neal Norwitz 694d9b3541 Update doc to reflect code changes for obsoleting use_statcache parameter 2003-02-06 21:17:17 +00:00
Andrew M. Kuchling 93cf58b015 Typo fixes 2003-02-06 18:04:43 +00:00
Andrew M. Kuchling ba37524b7c Fix description of filterwarnings() parameters (error noted by Richard Jones at
http://mechanicalcat.net/cgi-bin/log/python/turning_warnings_off.html)
2003-02-06 14:38:45 +00:00
Neal Norwitz 292f56cd26 Provide version changed info 2003-02-06 05:02:39 +00:00
Anthony Baxter 983b008824 Updated version of [ 558544 ] cmd.py: add instance-specific stdin/out
This patch adds stdin, stdout as optional arguments to the cmd.Cmd
constructor (defaulting to sys.stdin, sys.stdout), and changes the Cmd
methods throughout to use self.stdout.write() and self.stdin.foo for
output and input. This allows much greater flexibility for using cmd -
for instance, hooking it into a telnet server.

Patch for library module and for documentation.
2003-02-06 01:45:11 +00:00
Andrew M. Kuchling 570e35870a Markup fixes; in particular, the tables are now reasonable width 2003-02-05 21:15:38 +00:00
Fred Drake 604ade4ebd supports_unicode_filenames was not in the right location. 2003-02-04 19:13:07 +00:00
Fred Drake 57d575240c Update to better reflect the usage of struct_time instances throughout;
continuing to call these "time tuples" is misleading at best.
Closes SF bug #671731; will backport to 2.2.x.
2003-02-04 15:12:06 +00:00
Andrew M. Kuchling 4b37364fc8 Bug #678077: Suggest alternative to os.getlogin() 2003-02-03 15:36:26 +00:00
Raymond Hettinger 96ef8115dd Move itertools module from the sandbox and into production. 2003-02-01 00:10:11 +00:00
Walter Dörwald 2e0b18af30 Change the treatment of positions returned by PEP293
error handers in the Unicode codecs: Negative
positions are treated as being relative to the end of
the input and out of bounds positions result in an
IndexError.

Also update the PEP and include an explanation of
this in the documentation for codecs.register_error.

Fixes a small bug in iconv_codecs: if the position
from the callback is negative *add* it to the size
instead of substracting it.

From SF patch #677429.
2003-01-31 17:19:08 +00:00
Raymond Hettinger 2adbb83a24 SF bug #671447: StringIO doc doesn't say it's sometimes read-only. 2003-01-31 05:17:33 +00:00
Fred Drake 008a36ac20 Fix markup error. 2003-01-30 22:22:59 +00:00
Raymond Hettinger 301eb71fb9 Author markup: Andrew got to it first 2003-01-30 01:03:38 +00:00
Fred Drake 7934bc23a8 Move a footnote to the end of the sentence, so the note mark won't
interfere with the flow of the sentence.
2003-01-29 05:10:27 +00:00
Fred Drake c23e0192c9 More markup changes for consistency. 2003-01-28 22:09:16 +00:00
Fred Drake 68e6d57bb9 Various minor markup adjustments. 2003-01-28 22:02:35 +00:00
Fred Drake 0a9cc58c85 Adjust some of Skip's latest changes slightly; these really are things
that should stand out.
2003-01-27 16:32:04 +00:00
Skip Montanaro 13a28634ac * add \versionadded{} strings as appropriate
* remove doc for defunct IllegalKeywordArgument exception
* add note that HTTP class is for backward compatibility and refer reader to
  online docstrings for help
2003-01-27 15:00:38 +00:00
Raymond Hettinger 2ef85a729e Fix minor typos. 2003-01-25 21:46:53 +00:00
Neal Norwitz cd5c8c2120 SF #638299, LaTeX documentation for logging package
Replace existing doc with new version from Vinay.
Fixed markup and wrapped long lines from patch.
Needs review.
2003-01-25 21:29:41 +00:00
Neal Norwitz daae32721a Fix markup 2003-01-25 21:08:30 +00:00
Tim Peters 8d81a012ef date and datetime comparison: when we don't know how to
compare against "the other" argument, we raise TypeError,
in order to prevent comparison from falling back to the
default (and worse than useless, in this case) comparison
by object address.

That's fine so far as it goes, but leaves no way for
another date/datetime object to make itself comparable
to our objects.  For example, it leaves Marc-Andre no way
to teach mxDateTime dates how to compare against Python
dates.

Discussion on Python-Dev raised a number of impractical
ideas, and the simple one implemented here:  when we don't
know how to compare against "the other" argument, we raise
TypeError *unless* the other object has a timetuple attr.
In that case, we return NotImplemented instead, and Python
will give the other object a shot at handling the
comparison then.

Note that comparisons of time and timedelta objects still
suffer the original problem, though.
2003-01-24 22:36:34 +00:00
Barry Warsaw 6d9f9b3b67 Fred drives and fixes a formatting nit. 2003-01-24 17:33:30 +00:00
Tim Peters 2a44a8d332 SF bug 660872: datetimetz constructors behave counterintuitively (2.3a1).
This gives much the same treatment to datetime.fromtimestamp(stamp, tz) as
the last batch of checkins gave to datetime.now(tz):  do "the obvious"
thing with the tz argument instead of a senseless thing.
2003-01-23 20:53:10 +00:00
Tim Peters 10cadce41e Reimplemented datetime.now() to be useful. 2003-01-23 19:58:02 +00:00
Tim Peters f196a0a4dd "Premature" doc changes, for new astimezone() rules, and the new
tzinfo.fromutc() method.  The C code doesn't implement any of this
yet (well, not the C code on the machine I'm using now), nor does
the test suite reflect it.  The Python datetime.py implementation and
test suite in the sandbox do match these doc changes.  The C
implementation probably won't catch up before Thursday (Wednesday is
a scheduled "black hole" day this week <0.4 wink>).
2003-01-22 04:45:50 +00:00
Tim Peters b01c39bb94 SF bug 671779: Error in tzinfo.dst() docs
tzinfo dst() should return timedelta(0) if DST is not effect, not 0.
2003-01-21 16:44:27 +00:00
Skip Montanaro 1f7a271f0b more tweaks 2003-01-21 01:52:39 +00:00
Skip Montanaro 190613cee9 * document open() function
* promote the example and the documented restrictions to \subsection status
* document the flag parameter of the DbfilenameShelf class
2003-01-21 01:38:47 +00:00
Tim Peters 327098a613 New rule for tzinfo subclasses handling both standard and daylight time:
When daylight time ends, an hour repeats on the local clock (for example,
in US Eastern, the clock jumps from 1:59 back to 1:00 again).  Times in
the repeated hour are ambiguous.  A tzinfo subclass that wants to play
with astimezone() needs to treat times in the repeated hour as being
standard time.  astimezone() previously required that such times be
treated as daylight time.  There seems no killer argument either way,
but Guido wants the standard-time version, and it does seem easier the
new way to code both American (local-time based) and European (UTC-based)
switch rules, and the astimezone() implementation is simpler.
2003-01-20 22:54:38 +00:00
Raymond Hettinger 9543b34006 SF patch #670423: Add missing identity tests to operator.c 2003-01-18 23:22:20 +00:00
Fred Drake 42b567fce9 Fix a couple of markup errors. 2003-01-17 22:47:33 +00:00
Skip Montanaro a5caa6fcd9 reference the os module and the lock flags in the os.open() function.
(Someone please review what I wrote for accuracy.)
2003-01-15 21:08:19 +00:00
Raymond Hettinger 3801ec7ff3 Document that __cmp__() is not defined for sets.
Note, that list.sort() is undefined for lists of sets.
Add the ... prompt to the example so it runs in doctest.
2003-01-15 15:46:05 +00:00
Martin v. Löwis 0c6774d92b Patch #661719: Expose compilation errors as exceptions on request. 2003-01-15 11:51:06 +00:00
Martin v. Löwis d69663d300 Patch #473586: Implement CGIXMLRPCRequestHandler. 2003-01-15 11:37:23 +00:00
Raymond Hettinger 2bd1568d35 SF patch 664183 and SF bug 664044: Note that both u'%s' % 'x' and
'%s' % u'x'  return a unicode object.
2003-01-13 04:29:19 +00:00
Neal Norwitz 06daee9dd7 Try to make a sentance more readable. 2003-01-12 15:04:54 +00:00
Neal Norwitz e68fbc44aa SF #665570, curses causes interpreter crash
The interpreter doesn't crash, but it does call exit() in libncurses.
Add a note to this effect.

Will backport
2003-01-12 14:56:19 +00:00
Fred Drake 8ec17a0a8d Minor correction and clarification. 2003-01-11 23:15:47 +00:00
Neal Norwitz 3cb68a2512 Remove extra 'types'
Change a couple of list -> mylist
2003-01-10 13:52:30 +00:00
Raymond Hettinger 6fe1299b09 SF bug #652888: bad documentation for the "type" builtin
Clarified that not all types are included.  The OP was looking for a
StaticMethodType.

Also, added a note and example suggesting the use of int,str, etc.
instead of IntType, StrType, etc.

Renamed the crummy variable name in the example from "list" to "mylist".
2003-01-10 09:33:08 +00:00
Tim Peters 312141c51f Purged reference to defunct datetimetz. 2003-01-09 19:52:17 +00:00
Andrew M. Kuchling 9b44571caa Various minor edits 2003-01-09 13:46:30 +00:00
Andrew M. Kuchling 0f0e6b9d48 Markup fix 2003-01-09 12:51:50 +00:00
Tim Peters 003720235b Massive fiddling to reflect that datetimetz and timetz no longer exist.
WARNING:  It would be a minor miracle if the LaTeX stuff still worked.

s/field/member/ generally everywhere, to conform with most other usage in
the docs.

s/daylight savings time/daylight saving time/ generally everywhere,
because the latter spelling is anally correct.
2003-01-09 04:10:05 +00:00
Fred Drake 326c72a839 Add notes about the linuxaudiodev and ossaudiodev modules. 2003-01-08 07:21:53 +00:00
Greg Ward 19b6f60f5c There's no such method as has_option() -- should be has_extn(). 2003-01-08 03:04:42 +00:00
Barry Warsaw b6604b3e69 Document EX_OK and friends. 2003-01-07 22:43:25 +00:00
Neal Norwitz 051314f924 SF #664011, move tarfile module in docs 2003-01-07 22:36:04 +00:00
Raymond Hettinger 8ef3d8d5d1 Fix spelling. 2003-01-06 18:41:01 +00:00
Neal Norwitz 488609e43a SF #642236, optparse LaTeX docs by Johannes Gijsbers 2003-01-06 16:51:37 +00:00
Fred Drake 11f89b75e1 Strike any hint that from-import-* could ever be reasonable; it's a
vile abomination and should be eradicated!
2003-01-06 16:38:10 +00:00
Fred Drake 2e3ae21060 Fix some nits Guido brought up last August:
- give subsection pages nicer names
- shorten some really long table cells; table cells can't wrap in the
  typeset version of the documentation
2003-01-06 15:50:32 +00:00
Fred Drake 2b0a3d33f8 Fix markup so this will format again. 2003-01-06 15:03:11 +00:00
Raymond Hettinger 9f5b07dd92 SF bug #592859: os.chmod is underdocumented
Document constants for permission bits.
2003-01-06 13:31:26 +00:00
Neal Norwitz b9ef4aea5e SF #651082, tarfile module implementation from Lars Gustäbel 2003-01-05 23:19:43 +00:00
Neal Norwitz 6d23b170cf Fix a typo 2003-01-05 22:20:51 +00:00
Tim Peters 75a6e3bd1a datetime_from_timet_and_us(): ignore leap seconds if the platform
localtime()/gmtime() insists on delivering them, + associated doc
changes.

Redid the docs for datetimtez.astimezone().
2003-01-04 18:17:36 +00:00
Tim Peters adf642038e A new implementation of astimezone() that does what we agreed on in all
cases, plus even tougher tests of that.  This implementation follows
the correctness proof very closely, and should also be quicker (yes,
I wrote the proof before the code, and the code proves the proof <wink>).
2003-01-04 06:03:15 +00:00
Raymond Hettinger 69bf8f3f4e SF bug #655271: Slightly modify locals() doc
Clarify the operation of locals().
2003-01-04 02:16:22 +00:00
Raymond Hettinger 2ca243368f SF bug #651149: Review libshelve.tex when possible
Minor fixes to markup, spelling, parameter names, and abbreviations.
2003-01-04 01:53:38 +00:00
Tim Peters 8827d0c338 Replaced the flawed "local time" example tzinfo class with the guts
of Guido's later Local.py (from the datetime sandbox).
2003-01-03 22:26:57 +00:00
Tim Peters 397301eccb The tzinfo methods utcoffset() and dst() must return a timedelta object
(or None) now.  In 2.3a1 they could also return an int or long, but that
was an unhelpfully redundant leftover from an earlier version wherein
they couldn't return a timedelta.  TOOWTDI.
2003-01-02 21:28:08 +00:00
Skip Montanaro 4abd5f0fce Allow list sort's comparison function to explicitly be None. See SF patch
661092.
2003-01-02 20:51:08 +00:00
Tim Peters 710fb1548a astimezone() internals: if utcoffset() returns a duration, complain if
dst() returns None (instead of treating that as 0).
2003-01-02 19:35:54 +00:00
Neal Norwitz e149798c7f Add some version info for new methods and class 2003-01-02 15:32:00 +00:00
Fred Drake 74bcac4cae - documented Ellipsis, NotImplemented
- minor markup changes
- indented for consistency with newer content
2003-01-02 05:13:51 +00:00
Fred Drake 45e482fd3d Document that apply() is deprecated. See:
http://mail.python.org/pipermail/python-dev/2003-January/031556.html
2003-01-02 04:54:04 +00:00
Tim Peters f36151556f A quicker astimezone() implementation, rehabilitating an earlier
suggestion from Guido, along with a formal correctness proof of the
trickiest bit.  The intricacy of the proof reveals how delicate this
is, but also how robust the conclusion:  correctness doesn't rely on
dst() returning +- one hour (not all real time zones do!), it only
relies on:

1. That dst() returns a (any) non-zero value if and only if daylight
   time is in effect.

and

2. That the tzinfo subclass implements a consistent notion of time zone.

The meaning of "consistent" was a hidden assumption, which is now an
explicit requirement in the docs.  Alas, it's an unverifiable (by the
datetime implementation) requirement, but so it goes.
2003-01-01 21:51:37 +00:00
Skip Montanaro 0233bd9c7d mention built-in constants. 2003-01-01 20:37:14 +00:00
Skip Montanaro 1f041e7aa8 process libconsts.tex 2003-01-01 20:34:00 +00:00
Skip Montanaro 17804b1df4 new section - builtin constants 2003-01-01 20:33:38 +00:00
Fred Drake 0f8e543159 - use classdesc where we can (for better indexing)
- more style consistency crud
2002-12-31 18:31:48 +00:00
Fred Drake 436eadd455 General style conformance. Markup some unmarked constructs. 2002-12-31 18:13:11 +00:00
Raymond Hettinger f621232c0d Use funcdesc instead of classdesc to be consistent with out sections. 2002-12-31 17:24:50 +00:00
Fred Drake e2c649126e Further cleanup of exceptions. All interpolation-related exceptions
now derive from InterpolationError, which is not raised directly (only
subclasses get raised).  This matches what the docs already said.
2002-12-31 17:23:27 +00:00
Raymond Hettinger 6222958500 Spelling fix 2002-12-31 16:37:03 +00:00
Raymond Hettinger cbd6cd2312 Add markup for time object.
Cleanup whitespace.
Fix unbalanced parenthesis.
2002-12-31 16:30:49 +00:00
Tim Peters 9532298c82 Removed the now-untrue (or soon-to-be untrue) part of the astimezone()
docs.  Replaced it with an XXX block, because the hoped-for treatment
of DST endcases remains unclear (Guido doesn't really like raising an
exception when it's impossible to deliver a correct result, but so
far I have no way in hand to consistently deliver a defined incorrect
result either).
2002-12-31 16:01:47 +00:00
Eric S. Raymond 2852cbaf26 Document the new ,netrc awareness in nntplib. 2002-12-31 15:28:44 +00:00
Fred Drake f91b4619e0 Barry raised reasonable objections to the macro name \mimeheader, so
we'll simply revert to \mailheader since there's no other good name.
2002-12-31 15:23:09 +00:00
Fred Drake f14730a49a - correct the deprecation markups so this formats again
- some minor cleanups
2002-12-31 15:10:49 +00:00
Raymond Hettinger c5f5f87f74 Complete the markup for timedelta objects.
Fix a curly brace that should have been a paren.
2002-12-31 14:26:54 +00:00
Neal Norwitz f3edea5b90 Use the name (path) specified in the parameter list 2002-12-31 13:38:28 +00:00
Martin v. Löwis 96a60e4af5 Patch #658927: Add getctime to os.path.
Document that getatime and getmtime may return floats.
2002-12-31 13:11:54 +00:00
Martin v. Löwis 5c37a7717d Document standard encodings. 2002-12-31 12:39:07 +00:00
Neal Norwitz ee711092eb SmartCookie and SerialCookie were recently deprecated 2002-12-31 12:27:11 +00:00
Neal Norwitz 99448e5214 InterpolationSyntaxError was added in 2.3 2002-12-31 12:23:10 +00:00
Guido van Rossum 2714706188 Phrase repair. 2002-12-31 04:41:38 +00:00
Guido van Rossum 8e7ec7cec8 Minor markup and spelling repair. 2002-12-31 04:39:05 +00:00
Fred Drake 81e4aa7054 - re-mark ESR's warning about extended registry syntax
- document InterpolationSyntaxError
2002-12-30 23:50:19 +00:00
Fred Drake 740f80029c - fix use of \refmodule markup
- correct some module names, add hyperlinks
- wrap some long lines
2002-12-30 23:00:36 +00:00
Guido van Rossum 2969233f9a Add dummy_thread[ing] sections and reference these from libthread[ing]. 2002-12-30 22:34:10 +00:00
Guido van Rossum ad50ca91a9 Brett Cannon's dummy_thread and dummy_threading modules (SF patch
622537), with some nitpicking editorial changes.
2002-12-30 22:30:22 +00:00
Fred Drake a37e5cce4b We're using strictly American spellings, so there's no diaresis over
the i in naive.

More markup fixups.
2002-12-30 21:26:42 +00:00
Tim Peters bad8ff089a A step on the way to making tzinfo classes writable by mortals: get rid
of the timetz case.  A tzinfo method will always see a datetimetz arg,
or None, now.  In the former case, it's still possible that it will get
a datetimetz argument belonging to a different timezone.  That will get
fixed next.
2002-12-30 20:52:32 +00:00
Fred Drake 9bdeee492a Clean up a table so it passes formatting. 2002-12-30 20:35:32 +00:00
Raymond Hettinger 0de926fd12 Added the \var{} markup so the tables will look good. 2002-12-30 20:21:21 +00:00
Raymond Hettinger 6005a344ce Added markup upto line 233. 2002-12-30 20:01:24 +00:00
Barry Warsaw d1adc8a6af Describe the new `errors' argument to Header.__init__() and
Header.append()
2002-12-30 19:17:37 +00:00
Andrew M. Kuchling fa91858c6c More markup additions 2002-12-30 14:20:16 +00:00
Andrew M. Kuchling d6d7cfaada Minor grammar fix, and clarification 2002-12-30 03:08:27 +00:00
Andrew M. Kuchling c97868ee2f Mark up more text 2002-12-30 03:06:45 +00:00
Raymond Hettinger 40f6217092 SF patch 658251: Install a C implementation of the Mersenne Twister as the
core generator for random.py.
2002-12-29 23:03:38 +00:00
Raymond Hettinger c7b076928c Incorporate Skip's suggestion to use SciPy's validation test near
equality.  Note, there is another flavor that compares to a given
number of significant digits rather than decimal places.  If there
is a demand, that could be added at a later date.
2002-12-29 17:59:24 +00:00
Raymond Hettinger f8bcfb13f1 SF Bug 645777: list.extend() works with any iterable and is no longer
experimental.
2002-12-29 05:49:09 +00:00
Tim Peters 276a8f3b80 astimezone(): document that None is an OK argument. 2002-12-27 21:41:32 +00:00
Eric S. Raymond 56b3184e89 Added a useful warning to the documentation. 2002-12-27 20:05:36 +00:00
Martin v. Löwis 33e94437ca Document killpg. 2002-12-27 10:21:19 +00:00
Martin v. Löwis 438b534ad0 Patch #657889: Implement posix.getloadavg. 2002-12-27 10:16:42 +00:00
Tim Peters 60c76e4016 Make comparison and subtraction of aware objects ignore tzinfo if the
operands have identical tzinfo members (meaning object identity -- "is").
I misunderstood the intent here, reading wrong conclusion into
conflicting clues.
2002-12-27 00:41:11 +00:00
Just van Rossum 8982595870 Backing out patch #642578 in anticipation of final acceptance of PEP 302. 2002-12-25 23:13:34 +00:00
Raymond Hettinger e11b510a5b SF 658405: calendar.py to rely on the datetime module instead of the time
module.

The code is shorter, more readable, faster, and dramatically increases the
range of acceptable dates.

Also, used the floor division operator in leapdays().
2002-12-25 16:37:19 +00:00
Tim Peters 80475bb4d2 Implemented datetime.astimezone() and datetimetz.astimezone(). 2002-12-25 07:40:55 +00:00
Tim Peters 52d134874f Removed blurb admonishing users to raise an exception if the datetime
argument to a tzinfo method doesn't have a matching tzinfo member.
2002-12-24 16:34:13 +00:00
Tim Peters 2483b61e03 Added note about technical pickle limitation on tzinfo instances. 2002-12-24 16:30:58 +00:00
Tim Peters 1cff9fc97c tzinfo.{utcoffset,dst} can return timedelta (or integer or None).
{timetz,datetimetz}.{uctcoffset,dst} do return timedelta (or None).
2002-12-24 16:25:29 +00:00
Tim Peters 12bf339aea Implemented .replace() methods for date, datetime, datetimetz, time and
timetz.
2002-12-24 05:41:27 +00:00
Tim Peters 29fb9c7e07 Brought the strftime explanation into synch with the plain-text sandbox
docs, and moved its section to the end (before the "C API" section,
which latter doesn't really belong in the Library manual).
2002-12-23 22:21:52 +00:00
Fred Drake 446f32367b Add in the datetime docs now that they pass LaTeX. Still ugly, but that can
be fixed.
2002-12-23 19:03:00 +00:00
Fred Drake bbdb250862 Lots of markup changes. This is still pretty sad, but passes LaTeX
and is mostly readable.
2002-12-23 18:58:06 +00:00
Fred Drake ce5200842e Move the examples of concrete tzinfo classes to a separate file, so the
verbatim environment does not bollux page breaking.
2002-12-23 18:52:19 +00:00
Fred Drake 4a80a3ec21 Added docs for (draft) pkgutil module. 2002-12-23 16:53:59 +00:00
Tim Peters 8ed8320827 Fixed longstanding bug in the description of strftime's %W code. 2002-12-20 17:15:39 +00:00
Andrew M. Kuchling ca2623a2f9 Check in current, unfinished, draft of datetime docs
(Fred, don't bother to add to lib.tex or to proofread this yet.)
2002-12-18 14:59:11 +00:00
Fred Drake e0f02f0826 Fix some small markup nits. 2002-12-18 02:07:14 +00:00
Neal Norwitz 3e93b4d222 Fix typo spotted by Richie Hindle 2002-12-18 01:20:29 +00:00
Michael W. Hudson cfd3884882 This is Richie Hindle's patch
[ 643835 ] Set Next Statement for Python debuggers

with a few tweaks by me: adding an unsigned or two, mentioning that
not all jumps are allowed in the doc for pdb, adding a NEWS item and
a note to whatsnew, and AuCTeX doing something cosmetic to libpdb.tex.
2002-12-17 16:15:34 +00:00
Neal Norwitz 212b43f90c Add markup for base parameter 2002-12-17 01:24:11 +00:00
Neal Norwitz 046b8a7244 Fix SF # 641111, Undocumented side effect of eval
Try to clear up confusion about the current globals being copied
into a globals dict passed to eval().  This wording (more or less)
was suggested in bug report.  It should probably be made clearer.

Backport candidate.
2002-12-17 01:08:06 +00:00
Neal Norwitz e9ce25e512 Fix SF #642742, property() builtin not documented
Added doc for functions new to 2.2:  classmethod property staticmethod super
Taken from docstrings.  Could use review.
Hope there wasn't a reason why these shouldn't have been added.

Backport candidate.
2002-12-17 01:02:57 +00:00
Gustavo Niemeyer 786ddb29c9 Fixed bug
[#521782] unreliable file.read() error handling

* Objects/fileobject.c
  (file_read): Clear errors before leaving the loop in all situations,
  and also check if some data was read before exiting the loop with an
  EWOULDBLOCK exception.

* Doc/lib/libstdtypes.tex
* Objects/fileobject.c
  Document that sometimes a read() operation can return less data than
  what the user asked, if running in non-blocking mode.

* Misc/NEWS
  Document the fix.
2002-12-16 18:12:53 +00:00
Just van Rossum edd179ee77 typo fix. 2002-12-15 13:14:22 +00:00
Raymond Hettinger 866964c3a3 Apply SF patch 652930: Add optional base argument to math.log(x[, base]). 2002-12-14 19:51:34 +00:00
Walter Dörwald d9a6ad3beb Enhance issubclass() and PyObject_IsSubclass() so that a tuple is
supported as the second argument. This has the same meaning as
for isinstance(), i.e. issubclass(X, (A, B)) is equivalent
to issubclass(X, A) or issubclass(X, B). Compared to isinstance(),
this patch does not search the tuple recursively for classes, i.e.
any entry in the tuple that is not a class, will result in a
TypeError.

This closes SF patch #649608.
2002-12-12 16:41:44 +00:00
Just van Rossum b083cb3901 Patch #651621, approved by MvL.
This patch allows ZipFile.writestr() to be called with
an archive file name instead of a ZipInfo instance:

z = ZipFile("myarchive.zip", "w")
z.writestr("foo/baz/file.ext", data)
z.close()

I found the old writestr() method very inconvenient
for simple (but common) things.

If called with a file name instead of a ZipInfo
instance, the date_time is set to the current date/time,
which makes sense to me for anonymous data.
2002-12-12 12:23:32 +00:00
Martin v. Löwis 0479104a91 Patch #651006: Better explain what component might be empty. 2002-12-11 12:55:53 +00:00
Raymond Hettinger d2bef8256b Update comments about the performance of xrange(). 2002-12-11 07:14:03 +00:00
Skip Montanaro 3bf99e3e87 Add support for binary pickles to the shelve module. In some situations
this can result in significantly smaller files.  All classes as well as the
open function now accept an optional binary parameter, which defaults to
False for backward compatibility.  Added a small test suite, updated the
libref documentation (including documenting the exported classes and fixing
a few other nits) and added a note about the change to Misc/NEWS.
2002-12-08 18:36:24 +00:00
Fred Drake edb635ff5c Remove extra ")" in example. 2002-12-06 18:52:28 +00:00
Fred Drake 08d10f985e Typo: "dead lock" --> "deadlock" 2002-12-06 16:45:05 +00:00
Fred Drake a41b2bb981 Fix problem in example code. It's minor in this particular example,
but can lead to mysterious problems in real applications.
2002-12-03 22:57:37 +00:00
Fred Drake 7af24bd237 Fix example regular expressions that simulate scanf() constructs. 2002-12-03 18:49:17 +00:00
Martin v. Löwis 71aa6d6db9 Patch #646824: Remove extra \end. 2002-12-03 18:09:02 +00:00
Just van Rossum 3eb166b49b Slightly improved version of patch #642578: "Expose PyImport_FrozenModules
in imp". This adds two functions to the imp module: get_frozenmodules()
and set_frozenmodules().
2002-11-29 20:47:40 +00:00
Raymond Hettinger e33d3df030 SF Patch 643443. Added dict.fromkeys(iterable, value=None), a class
method for constructing new dictionaries from sequences of keys.
2002-11-27 07:29:33 +00:00
Fred Drake e9cfcef71e Clarify the interpretation of the __getstate__() return value for
new-style classes.
Closes SF bug #637941.
2002-11-27 05:26:46 +00:00
Gustavo Niemeyer 057ab14e7d * libbz2.tex
Fixed minor typo, suggested by Drew Perttula <drewp@bigasterisk.com>.
2002-11-25 18:51:43 +00:00
Andrew M. Kuchling 15353f5c64 Remove extra word 2002-11-25 16:01:08 +00:00
Martin v. Löwis b5c980b802 Add unidata_version. Bump generator version number. 2002-11-25 09:13:37 +00:00
Martin v. Löwis 677bde2dd1 Patch #626485: Support Unicode normalization. 2002-11-23 22:08:15 +00:00
Fred Drake 6e596b6895 Added change note about returning a dictionary based on keyword
arguments.
2002-11-23 15:02:13 +00:00
Just van Rossum a797d8150d Patch #642500 with slight modifications: allow keyword arguments in
dict() constructor. Example:
  >>> dict(a=1, b=2)
  {'a': 1, 'b': 2}
  >>>
2002-11-23 09:45:04 +00:00
Fred Drake a191befb2d Clarify the default setting for daemon_threads. 2002-11-22 14:29:42 +00:00
Fred Drake 74f5a56c2c Fix markup. 2002-11-22 14:28:53 +00:00
Martin v. Löwis 4581cfa326 Patch #486438: Make module argument to testmod optional. 2002-11-22 08:23:09 +00:00
Martin v. Löwis f86e8ef33e Patch #550765: Add daemon_threads flag. 2002-11-22 08:08:44 +00:00
Piers Lauder d3c821ee71 added details of new IMAP4_stream class; emphasised meaning of data part of command results; added proxyauth command description 2002-11-22 05:47:39 +00:00
Martin v. Löwis d899605e30 Patch #633547: Support plural forms. Do TODOs in test suite. 2002-11-21 21:45:32 +00:00
Tim Peters 3350b5bfd9 NamedTemporaryFile: clarify behavior based on confusions noted by a
user, and spell out a x-platform use limitation.
2002-11-21 16:32:11 +00:00
Walter Dörwald 72f861657a Document additional error handling names available through PEP 293. 2002-11-19 21:51:35 +00:00
Walter Dörwald f171540ab8 Change int() so that passing a string, unicode, float or long argument
that is outside the integer range no longer raises OverflowError, but
returns a long object instead.

This fixes SF bug http://www.python.org/sf/635115
2002-11-19 20:49:15 +00:00
Raymond Hettinger 311f419628 Improve comments. Clarify docs.
Replace "type(0)" with "int".
Replace "while 1" with "while True"
2002-11-18 09:01:24 +00:00
Raymond Hettinger 8ddc176e2e Improve DictMixin.
Replaced docstring with comments.  Prevents subclass contamination.
Added the missing __cmp__() method and a test for __cmp__().
Used try/except style in preference to has_key() followed by a look-up.
Used iteritem() where possible to save creating a long key list and
   to save redundant lookups.
Expanded .update() to look for the most helpful methods first and gradually
   work down to a mininum expected interface.
Expanded documentation to be more clear on how to use the class.
2002-11-18 04:34:10 +00:00
Skip Montanaro 6141812820 correct typo detected by Lee Hansen 2002-11-17 11:09:50 +00:00
Fred Drake e55bec2566 Better note that str.zfill() was added in 2.2.2 as well. ;-( 2002-11-16 00:44:00 +00:00
Fred Drake 9171801de9 Document that a minor feature was added in 2.2.2. ;-(
Closes SF bug #639170.
2002-11-16 00:41:55 +00:00
Neal Norwitz 5654cc215a SF 639138, Ref. calendar module in time docs by John J Lee
Will backport.
2002-11-15 23:00:30 +00:00
Fred Drake c734b01759 Fix critical markup errors. 2002-11-15 18:49:57 +00:00
Fred Drake 3a2cda876b Minor revisions to clarify the status of xreadlines(), change the way
iteration support was documented; the docs for __iter__() were just
confusing.
2002-11-15 16:38:06 +00:00
Raymond Hettinger 7994716b6b SF patch #520382: Expand shelve.py to have a full dictionary interface
and add a mixin to UserDict.py to make it easier to implement a full
dictionary interface.
2002-11-15 06:46:14 +00:00
Skip Montanaro 4ebe2e3914 add liblogging 2002-11-14 03:58:20 +00:00
Skip Montanaro 649698f72e initial rough cut at documentation of logging module. This is basically
just a conversion of pydoc.help(logging).
2002-11-14 03:57:19 +00:00
Fred Drake bad460790e Document struct_time and the field names. 2002-11-13 19:05:01 +00:00
Fred Drake a5a173efbf Fix broken markup.
Closes SF bug #637807.
2002-11-13 17:48:15 +00:00
Fred Drake 2c184e7eea Typo: it's --> its
Closes SF bug #637810.
2002-11-13 15:56:13 +00:00
Fred Drake 3d03968c75 Clarified meaning of \w and \W with respect to the UNICODE and LOCALE flags.
Closes SF bug #635595.
2002-11-12 23:12:54 +00:00
Tim Peters b9099c3df4 SF patch 637176: list.sort crasher
Armin Rigo's Draconian but effective fix for

SF bug 453523: list.sort crasher

slightly fiddled to catch more cases of list mutation.  The dreaded
internal "immutable list type" is gone!  OTOH, if you look at a list
*while* it's being sorted now, it will appear to be empty.  Better
than a core dump.
2002-11-12 22:08:10 +00:00
Fred Drake 4b9ed2f346 Clarified documentation of tempnam().
Closes SF bug #635656.
2002-11-12 22:07:11 +00:00
Raymond Hettinger f24eb35d18 SF patch 629637: Add sample(population, k) method to the random module.
Used for random sampling without replacement.
2002-11-12 17:41:57 +00:00
Walter Dörwald 430b1563dd Add documentation for the PEP 293 functionality:
The errors attribute can be changed after the reader/writer
is created.

For encoding there are two additional errors values:
"xmlcharrefreplace" and "backslashreplace".

These values can be extended via register_error().
2002-11-07 22:33:17 +00:00
Fred Drake b5f41dedeb Minor markup adjustments. 2002-11-07 17:13:03 +00:00
Thomas Heller 5b470e0a3a Document the changed fdopen behaviour.
(Hope the markup is ok).
2002-11-07 16:33:44 +00:00
Andrew M. Kuchling e3fb22bd4a [Patch #633635 from David M. Cooke]
Make docs accurate; getch() in nodelay mode returns -1
2002-11-06 14:17:21 +00:00
Neal Norwitz 110aa50cc2 Fix minor wording and 2 typos 2002-11-05 23:55:27 +00:00
Neal Norwitz fad265e651 Whoops, fix the typo correctly this time 2002-11-05 22:46:39 +00:00
Barry Warsaw 75f36b7040 Document the new `pp' command. 2002-11-05 22:41:16 +00:00
Neal Norwitz c2f7757ef5 Fix minor typos 2002-11-05 22:37:58 +00:00
Martin v. Löwis a288a234ec Document that images go away when they go away. Fixes #632323. 2002-11-05 22:11:50 +00:00
Fred Drake 18c7d98bd1 Fix a few minor nits. Still need to actually proofread this. 2002-11-05 17:54:02 +00:00
Gustavo Niemeyer f8ca8364c9 Patch implementing bz2 module.
* setup.py
  (PyBuildExt.detect_modules): Included bz2 module detection.

* Modules/bz2module.c
* Lib/test/test_bz2.py
* Doc/lib/libbz2.tex
  Included files implementing, testing, and documenting bz2 module.

* Doc/Makefile.deps
* Doc/lib/lib.tex
  Include references to libbz2.tex.

* Misc/NEWS
  (Library): Mention distutils' c++ linkage patch, and new bz2 module.
2002-11-05 16:50:05 +00:00
Martin v. Löwis 22610da481 Document symbolic constants for commands. 2002-11-04 17:41:18 +00:00
Martin v. Löwis 1da9c57c74 Patch #630829: Don't block on IAC, process suboptions. 2002-11-04 09:56:00 +00:00
Martin v. Löwis f0a4668e6f Add getpreferredencoding. Support @euro modifiers. Fixes #554676.
The @euro part is backported to 2.2.3.
2002-11-03 17:20:12 +00:00
Neal Norwitz cf57e50989 Fix SF #632864, Typo string instead of sting in LibDoc. Will backport. 2002-11-03 13:13:20 +00:00
Neal Norwitz 034c749ff4 Fix SF #618146, overflow error in calendar module
Will backport.
2002-11-03 00:13:42 +00:00
Walter Dörwald 1a7a894d90 Move introductory sentence to where it belongs. 2002-11-02 13:32:07 +00:00
Fred Drake 9482d2591a Update example for the type() function to use the currently accepted
preference of using "is" instead of "==" to compare types, use
built-in names where available, and point to the isinstance()
function.
Closes SF bug #632196.
2002-11-01 21:33:44 +00:00
Andrew M. Kuchling 3adefccdcb Use personal e-mail address 2002-10-30 21:08:34 +00:00
Fred Drake 4e303aad05 Add notes to the asctime() and ctime() descriptions to make it
explicit that locale information is not used.  There wasn't anything
that implied it was, but this has confused users.
2002-10-30 18:17:03 +00:00
Martin v. Löwis 74b51ac1e5 Patch #613256: Add nescape method to xml.sax.saxutils. 2002-10-26 14:50:45 +00:00
Fred Drake 0eebd5cef9 Implement a safer and more predictable interpolation approach.
Closes SF bug #511737.
2002-10-25 21:52:00 +00:00
Fred Drake 97d5f05221 Update to reflect the refactoring into the RawConfigParser and
ConfigParser classes.
2002-10-25 20:20:58 +00:00
Fred Drake f596826673 - The "-" format flag overrides the "0" flag, not the "-" flag.
- Documented the alternate forms, which were claimed to be documented
  but were not.
2002-10-25 16:55:51 +00:00
Fred Drake 50276abd9b Update an example to use the DOM implementation object. Explain that
the parse() and parseString() functions use a separate parser, not
actually implement a parser.  (This is a common question.)
2002-10-24 19:36:04 +00:00
Fred Drake ff287cfb4c Point to the PyXML package as an extended version of the "xml" package
that can provide this fuctionality.

Note that the docs for the xml.dom and xml.sax packages are the
definitiona of the Python bindings for the DOM and SAX interfaces.
2002-10-23 20:58:32 +00:00
Fred Drake 88f015dc88 Moved description of _urlopener adjacent to the related functions.
Added missing import to example code.

Added documentation for pathname2url(), url2pathname().
Closes SF bug #623196.
2002-10-22 21:58:06 +00:00
Fred Drake d6cf8bea0a Modify example to use string methods instead of the string module. 2002-10-22 20:31:22 +00:00
Fredrik Lundh 019bd4a6c1 terminology 2002-10-22 18:26:28 +00:00
Fredrik Lundh 1303c7cb16 add support for basic authentication, based on patch #624180
by Phillip J. Eby
2002-10-22 18:23:00 +00:00
Fred Drake 7d428ecc57 Clarify what versions of Windows are supported, and add Linux
specifically.
2002-10-22 15:06:49 +00:00
Fredrik Lundh e7c38d48ff fixed the mail address in the documentation, too... 2002-10-19 20:22:56 +00:00
Fred Drake d8eeeae4a6 Fix reference to the Fetchmail FAQ:
- URL was missing an "m"
- markup for tilde was wrong
- URL was marked as the title
- actual title was omitted

"make webcheck" didn't catch this; not sure why.

Removed some spurious end-of-line whitespace.
2002-10-18 16:50:17 +00:00
Fred Drake 5f2c1d27b9 Typo(!): "normal" -> "number" 2002-10-17 19:23:43 +00:00
Fred Drake 98ef20d5e4 Document urldefrag(). 2002-10-16 20:07:54 +00:00
Martin v. Löwis f607bdaa77 Add PyStructSequence_UnnamedField. Add stat_float_times.
Use integers in stat tuple, optionally floats in named fields.
2002-10-16 18:27:39 +00:00
Martin v. Löwis 77ac429eff Patch #572628: Optional timeouts for put and get. 2002-10-15 15:11:13 +00:00
Fred Drake 16ecb2160f Fix tildes in URLs. Closes SF bug #614821. 2002-10-12 15:02:46 +00:00
Martin v. Löwis 36a4d8c20e Remove mentionings of DOS. 2002-10-10 18:24:54 +00:00
Fred Drake 5430f4e9c8 Document when unittest was added to Python. 2002-10-10 16:16:25 +00:00
Barry Warsaw 6f0f961741 Update email micro release number. 2002-10-10 15:58:19 +00:00
Barry Warsaw df88b9fadf Document that the Charset constructor coerces its argument to lower
case.
2002-10-10 15:23:38 +00:00
Barry Warsaw 57ce1430b2 Document that get_content_charset() coerces its return value to lower
case.
2002-10-10 15:22:16 +00:00
Martin v. Löwis dbe3f76270 Patch #569139: Implementation of major, minor and makedev. 2002-10-10 14:27:30 +00:00
Fred Drake aa02c8441b Accept Armin's documentation patch for SF bug #558179.
Adjusted some markup to make the descriptions more consistent.
2002-10-09 22:33:23 +00:00
Mark Hammond 8696ebcd28 Add os.path.supports_unicode_filenames for all platforms,
sys.getwindowsversion() on Windows (new enahanced Tim-proof <wink>
version), and fix test_pep277.py in a few minor ways.
Including doc and NEWS entries.
2002-10-08 02:44:31 +00:00
Martin v. Löwis e9ce0b0fea Patch #448038: Add move(). Report errors from copytree as in shutil.Error. 2002-10-07 13:23:24 +00:00
Martin v. Löwis a844f2d165 Document patch #594001. 2002-10-05 09:46:48 +00:00
Fred Drake 0ba5541a0e Add a comment to the top of the file explaining why the file is here. 2002-10-01 18:20:16 +00:00
Barry Warsaw dd868d32e0 nits 2002-10-01 15:29:09 +00:00
Barry Warsaw de6977f441 Added an introduction. 2002-10-01 15:13:29 +00:00
Fred Drake c61617320f Stub document for the stand-alone email package distribution.
Barry, please add a reasonable abstract!
2002-10-01 14:38:47 +00:00
Fred Drake 6516e14968 Minor style nit for referring to other attributes of the same class
from an attributes description.
2002-10-01 14:29:58 +00:00
Fred Drake fcc31b44d2 Split the long email package examples into separate files and use
\verbatiminput instead of the verbatim environment -- this does the "right
thing" regarding page breaks in long examples for the typeset formats, and
has nice benefits for the HTML version as well.
2002-10-01 14:17:10 +00:00
Barry Warsaw ea66abc6e2 Cleaned up the examples. 2002-10-01 04:48:06 +00:00
Barry Warsaw 5db478fa29 Proofread and spell checked, all except the Examples section (which
I'll do next).
2002-10-01 04:33:16 +00:00
Barry Warsaw 5b9da893d3 Vast update to email version 2. This could surely use proofreading. 2002-10-01 01:05:52 +00:00
Fred Drake 2ca041fde0 items(): New method, provided by Gustavo Niemeyer in SF bug #545096. 2002-09-27 15:49:56 +00:00
Fred Drake 4613876ee3 Add deprecation notices to the documentation to reflect recent additions to
PEP 4.
2002-09-25 22:13:27 +00:00
Fred Drake 3e930ba55f Another try at clarifying what goes into and comes out of Unicode objects. 2002-09-24 21:08:37 +00:00
Fred Drake 36c2bd8e34 Remove spurious period. 2002-09-24 15:32:04 +00:00
Fred Drake 7b788e0582 Clarify that len() of a Unicode string returns the number of storage units,
not abstract characters.
2002-09-24 13:57:21 +00:00
Greg Ward 02669a35bc Tweak description of PortableUnixMailbox: "From " lines are actually
quoted (or mangled) *at* delivery-time, not "well before" it.  (At least
that's how Exim and qmail work.)
2002-09-23 19:32:42 +00:00
Thomas Heller c687401337 Fix typos: despatcher -> dispatcher. 2002-09-17 15:19:12 +00:00
Fred Drake c1ddc505d9 Minor revision to the "\\" patch, including updating the docs a little to
accomodate the fact that they are more general now that they are for the
os.path module and not just posixpath.

This and the previous patch should be combined and applied to the 2.2-maint
branch.
2002-09-12 18:01:26 +00:00
Skip Montanaro c12909bcc6 add note about os.path.join and drive letters on Windows. 2002-09-12 17:39:56 +00:00
Fred Drake b7c1895ec5 Fix typo reported by Paul Clifford.
Note that there is no str.joinfields(), use str.join() instead.
2002-09-12 14:16:07 +00:00
Fred Drake 73e8ebfc5a Revise text about the level of DOM support, and provide pointers to
the work of the XML-SIG in the main body of the text.

Modify the markup in a few places to avoid wrapping lines in bad
places, and just general cleanliness.
2002-09-11 22:03:47 +00:00
Martin v. Löwis 504bc4f3b7 Remove mentioning of Python 2.0 limitations. Fixes #607783. 2002-09-11 16:26:03 +00:00
Fred Drake 691fb55dd2 Clarify who maintains Tkinter and who maintains Tk. 2002-09-10 21:59:17 +00:00
Martin v. Löwis a32c994129 Always generate floats for stat_result; fix configure test. 2002-09-09 16:17:47 +00:00
Martin v. Löwis 94717ed1d4 Patch #606592: Subsecond timestamps in stat_result. 2002-09-09 14:24:16 +00:00
Raymond Hettinger 8a64d40949 Fix typo. Close SF Bug 606354. 2002-09-08 22:26:13 +00:00
Skip Montanaro 2c0d3224fc tightened up the definition of \b and \B some more based upon discussion
after the last checkin.
2002-09-07 18:48:14 +00:00
Walter Dörwald 5ccaf8f129 Apply diff3.txt (plus additional documentation)
from SF patch http://www.python.org/sf/554192

This adds two new functions to mimetypes:
guess_all_extensions() which returns a list of all known
extensions for a mime type, and add_type() which adds one
mapping between a mime type and an extension.
2002-09-06 16:15:58 +00:00
Skip Montanaro 2c519981fb update docs to reflect that \b considers underscore to be part of a word. 2002-09-06 14:38:23 +00:00
Raymond Hettinger d918884bb8 Fix typo 2002-09-04 23:52:42 +00:00
Raymond Hettinger a04c3d86ae Fix typo 2002-09-04 15:12:07 +00:00
Skip Montanaro 8e790e7007 expose PYTHON_API_VERSION macro as sys.api_version. Closes patch # 601456. 2002-09-03 13:25:17 +00:00
Walter Dörwald 3aeb632c31 PEP 293 implemention (from SF patch http://www.python.org/sf/432401) 2002-09-02 13:14:32 +00:00
Michael W. Hudson 53d58bb369 Further SET_LINENO reomval fixes. See comments in patch #587933.
Use a slightly different strategy to determine when not to call the line
trace function.  This removes the need for the RETURN_NONE opcode, so
that's gone again.  Update docs and comments to match.

Thanks to Neal and Armin!

Also add a test suite.  This should have come with the original patch...
2002-08-30 13:09:51 +00:00
Raymond Hettinger 9240be2a35 Note change in behavior from 1.5.2. The new argument to NameError is
an error message and not just the missing name.

Closes SF Bug 599869.
2002-08-27 23:53:23 +00:00
Fred Drake 80a04a4894 Add strong security warning about the rexec module.
Closes SF patch #600861.

Minor markup changes.
2002-08-27 16:46:06 +00:00
Tim Peters ea76c98014 Implemented <, <=, >, >= for sets, giving subset and proper-subset
meanings.  I did not add new, e.g., ispropersubset() methods; we're
going nuts on those, and, e.g., there was no "friendly name" for
== either.
2002-08-25 18:43:10 +00:00
Raymond Hettinger 7ad09552d0 Correct documentation of allow_reuse_address to match the actual script.
Closes SF bug 599681.
2002-08-25 16:27:33 +00:00
Raymond Hettinger e87ab3fefe Removed < <= > >= from the API. Implemented as comparisons of the
underlying dictionaries, there were no reasonable use cases (lexicographic
sorting of a list of sets is somewhat esoteric).  Frees the operators
for other uses (such as strict subset and superset comparisons).

Updated documentation and test suite accordingly.
2002-08-24 07:33:06 +00:00
Fred Drake 055be47b43 Fix typo reported to python-docs. 2002-08-23 21:19:53 +00:00
Raymond Hettinger fa8dd5f407 Fix markup and punctuation 2002-08-23 18:10:54 +00:00
Tim Peters b81b252fab s/_as_Temporarily_Immutable/_as_temporarily_immutable/g, because the
latter is what the code actually does.
2002-08-23 17:48:23 +00:00
Tim Peters 54fd3e6ffc pop(): An arbitrary element is removed, not a random element. 2002-08-23 17:45:43 +00:00
Fred Drake d10c6c949a Adjust the markup in a few places so this will actually format.
Remove the third column in the tables since it isn't used.
2002-08-23 17:22:36 +00:00
Raymond Hettinger 584cb198f7 Load docs for sets.py 2002-08-23 15:18:38 +00:00
Fred Drake 5ec486b87a Add a note that apply() is needed since the extended call syntax is
completely equivalent.
2002-08-22 14:27:35 +00:00
Fred Drake 61cf4407be Added a main() function and support to run this module as a script.
Closes SF feature request #588768.
2002-08-21 20:56:21 +00:00
Fred Drake 5b09eeea89 Clarify that even though some of the relevant specifications define the
order in which form variables should be encoded in a request, a CGI script
should not rely on that since a client may not conform to those specs, or
they may not be relevant to the request.
Closes SF bug #596866.
2002-08-21 19:24:21 +00:00
Fred Drake ffefb1df56 Clarify the endpos argument to the rx.match() method.
Closes SF bug #597177.
2002-08-20 13:57:47 +00:00
Neal Norwitz 11b795cd0f Add versionadded for operator.pow 2002-08-19 22:38:01 +00:00
Fred Drake 017778332f Extend some comments on the order of values in the returns from
dict.items/keys/values/iteritems/iterkeys/itervalues().
2002-08-19 21:58:58 +00:00
Guido van Rossum 45ec02aed1 SF patch 576101, by Oren Tirosh: alternative implementation of
interning.  I modified Oren's patch significantly, but the basic idea
and most of the implementation is unchanged.  Interned strings created
with PyString_InternInPlace() are now mortal, and you must keep a
reference to the resulting string around; use the new function
PyString_InternImmortal() to create immortal interned strings.
2002-08-19 21:43:18 +00:00
Raymond Hettinger 5959c559df Added __pow__(a,b) to the operator module. Completes the pattern of
all operators having a counterpart in the operator module.

Closes SF bug #577513.
2002-08-19 03:19:09 +00:00
Michael W. Hudson dd32a91cc0 This is my patch
[ 587993 ] SET_LINENO killer

Remove SET_LINENO.  Tracing is now supported by inspecting co_lnotab.

Many sundry changes to document and adapt to this change.
2002-08-15 14:59:02 +00:00
Barry Warsaw b8c20a723f More updates describing FutureWarnings. 2002-08-14 16:40:54 +00:00
Tim Peters 2f238c1b22 mkstemp's last argument changed from binary=True to text=False. 2002-08-14 16:37:10 +00:00
Guido van Rossum 830a5151c1 Doc portion of SF 589982 (tempfile.py rewrite, by Zack Weinberg).
Fred, please review!
2002-08-09 16:16:30 +00:00
Guido van Rossum b2865919cc Document that heappop() and heapreplace() raise IndexError if the heap
is empty.
2002-08-07 18:56:08 +00:00
Raymond Hettinger 22c001bd29 Described responsibilty of weakly referenced extension types to initialize
the weakreflist to NULL in the constructor and to fill the tp_flags
slot with Py_TPFLAGS_HAVE_WEAKREFS.  Closes SF bug 586583.
2002-08-07 16:18:54 +00:00
Raymond Hettinger 3cfdc3402e Documented os.fsync and os.fdatasync. Closes SF bug 584695. 2002-08-07 15:48:17 +00:00
Fred Drake 442c7c7743 Clarify that the bool instances are acceptable return values from
__nonzero__(), in response to SF bug #579991.
2002-08-07 15:40:15 +00:00
Fred Drake 95fa4ddf7b Change the markup a bit more; the parameter was not marked as \var in the
sample code, and the note was marked as a logical thing.
2002-08-07 12:39:33 +00:00
Steve Holden 63d5bead18 Fix markup errors. 2002-08-07 12:01:41 +00:00
Fred Drake 2d3c03df9a Added references to the email package.
Closes SF bug #586937.
2002-08-06 21:26:01 +00:00
Guido van Rossum 97c5fccd77 Remove mention of deprecated xreadlines method. 2002-08-06 17:03:25 +00:00
Guido van Rossum 0fc01865f3 Document file.next(). Mark xreadlines obsolete (both method and
module).  (One thing remains to be done: the gzip class has an
xreadline method; this ought to be replaced by an iterator as well.)
2002-08-06 17:01:28 +00:00
Barry Warsaw 817918cc3c Committing patch #591250 which provides "str1 in str2" when str1 is a
string of longer than 1 character.
2002-08-06 16:58:21 +00:00
Steve Holden 545092b063 Add comment about os.path.walk()'s behavior with symbolic links. 2002-08-06 16:07:07 +00:00
Neal Norwitz e72a9a13a1 SF patch #591305 Documentation err in bytecode defs 2002-08-05 23:33:54 +00:00
Raymond Hettinger acb45d72b4 Note that True and False are pickable objects 2002-08-05 03:55:36 +00:00
Steve Holden c8389c91c2 Remove a syntax error in the example, spotted by Walter Hofman. 2002-08-04 15:27:25 +00:00
Tim Peters 0ad679ff0f Document new heapreplace() function. 2002-08-03 18:53:28 +00:00
Tim Peters 6e0da82a97 Document new heapify() function. 2002-08-03 18:02:09 +00:00
Fred Drake 1acab695a7 Minor markup changes. 2002-08-02 19:46:42 +00:00
Guido van Rossum 975121664e Add docs for heapq.py. 2002-08-02 18:03:24 +00:00
Skip Montanaro de994d9130 indicate that 'b' is added to the mode flag if not given 2002-08-02 17:20:46 +00:00
Tim Peters 74824584ef Added new footnote about list.sort() stability. Repaired footnote about
using sort() with comparison functions (it made reference to the non-
existent "builtin-in function sort()").

BTW, I changed list.sort's docstring to contain the word "stable" -- the
easiest way to tell whether a particular Python version's sort *is* stable
is to look for "stable" in the docstring.  I'm not sure whether to
advertise this <wink>.
2002-08-01 03:10:45 +00:00
Fred Drake 5b11bdd0ed SF patch #581414: info reader bug
The "Matching vs. Searching" Info node is unreachable from the Info
program (but is fine in Emacs's Info mode). This patch seems to fix
it.  This is the only occurrence where the info reader fails, so
probably it could be addressed in the python docs as a workaround.
Forwarded the report to the info maintainer.
2002-07-30 17:51:20 +00:00
Martin v. Löwis 0cec0ffc78 Patch #573770: Implement lchown. 2002-07-28 16:33:45 +00:00
Fred Drake db40afaabe Small clarifications when referring to the sys.exc_* variables so that
readers are not given the wrong impression that they should be using those
on a regualar basis.
This closes SF bug #585598.
2002-07-25 21:11:23 +00:00
Jeremy Hylton 403e351dfc Flesh out description of getlogin() and recommend against using it. 2002-07-24 15:32:25 +00:00
Neal Norwitz 1cfcafceb6 add versionadded to doc 2002-07-20 00:46:12 +00:00
Guido van Rossum 18eb8b85b3 Doc patch from SF 474274 (pure Python strptime by Brett Cannon). 2002-07-19 17:09:36 +00:00
Fred Drake f0b095d804 Added documentation for the buffer_text and related attributes of the
xmlparser object provided by pyexpat, new in Python 2.3.
2002-07-17 20:31:52 +00:00
Fred Drake 2095b9690f reduce(): Clarified what is returned in the case of a sequence 1 item long and
initial/default value.
2002-07-17 13:55:33 +00:00
Guido van Rossum 9534e14033 Record the decision that StopIteration is a sink state (see recent
discussion in python-dev with subject "Termination of two-arg iter()").

Implementation will follow.
2002-07-16 19:53:39 +00:00
Guido van Rossum 54ed2d32f9 Clarify that the description of sys.path[0] is only valid upon program
start-up.
2002-07-15 16:08:10 +00:00
Fred Drake 3e59f72075 Clarify the return value of __nonzero__(): It *must* be an integer.
Closes SF bug #579991.
2002-07-12 17:15:10 +00:00
Fred Drake e4523c46b9 Document gc.get_objects().
Closes SF bug #578308.
2002-07-10 19:21:07 +00:00
Fred Drake 4254cbd29c Note that unicode() can raise LookupError for unknown codecs.
Closes SF bug #513666.
2002-07-09 05:25:46 +00:00
Fred Drake c6a525e993 Fix typo reported by Kent Engström, and a bunch of broken markup. 2002-07-08 14:42:22 +00:00
Fred Drake 50e1286c00 Fix typo: "an Unicode string" --> "a Unicode string"
Clarify the return value when the parameter is a Unicode object.
2002-07-08 14:29:05 +00:00
Steve Holden b1af86a1d7 Revise asyncore documentation and document asynchat for the first time. 2002-07-03 18:36:39 +00:00
Fred Drake 228f6e4e7a Fix up a few more consistency nits and incorrectly applied markup.
Further clarify the English-centricity of fix_sentence_endings.
2002-07-03 05:08:48 +00:00
Fred Drake c412617779 Add annotations that describe the change in the "errors" and "failures"
attributes of the TestResult.
2002-07-02 22:46:42 +00:00
Fred Drake 387c8b5f37 Update the documentation of the errors and failures attributes of the
TestResult object.  Add an example of how to get even more information for
apps that can use it.
Closes SF bug #558278.
2002-07-02 22:34:44 +00:00
Greg Ward 285f4a7db7 Don't list all the keyword args to the TextWrapper constructor in the
classdesc -- just use "..." with prose explaining the correspondence
between keyword args and instance attributes.

Document 'width' along with the other instance attributes.

Describe default values consistently.

Typo fixes.
2002-07-02 21:48:12 +00:00
Fred Drake 2c22e85ae7 Attempt to clarify removedirs().
Based on SF bug #574773.
2002-07-02 21:03:49 +00:00
Fred Drake ca23ee273e Deal with & remove the XXX comments.
Change the markup to be more like the rest of the documentation.
2002-07-02 20:37:12 +00:00
Martin v. Löwis 7d650ca83b Implement the encoding argument for toxml and toprettyxml.
Document toprettyxml.
2002-06-30 15:05:00 +00:00
Raymond Hettinger 550fd5d799 Fixed bug 574978 shutil example out of sync with source code 2002-06-30 04:43:20 +00:00
Raymond Hettinger 8a9e8b6d0e Fix bug 575221 referred to dictionary type instead of dict. 2002-06-30 04:32:38 +00:00
Fred Drake 78e057a32a Clarify the version information for the unicode() built-in.
Closes SF bug #575272.
2002-06-29 16:06:47 +00:00
Greg Ward ae64f3adcd Add documentation for new textwrap module. 2002-06-29 02:38:50 +00:00
Fred Drake 2c813818c8 Clean up some markup. 2002-06-27 18:30:34 +00:00
Neal Norwitz dcd0500664 dis.dis() also supports modules 2002-06-26 22:32:47 +00:00
Raymond Hettinger ca0383d3a3 Fix bug #573916. Sender and recipients reversed in email example. 2002-06-26 07:51:32 +00:00
Skip Montanaro 763805dab2 add seealso link to the bisect module 2002-06-26 05:22:08 +00:00
Skip Montanaro 09d9f86c77 add /F's PriorityQueue example 2002-06-26 05:07:28 +00:00
Fred Drake c5e2792ab4 Talk about interfaces rather than implementation classes where appropriate.
Add hyperlinks to make the documentation on the Attributes and AttributesNS
interfaces more discoverable.
Closes SF bug #484603.
2002-06-25 17:10:50 +00:00
Fred Drake b6aa9cbb96 Added some more links to the "See also" section. 2002-06-25 16:58:58 +00:00
Fred Drake 7bc121a4fb When talking about interfaces, use the interface names, not the names
of the implementation classes.  (Remove the "Impl" from two names.)
2002-06-25 16:25:01 +00:00
Raymond Hettinger f0236d7374 Fix typo 2002-06-25 15:26:59 +00:00
Raymond Hettinger 5ed3fa6578 Fix SF bug 568269 by enclosing 'computername' in a raw string 2002-06-25 04:53:05 +00:00
Neal Norwitz 563d12d145 SF # 572928 One word change for lib/libgettext.tex
Fix typo.
2002-06-24 02:22:39 +00:00
Fred Drake 53540ab071 Correct the RE equivalent of scanf()'s %x and %X patterns.
Closes SF bug #572169.
2002-06-22 01:07:37 +00:00
Fred Drake 473f46a853 Make the docs for string.capitalize() match those of str.capitalize()
(which makes it more clear).
Closes SF bug #571767.
2002-06-20 21:18:46 +00:00
Fred Drake 807354f3b6 Add a note that divmod() with complex numbers is deprecated. 2002-06-20 21:10:25 +00:00
Fred Drake dce695aa4e Added reference to the Expat home page. 2002-06-20 21:06:03 +00:00
Fred Drake f4bf7aa292 Typo: bites --> bytes
(Hanging around small kids too much...;)
2002-06-18 20:38:05 +00:00
Fred Drake 9ea01d415f Add description of the deadlock problem with child processes and pipes, and
hints about how to work around it.
Closes SF bug #530637.
2002-06-18 20:30:37 +00:00
Fred Drake 69d1fd2fdb Note the limitation that mime_decode_header() only works for Latin-1.
Closes SF bug #551912.
2002-06-18 18:51:30 +00:00
Fred Drake 7f59124693 Clarified documentation for os.access().
Patch contributed by Sean Reifschneider.
Closes SF patch #570618.
2002-06-18 16:15:51 +00:00
Fred Drake 28bdc624a8 Clarified description of error handling for shutil.rmtree().
This closes SF patch #569832.
2002-06-18 14:31:04 +00:00
Piers Lauder 3fca291a52 Add IMAP4 QUOTA extension methods 2002-06-17 07:07:20 +00:00
Steve Holden 1e4519faaa Make a start at describing the results of class/type unification
in the type documentation.
2002-06-14 09:16:40 +00:00
Fred Drake 6c123efe3d Refer the reader to the correct module for constant definitions.
This closes SF bug #550777.
2002-06-14 01:58:19 +00:00
Fred Drake 585775bf11 Document the Binary.data attribute.
This closes SF bug #562878.
2002-06-14 00:33:02 +00:00
Neal Norwitz 9c92b69a54 Use \code{True} (or False) instead of true/false.
Not sure if code is correct, but that is what's in this file.
I've seen \constant{True} in other places.
2002-06-14 00:27:13 +00:00
Neal Norwitz cc5c6947a6 Add "version added" for getpgid 2002-06-13 21:19:25 +00:00
Martin v. Löwis 606edc1d97 Patch #568235: Add posix.setpgid. 2002-06-13 21:09:11 +00:00
Guido van Rossum fea59e7f76 The opcode FOR_LOOP no longer exists. 2002-06-13 17:59:51 +00:00
Fred Drake efb9097add Do not claim that getlocale() returns a tulpe; that is not always true.
Closes SF bug #568577.
2002-06-13 17:54:06 +00:00
Guido van Rossum 11ba094957 Major overhaul of timeout sockets:
- setblocking(0) and settimeout(0) are now equivalent, and ditto for
  setblocking(1) and settimeout(None).

- Don't raise an exception from internal_select(); let the final call
  report the error (this means you will get an EAGAIN error instead of
  an ETIMEDOUT error -- I don't care).

- Move the select to inside the Py_{BEGIN,END}_ALLOW_THREADS brackets,
  so other theads can run (this was a bug in the original code).

- Redid the retry logic in connect() and connect_ex() to avoid masking
  errors.  This probably doesn't work for Windows yet; I'll fix that
  next.  It may also fail on other platforms, depending on what
  retrying a connect does; I need help with this.

- Get rid of the retry logic in accept().  I don't think it was needed
  at all.  But I may be wrong.
2002-06-13 15:07:44 +00:00
Fred Drake e9996c6093 Add version annotations for some older changes to the calendar module.
Closes SF patch #567867.
2002-06-13 01:34:50 +00:00
Guido van Rossum e3fdc975c0 SF bug 567826. Document new opcodes:
['BINARY_FLOOR_DIVIDE', 'BINARY_TRUE_DIVIDE',
'INPLACE_FLOOR_DIVIDE', 'INPLACE_TRUE_DIVIDE', 'GET_ITER',
'YIELD_VALUE', 'FOR_ITER', 'CONTINUE_LOOP']
2002-06-12 15:33:08 +00:00
Michael W. Hudson 5efaf7eac8 This is my nearly two year old patch
[ 400998 ] experimental support for extended slicing on lists

somewhat spruced up and better tested than it was when I wrote it.

Includes docs & tests.  The whatsnew section needs expanding, and arrays
should support extended slices -- later.
2002-06-11 10:55:12 +00:00
Guido van Rossum a861d552c3 Document that the key should not contain null bytes. 2002-06-10 19:42:43 +00:00
Guido van Rossum db9198a8b5 SF bug 563750 (Alex Martelli): posix_tmpfile():
The file returned by tmpfile() has mode w+b, so use that in the call
to PyFile_FromFile().

Bugfix candidate.
2002-06-10 19:23:22 +00:00
Guido van Rossum 715b861d94 Clarify the interaction between timeout/non-blocking mode, makefile
and fromfd.
2002-06-07 12:38:23 +00:00
Neal Norwitz 62a7f63a24 Fix typo 2002-06-07 12:36:44 +00:00
Guido van Rossum fc9823b1a9 Clarify the interaction between blocking and timeouts. Explain that
fromfd() assumes a blocking non-timeout socket.
2002-06-07 03:39:21 +00:00
Neal Norwitz bdbd84fdac Add version info, and fix another typo and wording spotted by /F. I think this is what he meant. :-) 2002-06-06 22:24:10 +00:00
Fred Drake 1a06fb0605 Fix typo spotted by Fredrik Lundh. 2002-06-06 22:19:20 +00:00
Fred Drake 6c6d662760 Fix some markup errors and adjust wording slightly. 2002-06-06 21:57:48 +00:00
Guido van Rossum be946bfea7 SF patch 555085 (timeout socket implementation) by Michael Gilfix.
I've made considerable changes to Michael's code, specifically to use
the select() system call directly and to store the timeout as a C
double instead of a Python object; internally, -1.0 (or anything
negative) represents the None from the API.

I'm not 100% sure that all corner cases are covered correctly, so
please keep an eye on this.  Next I'm going to try it Windows before
Tim complains.

No way is this a bugfix candidate. :-)
2002-06-06 21:51:01 +00:00
Martin v. Löwis 446a25fa3c Patch 473512: add GNU style scanning as gnu_getopt. 2002-06-06 10:58:36 +00:00
Walter Dörwald 474458da48 Add constants BOM_UTF8, BOM_UTF16, BOM_UTF16_LE, BOM_UTF16_BE,
BOM_UTF32, BOM_UTF32_LE and BOM_UTF32_BE that represent the Byte
Order Mark in UTF-8, UTF-16 and UTF-32 encodings for little and
big endian systems.

The old names BOM32_* and BOM64_* were off by a factor of 2.

This closes SF bug http://www.python.org/sf/555360
2002-06-04 15:16:29 +00:00
Guido van Rossum 59b2a74c75 SF bug 533625 (Armin Rigo). rexec: potential security hole
If a rexec instance allows writing in the current directory (a common
thing to do), there's a way to execute bogus bytecode.  Fix this by
not allowing imports from .pyc files (in a way that allows a site to
configure things so that .pyc files *are* allowed, if writing is not
allowed).

I'll apply this to 2.2 and 2.1 too.
2002-05-31 21:12:53 +00:00
Fred Drake 9b414ac93e Update links and information on PyQt/PyKDE. 2002-05-31 18:21:56 +00:00
Neal Norwitz d68f5171eb As discussed on python-dev, add a mechanism to indicate features
that are in the process of deprecation (PendingDeprecationWarning).
Docs could be improved.
2002-05-29 15:54:55 +00:00
Michael W. Hudson 34f20eac98 This is patch
[ 559250 ] more POSIX signal stuff

Adds support (and docs and tests and autoconfery) for posix signal
mask handling -- sigpending, sigprocmask and sigsuspend.
2002-05-27 15:08:24 +00:00
Fred Drake 92bf9dacc9 Markup adjustments; fix the names of modules referenced in an expression. 2002-05-23 21:07:19 +00:00
Raymond Hettinger c32f0336e0 Deprecated Random.cunifvariate clearing bug 506647. Also, added docstrings. 2002-05-23 19:44:49 +00:00
Fred Drake 7779b208ae Remove spurious "()" from the __str__() description. 2002-05-22 20:44:03 +00:00
Barry Warsaw 177b4a065f Jack's documentation for the U mode character on the file()
constructor, vetted by Barry.
2002-05-22 20:39:43 +00:00
Fred Drake c58507582b Added a version annotation for StringTypes.
Added documentation for BooleanType.
2002-05-22 02:44:24 +00:00
Barry Warsaw c421ad4a35 Minor typo: Message.getall() -> Message.get_all() 2002-05-22 01:22:46 +00:00
Raymond Hettinger 6cf09f0792 Patch 543387. Document deprecation of complex %, //,and divmod(). 2002-05-21 18:19:49 +00:00
Raymond Hettinger 97394bc795 Patch 533291. Deprecate None return form of __reduce__. 2002-05-21 17:22:02 +00:00
Fred Drake 5ecb7aaa6a Add availability information for a couple of the types, and notes on writing
string-type tests for versions of Python built without Unicode support.
2002-05-21 14:28:22 +00:00
Raymond Hettinger cadc9fbd37 Patch 547037. Corrected documentation to match
actual module behavior for adding newlines.
2002-05-16 04:28:44 +00:00
Raymond Hettinger b07fa39edf Added missing index entries for mapping methods. Closes patch #548693. 2002-05-15 15:45:25 +00:00
Raymond Hettinger 576474c5ae Closes SF bug 527139. Brings docs inline with random.py 1.29
which fixes the unnecessarily restricted method domain.
2002-05-13 23:49:13 +00:00
Raymond Hettinger 5359ad63ce Correct gammavariate's method name and domain.
Partial solution to SF bug 527139.
2002-05-13 22:40:38 +00:00
Raymond Hettinger c045b49633 Added degrees() and radians() to mathmodule. Closing patch 552452 and
feature request 426539.
2002-05-13 03:52:47 +00:00
Fred Drake 1f89e2abcc Fix markup error that suppressed space.
Closes SF bug #554257.  Not relevant to older releases.
2002-05-10 12:37:56 +00:00
Fred Drake d05c74f42d Add a note explaining the interaction between unbuffered input and
xreadlines.xreadlines().
This closes SF patch #552804.
2002-05-06 16:02:42 +00:00
Fred Drake b9032018ff Update the xrange object description to reflect the removal of deprecated
features.
2002-05-02 21:37:23 +00:00
Fred Drake 4d707a5d08 Remove extra period produced by previous change. 2002-05-02 17:54:18 +00:00
Fred Drake 4b270518b7 Correct information on support for repietition & concatenation for buffer
and xrange objects.
This closes SF bug #550555.
2002-05-02 05:56:04 +00:00
Fred Drake 7f781c9aab Add Pickler.clear_memo() so the pickle and cPickle modules are more similar. 2002-05-01 20:33:53 +00:00
Fred Drake a65375c3e3 Explain what os.read() returns at end of file.
This closes SF bug #550409.  Applying to release21-maint & release22-maint.
2002-05-01 03:31:42 +00:00
Fred Drake 7938fab285 Add missing right-parenthesis. 2002-05-01 03:23:03 +00:00
Fred Drake 52cc670711 Add a note about when the "%r" formatting code was added. 2002-04-30 14:54:47 +00:00
Tim Peters 81b9251d59 Mostly in SequenceMatcher.{__chain_b, find_longest_match}:
This now does a dynamic analysis of which elements are so frequently
repeated as to constitute noise.  The primary benefit is an enormous
speedup in find_longest_match, as the innermost loop can have factors
of 100s less potential matches to worry about, in cases where the
sequences have many duplicate elements.  In effect, this zooms in on
sequences of non-ubiquitous elements now.

While I like what I've seen of the effects so far, I still consider
this experimental.  Please give it a try!
2002-04-29 01:37:32 +00:00
Fred Drake d3e6678713 Slightly expand and clarify the differences between getegid(), getgid(),
getpgrp(), and setpgid().
This closes SF bug #547939.
2002-04-26 20:59:40 +00:00
Fred Drake a7bb2b9b30 Be more consistent, both internally and with recommended practice.
This closes SF bug #547953.
2002-04-26 20:44:14 +00:00
Fred Drake 38f71973e5 Documentation for the enumerate() function/type.
This closes SF patch #547162.
2002-04-26 20:29:44 +00:00
Fred Drake 99d17006c1 Add text about circular references caused by storing frames in local
variables.  This closes SF bug #543148.
2002-04-23 21:21:20 +00:00
Fred Drake 106c1a0e7a WCOREDUMP(), WIFCONTINUED(), WCONTINUED, WUNTRACED: New.
isatty(), WIFEXITED(), WIFSIGNALED(), WIFSTOPPED(): Changed to return
    bools instead of ints.
2002-04-23 15:58:02 +00:00
Anthony Baxter 8388895fe4 SF patch [ 545523 ] patch for 514433 bsddb.dbopen (NULL)
closes SF #514433

can now pass 'None' as the filename for the bsddb.*open functions,
and you'll get an in-memory temporary store.

docs are ripped out of the bsddb dbopen man page. Fred may want to
clean them up.

Considering this for 2.2, but not 2.1.
2002-04-23 02:11:05 +00:00
Walter Dörwald de02bcb265 Apply patch diff.txt from SF feature request
http://www.python.org/sf/444708

This adds the optional argument for str.strip
to unicode.strip too and makes it possible
to call str.strip with a unicode argument
and unicode.strip with a str argument.
2002-04-22 17:42:37 +00:00
Skip Montanaro b02ea65f92 typo 2002-04-17 19:33:06 +00:00
Fred Drake 933f159a2f Add a version annotation for the help() function. 2002-04-17 12:54:04 +00:00
Skip Montanaro 6c7bc31089 added small clarification to the descriptions of encode() and decode() 2002-04-16 15:12:10 +00:00
Fred Drake e19a5bcc7b Be consistent in presenting the signatures. 2002-04-15 19:46:40 +00:00
Fred Drake 154985587b Add docs for os.fchdir(). 2002-04-15 19:41:27 +00:00
Walter Dörwald 068325ef92 Apply the second version of SF patch http://www.python.org/sf/536241
Add a method zfill to str, unicode and UserString and change
Lib/string.py accordingly.

This activates the zfill version in unicodeobject.c that was
commented out and implements the same in stringobject.c. It also
adds the test for unicode support in Lib/string.py back in and
uses repr() instead() of str() (as it was before Lib/string.py 1.62)
2002-04-15 13:36:47 +00:00
Martin v. Löwis 06a83e90aa Patch #543447: Add posix.mknod. 2002-04-14 10:19:44 +00:00
Fred Drake 8b1c47bb8b Document the optional argument to the .strip(), .rstrip(), .strip() string
methods.
Part of SF feature #444708.
2002-04-13 02:43:39 +00:00
Fred Drake d4c0e5fd5b BDFL agreed with Tim: rehabilitate randint(). 2002-04-12 20:01:47 +00:00
Guido van Rossum e027d9818f Add Raymond Hettinger's d.pop(). See SF patch 539949. 2002-04-12 15:11:59 +00:00
Martin v. Löwis 81bdc93d2f Explain octal escapes. Fixes #542226. 2002-04-11 12:24:12 +00:00
Andrew M. Kuchling 2854c478be Remove mention of 'pre' module
(2.2 bugfix candidate?)
2002-04-10 21:28:31 +00:00
Skip Montanaro 3b2625ff82 document all the valid encoding values 2002-04-10 04:37:09 +00:00
Neal Norwitz 6b35370c65 Update docs for bool changes by Guido around April 6 2002-04-09 18:15:00 +00:00
Martin v. Löwis 688357e035 Patch #512005: getrusage() returns struct-like object. 2002-04-08 21:28:20 +00:00
Fred Drake bc82ab1c9f Do not call "knee" a standard module, and point to the new location.
This addresses the issue in SF bug #515745.
2002-04-08 05:22:30 +00:00
Neal Norwitz d3dab2b192 Update doc to reflect Tim's changes to bool. 2002-04-05 02:21:09 +00:00
Fred Drake a2c2595024 Add a version annotation regarding the urlopen(proxies={...}). 2002-04-04 20:58:02 +00:00
Fred Drake 5ca3a08cc0 The rest of the documentation for manual proxy configuration for a basic
urlopen().
This is part of SF patch #523415.
2002-04-04 20:34:36 +00:00
Fred Drake d21670328c Documentation for manual proxy configuration, by Andy Gimblett.
This closes SF patch #523415.
2002-04-04 20:09:50 +00:00
Neal Norwitz ce5df49957 SF 539024, Fix broken link to numpy 2002-04-04 14:02:45 +00:00
Guido van Rossum 77f6a65eb0 Add the 'bool' type and its values 'False' and 'True', as described in
PEP 285.  Everything described in the PEP is here, and there is even
some documentation.  I had to fix 12 unit tests; all but one of these
were printing Boolean outcomes that changed from 0/1 to False/True.
(The exception is test_unicode.py, which did a type(x) == type(y)
style comparison.  I could've fixed that with a single line using
issubtype(x, type(y)), but instead chose to be explicit about those
places where a bool is expected.

Still to do: perhaps more documentation; change standard library
modules to return False/True from predicates.
2002-04-03 22:41:51 +00:00
Fred Drake aee113d368 Add an experimental mechanism to support extending the pprint formatting.
Partly responds to SF bug #505152.
2002-04-02 05:08:35 +00:00
Fred Drake 4dfb7a81c1 Explain that os.spawn*() return the process handle on Windows.
Clarify that os.waitpid() on Windows takes a process handle, not a process ID.
This closes SF bug #537582.
2002-04-01 23:30:47 +00:00
Fred Drake d5a072f2eb Fix up the documentation of the type codes to give both the C and Python
types for each code, and give the actual C types.

Clarified the support for slice operations and note when some TypeError
exceptions are raised.

This closes SF bugs 518767 and 536469.
2002-04-01 23:05:10 +00:00
Fred Drake 8d62e94761 Minor wording change. 2002-03-28 21:06:17 +00:00
Skip Montanaro bb6bbc45c0 add exception class hierarchy. This should probably be done differently,
but at least the content is there.
2002-03-28 20:53:22 +00:00
Fred Drake 47cdf6fb6f Add documentation on the hasfree data object. 2002-03-28 19:34:53 +00:00
Fred Drake e3a3ceb2b1 Minor consistency adjustments. 2002-03-28 12:40:45 +00:00
Martin v. Löwis 2e64c34850 Expose C library's gettext. Fixes #516412. 2002-03-27 18:49:02 +00:00
Skip Montanaro 8a79727b53 add seealso referring to site module doc where people can learn how to
extend sys.path using .pth files.
2002-03-27 17:29:50 +00:00
Fred Drake 57f8e06e4f Document the finditer() function and method.
This closes SF bug #520904.

Explain that many of the escapes supported by string literals are also
supported by the RE compiler, and list which ones.
This closes SF bug #529923.
2002-03-25 20:22:59 +00:00
Fred Drake 3787c9d94c Added description of binhex.Error. 2002-03-25 16:37:56 +00:00
Skip Montanaro 1e962cb61b document InvalidURL exception 2002-03-24 16:55:57 +00:00
Neil Schemenauer ccbb0edf0e Add local_hostname to SMTP.__init__(). 2002-03-24 15:41:40 +00:00
Neil Schemenauer 79f181395b Add more example exceptions that unpickling can raise. 2002-03-22 22:16:03 +00:00
Neal Norwitz e22d3dfcc1 Fix grammar 2002-03-21 12:58:54 +00:00
Walter Dörwald b25c2b0a4a [Apply SF patch #504943]
This patch makes it possible to pass Warning instances as the first
argument to warnings.warn. In this case the category argument
will be ignored. The message text used will be str(warninginstance).
2002-03-21 10:38:40 +00:00
Neal Norwitz 1abca4a515 SF# 522426, add doc for common parameter for filecmp.cmpfiles() 2002-03-20 18:55:09 +00:00
Fred Drake 1268678395 Adjust some poor wording in the text that explains what events are used
for (reported by Keith Briggs).
Wrap some very long lines.
2002-03-19 14:37:44 +00:00
Fred Drake 2f31d561d5 Clarify that copy_reg.pickle() is not intended for use with "classic" classes.
This was stated before, but a minor grammatical error made it difficult to be
sure of the meaning.
This closes SF bug #530143.
2002-03-19 03:33:33 +00:00
Fred Drake a8b663806b Remove extra verb; reported by Detlef Lannert. 2002-03-18 16:45:01 +00:00
Martin v. Löwis 5c137c2251 Patch #495598: add an -q (quiet) option to pycompile. 2002-03-18 12:44:08 +00:00
Skip Montanaro 10acc8f9e2 added note that xmlrpclib won't marshal instances of subclasses of the
builtin types
2002-03-17 23:15:02 +00:00
Martin v. Löwis 587c98c863 Patch #430706: Persistent connections in BaseHTTPServer. 2002-03-17 18:37:22 +00:00
Fred Drake 8e0c82a35f Fix stupid typo in example. 2002-03-16 14:01:12 +00:00
Fred Drake f275803fe9 Clarify the descriptions of the positive and negative lookbehind assertions.
Added examples of positive lookbehind assertions.
This closes SF bug #529708.
2002-03-16 05:58:12 +00:00
Skip Montanaro dc8d40717c update text to refer to ServerProxy class in preference to Server, which is
only retained for backward compatibility with older versions of the library.
2002-03-14 17:35:25 +00:00
Fred Drake f981617645 "level" keyword argument in example should be "stacklevel".
This closes SF bug #517684.
2002-03-12 19:49:31 +00:00
Tim Peters 8f01b680c8 Change Windows file.truncate() to (a) restore the original file position,
and (b) stop trying to prevent file growth.

Beef up the file.truncate() docs.

Change test_largefile.py to stop assuming that f.truncate() moves the
file pointer to the truncation point, and to verify instead that it leaves
the file position alone.  Remove the test for what happens when a
specified size exceeds the original file size (it's ill-defined, according
to the Single Unix Spec).
2002-03-12 03:04:44 +00:00
Tim Peters fb05db2cae file_truncate(): provide full "large file" support on Windows, by
dropping MS's inadequate _chsize() function.  This was inspired by
SF patch 498109 ("fileobject truncate support for win32"), which I
rejected.

libstdtypes.tex:  Someone who knows should update the availability
blurb.  For example, if it's available on Linux, it would be good to
say so.

test_largefile:  Uncommented the file.truncate() tests, and reworked to
do more.  The old comment about "permission errors" in the truncation
tests under Windows was almost certainly due to that the file wasn't open
for *write* access at this point, so of course MS wouldn't let you
truncate it.  I'd be appalled if a Unixish system did.

CAUTION:  Someone should run this test on Linux (etc) too.  The
truncation part was commented out before.  Note that test_largefile isn't
run by default.
2002-03-11 00:24:00 +00:00
Andrew M. Kuchling 10b3eac278 [Bug #486527] Note that the caller has to ensure there are no control
characters in strings being passed via XML-RPC.
Fix some typos.

2.2.1 bugfix candidate.
2002-03-08 17:46:02 +00:00
Piers Lauder a4f8313cbb add SSL class submitted by Tino Lange 2002-03-08 01:53:24 +00:00
Fred Drake da8a6dd072 Added missing version annotation for dict(). 2002-03-06 02:29:30 +00:00
Fred Drake 9479c958c5 Remove extra indenatation from sample interpreter session.
Remove whitespace from the middle of an inline RE example; it was OK for
the typeset formats, but LaTeX2HTML is more touchy about this.
2002-03-05 04:02:39 +00:00
Skip Montanaro a8e1d81bdc add simple example of avoiding backtracking 2002-03-04 23:08:28 +00:00
Martin v. Löwis 29001ff234 Patch #523268, #522027: return enhanced tuples. 2002-03-01 10:47:37 +00:00
Martin v. Löwis dbd55b3737 Patch #523268, #522027: return enhanced tuples. 2002-03-01 10:38:44 +00:00
Martin v. Löwis 9986633609 Patch 520694: arraymodule.c improvements:
- make array.array a type
- add Py_UNICODE arrays
- support +=, *=
2002-03-01 10:27:01 +00:00
Fred Drake b6b2aa6c75 Fix error in explanation of the interaction between $ and MULTILINE mode.
Reported by Steve Alexander.
2002-02-25 18:56:45 +00:00
Tim Peters 9f4341b3b0 SF bug #501591: dir() doc is old
Bugfix candidate.

+ Updated dir() description to match actual 2.2 behavior.

+ Replaced the dir(sys) example with dir(struct), because the former
  was way out of date and is bound to change frequently, while the
  latter is stable.

+ Added a note cautioning that dir() is supplied primarily for
  convenience at an interactive prompt (hoping to discourage its
  use as the foundation of introspective code outside the core).
2002-02-23 04:40:15 +00:00
Greg Ward f8b1f2431b Grammar tweak. 2002-02-22 21:24:32 +00:00
Neal Norwitz ba902fda3c SF #515041, Update path for 2.3 2002-02-19 02:58:54 +00:00
Fred Drake e73ad2a21f Use the standard expression for the availability statement for alarm(). 2002-02-15 20:59:43 +00:00
Skip Montanaro 8d1fdafd89 note that the alarm function is not available on Windows. 2002-02-15 20:36:19 +00:00
Fred Drake 928051fb26 The "%" character does not need to be escaped in verbatim environments.
This closes SF bug #517811.
2002-02-15 04:12:59 +00:00
Fred Drake 7bc6f7ac7b Consistently use \textasciicircum to produce a ^ character.
LaTeX really falls flat on this one!
2002-02-14 15:19:30 +00:00
Tim Peters ab034fab03 Implement os.waitpid() for Windows, in a way that's compatible with Linux
where their capabilities intersect.  Would be nice if people using non-
MSVC compilers (Borland etc) took a whack at doing something similar for
them (this code relies on the MS _cwait function).
2002-02-01 11:27:43 +00:00
Skip Montanaro c318260a71 added handle_error method description 2002-01-31 17:32:24 +00:00
Tim Peters c48a3ca161 Add new constants usable with os.popen() on Windows.
NOTE:  this seems a mess wrt which symbols are available on which
platforms.  I can't fix it, but I didn't add to it <wink>, and
included an XXX comment about names claimed to be available on
Windows that aren't.  If anyone can figure out the whole ugly truth,
I'm sure a better organization will suggest itself.
2002-01-30 05:49:46 +00:00
Martin v. Löwis ef180dc3d0 Document that get_referrers can return unreachable but uncollected objects.
Fixes #505453.
2002-01-26 20:11:50 +00:00
Fred Drake 744f67fb62 Add keyword.kwlist to the public API. 2002-01-24 16:38:53 +00:00
Guido van Rossum 4f3a62d9bc There's no need for typechecks on the second and third argument of
new.instancemethod() -- the instancemethod object is now a perfectly
general container.

This fixes SF bug ##503091 (Pedro Rodriquez): new.instancemethod fails
for new classes

This is a 2.2.1 candidate.
2002-01-15 19:21:05 +00:00
Thomas Heller 3d62f8ca35 Fix a simple typo. Has this to be fixed also in other branches? 2002-01-14 08:37:39 +00:00
Martin v. Löwis a55ffaeee9 Add a per-message fallback mechanism for translations. 2002-01-11 06:58:49 +00:00
Martin v. Löwis 1be6419871 Add fallback argument to translation(). Request fallbacks on install.
Fixes #500595.
2002-01-11 06:33:28 +00:00
Fred Drake 7731ed47cb Do not mask the name of a built-in function in example code.
Based on comment sent to python-docs.
2002-01-05 04:00:03 +00:00
Fred Drake 5e74d36f9d Fix indentation error in example from the Tkinter Life Preserver.
This closes SF bug #499505.
2002-01-05 03:56:54 +00:00
Fred Drake d93d68bd13 Fix minor typo reported in SF patch #497951. 2002-01-05 01:52:41 +00:00
Guido van Rossum c33e077838 SF patch #497420 (Eduardo Pérez): ftplib: ftp anonymous password
Instead of sending the real user and host, use "anonymous@" (i.e. no
host name at all!) as the default anonymous FTP password.  This avoids
privacy violations.
2001-12-28 20:54:28 +00:00
Fred Drake 7c9a53dfc0 Elaborate the descriptions for onecmd(), precmd(), and postcmd() so they are
useful.
2001-12-27 05:10:18 +00:00
Fred Drake fd7f115a0e Fix wrongly-named formal parameters in three places: begin_y was used twice
instead of begin_y and begin_x for derwin(), subpad(), and subwin().
Reported for derwin() by Eric Huss.

Added class annotations for the window methods so they would be properly
described in the index.
2001-12-26 22:08:44 +00:00
Fred Drake ab2dc1d730 Added index entries similar to some recommended by Skip, and used the word
"interpolation" in the text, to make the string formatting material easier to
find.
This closes SF bug #487165.
Bugfix: this should be applied for Python 2.2.1.
2001-12-26 20:06:40 +00:00
Fred Drake ef338ec5f9 More index entries. 2001-12-26 19:48:43 +00:00
Fred Drake 39960f6ec9 Fix the erroneous availability annotation for s.makefile() from the last
checkin (my fault!).
Wrap some long lines and fix some markup inconsistencies.
2001-12-22 19:07:58 +00:00
Fred Drake 87fa3aa12c Add notes that fromfd() and s.makefile() are Unix-specific.
This fixes SF bug #495896.

Fix up various markup consistency & style guide conformance nits.
2001-12-21 17:45:03 +00:00
Fred Drake 5c7983113c Add a reference to the signal module to the os.kill() description.
This closes SF bug #495609.
2001-12-21 03:58:47 +00:00
Fred Drake dce2e1161a Fix typo in httplib example.
This fixes SF bug #495221.
2001-12-21 03:52:04 +00:00
Fred Drake 8c8e871530 Fix the availability statement for the spawn*() functions to reflect the
actual availability on Windows.
This fixes SF bug #495191.
2001-12-20 17:24:11 +00:00
Fred Drake 34a37b807a Re-commit Ping's patch to the cgi and cgitb documentation, using the
right version this time.  Thanks, Ping!
(This was from SF patch #494582, "\index -> \indexii" version.)
2001-12-20 17:13:09 +00:00
Fred Drake 4b1b3bfac1 Add entry for the pydoc documentation. 2001-12-18 16:32:30 +00:00
Fred Drake 96be564027 Add documentation for the pydoc module; contributed by Ka-Ping Yee.
This closes SF patch #494622.
2001-12-18 16:31:44 +00:00
Fred Drake 732299ff63 Add documentation for the help() built-in; contributed by Ka-Ping Yee.
This is part of SF patch #494622.
2001-12-18 16:31:08 +00:00
Fred Drake e088970ce0 Merge in Ping's changes to the cgitb documentation, and add a version
annotation as well.
This closes SF patch #494582.
2001-12-18 15:51:55 +00:00
Fred Drake 0c0b5305ae Mark the mpz module deprecated as of Python 2.2. 2001-12-16 01:54:55 +00:00
Fred Drake c57772870b Add a link to the mxNumber package. 2001-12-15 20:37:40 +00:00
Fred Drake b40501b05e Add link to the gmpy project. 2001-12-15 18:37:24 +00:00
Fred Drake dda7dcb3f7 Add a missing "cycle". 2001-12-14 21:19:08 +00:00
Fred Drake 526c7a0101 Ensure that complex() only accepts a string argument as the first arg,
and only if there is no second arg.
This closes SF patch #479551.
2001-12-13 19:52:22 +00:00
Fred Drake a0b767625b Minor adjustments. 2001-12-13 04:25:37 +00:00
Fred Drake 1529ef860e Document that isleap() returns exactly 1 or 0, which is guaranteed by the
docstring.
This closes SF bug #485794.


Additional (very) small details were added.
2001-12-12 05:40:46 +00:00
Fred Drake cf72abab8c Update link to the SAX homepage. 2001-12-10 18:10:37 +00:00
Fred Drake 6048ce95a9 Added documentation for str.decode().
This closes SF bug #490823.
2001-12-10 16:43:08 +00:00
Guido van Rossum 146483964e Patch supplied by Burton Radons for his own SF bug #487390: Modifying
type.__module__ behavior.

This adds the module name and a dot in front of the type name in every
type object initializer, except for built-in types (and those that
already had this).  Note that it touches lots of Mac modules -- I have
no way to test these but the changes look right.  Apologies if they're
not.  This also touches the weakref docs, which contains a sample type
object initializer.  It also touches the mmap test output, because the
mmap type's repr is included in that output.  It touches object.h to
put the correct description in a comment.
2001-12-08 18:02:58 +00:00
Fred Drake f9d580346b Add change notes where im_class is discussed, since the exact meaning changes
with Python 2.2.
2001-12-07 23:13:53 +00:00
Guido van Rossum b62f0e1a7b Correct the description of im_class. (Fred, this is changed in 2.2.
Should this be labeled as changed?  How?)
2001-12-07 22:03:18 +00:00
Fred Drake 7961930595 Revise description of dumbdbm.open() to reflect that the flag argument is
ignored and that mode was ignored before Python 2.2.
This closes SF bug #490098.
2001-12-07 21:56:13 +00:00
Fred Drake 8b7bb7a0f2 Describe the behavior of the read() method when the list of filenames
includes files that do not exist, explain the intended use of the interface,
and show how to ensure an expected file really exists.
This closes SF bug #490399.
2001-12-07 21:35:57 +00:00
Tim Peters b404145936 s/it/if/ in descriptions of spawn mode argument. 2001-12-06 23:37:17 +00:00
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