Commit Graph

3769 Commits

Author SHA1 Message Date
Raymond Hettinger 984f9bb714 operator.itemgetter() and operator.attrgetter() now support extraction
of multiple fields.  This provides direct support for sorting by
multiple keys.
2005-03-09 16:38:48 +00:00
Skip Montanaro 1c7ddb625e hmmm... moving def'n of version makes the __init__ unnecessary for the
example
2005-03-09 03:01:31 +00:00
Skip Montanaro 8e97fbf360 Correct description/example of how to override User-agent. 2005-03-09 02:57:26 +00:00
Raymond Hettinger 3e1dd3be49 Make functional.partial() more closely match the spec by emulating some useful features of regular functions:
* Made weak referencable.
* Allow attribute access so a user can set __name__, __doc__, etc.
2005-03-08 07:15:36 +00:00
Greg Ward 50682d0f78 SF #818006: merge from release24-maint branch: add useful read-only
attributes to oss_audio_device object: 'closed', 'name', and 'mode'.
2005-03-07 01:41:11 +00:00
Martin v. Löwis 78be7df9e4 Patch #918101: Add tarfile open mode r|* for auto-detection of the
stream compression; add, for symmetry reasons, r:* as a synonym of r.
2005-03-05 12:47:42 +00:00
Martin v. Löwis 00a73e7715 Patch #1043890: tarfile: add extractall() method. 2005-03-04 19:40:34 +00:00
Fred Drake b098fd7f89 minor edits:
- function names marked with \function should include parentheses
- "standard error" instead of "stderr" for text
- a boolean parameter takes true or false values, not just True or False
2005-03-03 17:25:04 +00:00
Martin v. Löwis 7fe60c0a0a Patches #749830, #1144555: allow UNIX mmap size to default to current
file size.
2005-03-03 11:22:44 +00:00
Martin v. Löwis 9b62b39070 Document quiet parameter to decode. Fixes #803413. 2005-03-03 10:06:05 +00:00
Raymond Hettinger 6a458e9bc9 Noted that the module is new in version 2.5. 2005-03-02 15:10:38 +00:00
Skip Montanaro c8c45c25ac Improve (?) description of system dependence of access to the pw_passwd
field on systems that support shadow passwords.
2005-03-02 04:29:23 +00:00
Raymond Hettinger 9c323f8de4 SF patch #941881: PEP 309 Implementation (Partial Function Application).
Combined efforts of many including Peter Harris, Hye-Shik Chang,
Martin v. Löwis, Nick Coghlan, Paul Moore, and Raymond Hettinger.
2005-02-28 19:39:44 +00:00
Raymond Hettinger bc2c21ea52 Update an example to match current output. 2005-02-23 20:40:42 +00:00
Raymond Hettinger 2b0d058cd5 Document missing opcodes. 2005-02-21 20:28:07 +00:00
Raymond Hettinger 467024ccfc Fix some wording and grammar nits. 2005-02-21 15:46:52 +00:00
Vinay Sajip 84df97fdd6 Fixed documentation for SMTPHandler 2005-02-18 11:50:11 +00:00
Brett Cannon 7706c2da14 Update references specifying "Macintosh" to mean OS X semantics and not Mac OS
9.

Applies patch #1095802.  Thanks Jack Jansen.
2005-02-13 22:50:04 +00:00
Raymond Hettinger 4e9907c914 SF bug #1119700: list extend() accepts args besides lists 2005-02-09 23:19:25 +00:00
Guido van Rossum d064142579 Security fix PSF-2005-001 for SimpleXMLRPCServer.py. 2005-02-03 15:01:24 +00:00
Johannes Gijsbers b5646aa3fb Bug #1108490: fix broken link. 2005-01-29 19:49:34 +00:00
Raymond Hettinger bc029af436 SF bug #1108303: fix .split() maxsplit doc
Docs incorrectly stated that maxsplit=0 would cause unlimited splitting.
2005-01-26 22:40:08 +00:00
Raymond Hettinger 770184b365 SF bug #1105286: Undocumented implicit strip() in split(None) string method
Clarify the behavior when a string begins or ends with whitespace.
2005-01-25 10:21:19 +00:00
Martin v. Löwis c300175547 Patch #579435: Shadow Password Support Module 2005-01-23 09:27:24 +00:00
Martin v. Löwis 4d394dfebb Truncate st_?time before comparing it with ST_?TIME in the tests. 2005-01-23 09:19:22 +00:00
Fred Drake 447083e4d0 fix typeset of vertical bar for PDF format
(closes SF bug #1008998)
2005-01-19 07:24:34 +00:00
Fred Drake ffcbab073e documentation for the zipimport module using contributed patch
(closes SF bug #853800; markup adjusted)
2005-01-19 05:42:50 +00:00
Fred Drake 5e37d79567 Description of args to IMAP4.store() in imaplib
(closes SF patch #1084092; modified per comments in SF)
2005-01-19 04:44:07 +00:00
Fred Drake b184ae860e fix a bunch of spelling errors
(closes SF patch #1104868)
2005-01-19 03:39:17 +00:00
Fred Drake 9f79dbfd4a remove spurious line from widget variables example
(closes SF patch #1094815)
2005-01-19 03:23:57 +00:00
Skip Montanaro 058858151d Document the reconvert module. 2005-01-16 20:48:27 +00:00
Martin v. Löwis fe33d0ba87 Default stat_float_times to true. 2005-01-16 08:57:39 +00:00
Martin v. Löwis 22b457e03b Added SEEK_* constants. Fixes #711830. 2005-01-16 08:40:58 +00:00
Tim Peters 9ba3684ecc Gave the new datetime.strptime() a versionadded blurb. 2005-01-13 21:06:25 +00:00
Skip Montanaro 0af3ade6aa Add strptime() constructor to datetime class. Thanks to Josh Spoerri for
the changes.
2005-01-13 04:12:31 +00:00
Andrew McNamara 8231de0513 Many updates to csv module doco. 2005-01-12 11:47:57 +00:00
Johannes Gijsbers 97613ad02d Patch #1051321 (fixes bugs 1010196, 1013525), by Mike Brown:
* Document hasFeature(), createDocument(), CreateDocumentType(),
  hasAttribute(), hasAttributeNS().

* In the documentation for createDocument(), it is now stated that the Python
  DOM API allows implementations to forego creation of the document element
  child node, if no namespace and local name arguments are given. (This
  possibility is left open and unaddressed in the W3C spec).

* Addition by me: use 'name' rather than 'attname', for consistency with the
  DOM specification and the Python DOM API implementation.
2005-01-09 00:36:53 +00:00
Johannes Gijsbers 836f5433f7 Patch #943206:
`glob.glob()` currently calls itself recursively to build a list of matches of
the dirname part of the pattern and then filters by the basename part. This is
effectively BFS. ``glob.glob('*/*/*/*/*/foo')`` will build a huge list of all
directories 5 levels deep even if only a handful of them contain a ``foo``
entry. A generator-based recusion would never have to store these list at once
by implementing DFS. This patch converts the `glob` function to an `iglob`
recursive generator . `glob()` now just returns ``list(iglob(pattern))``.

I also cleaned up the code a bit (reduced duplicate `has_magic()` checks and
created a second `glob0` helper func so that the main loop need not be
duplicated).

Thanks to Cherniavsky Beni for the patch!
2005-01-08 13:13:19 +00:00
Johannes Gijsbers e4172eadf3 Patch #1094015:
* Use os.makedirs() instead os.mkdir(). (bug #975763)
* Use copystat() to copy directory bits (bug #1048878)
2005-01-08 12:31:29 +00:00
Raymond Hettinger 97db05de3e SF #75103: imghdr -- identify JPEGs in EXIF format 2005-01-07 08:15:41 +00:00
Raymond Hettinger 72b83c86a9 SF patch 1094011: Docs for file() vs open(). 2005-01-07 04:33:44 +00:00
Facundo Batista bccc9a956a Added example to os.stat() 2005-01-07 02:50:22 +00:00
Raymond Hettinger 17a7924667 SF bug #1091740: garbage collector still documented as optional 2005-01-07 00:49:17 +00:00
Skip Montanaro becbdec1d9 add two missing items 2005-01-05 07:19:11 +00:00
Skip Montanaro b80bad4366 add descriptions of exported data attributes 2005-01-05 07:13:32 +00:00
Skip Montanaro 4f49e7d0e7 describe reset() 2005-01-05 07:03:53 +00:00
Skip Montanaro bb0c9dc852 add a couple missing items 2005-01-05 06:58:15 +00:00
Raymond Hettinger 31043cd6d8 Clarify that DictMixin is still useful. Only the UserDict class was supplanted. 2005-01-04 21:25:00 +00:00
Peter Astrand 454f76711c New subprocess utility function: check_call. Closes #1071764. 2005-01-01 09:36:35 +00:00
Raymond Hettinger 68804315e0 SF Patch #1093896: miscellaneous doc typos 2005-01-01 00:28:46 +00:00
Raymond Hettinger 79e0531aef SF bug #1090139: presentation typo in lib: 6.21.4.2 How callbacks are called 2004-12-31 01:07:27 +00:00
Fred Drake 0a6864ecc5 discuss how the __builtin__ module is normally used, and try to clarify the
difference between __builtins__ and __builtin__ (based on an email comment)
2004-12-23 16:50:36 +00:00
Fred Drake fb915fe812 fix weird capitalization of "built-in" 2004-12-23 16:22:45 +00:00
Jeremy Hylton 6414cd8717 SF patch #1055159 via Titus Brown: Document redirect limitation.
Bug fix candidate.
2004-12-22 14:19:09 +00:00
Brett Cannon 1902146ea1 Remove outdated comments about expanduser and expandvars for Macintosh that
referred to OS 9 semantics.
2004-12-22 05:40:45 +00:00
Fred Drake 7c404a4bf7 add __file__ to the globals available for tests loaded via DocFileSuite;
this is useful for locating supporting data files, just as it is in Python
modules
2004-12-21 23:46:34 +00:00
Johannes Gijsbers f654c1c383 Add accidentally removed \end{description} back in. 2004-12-21 21:14:42 +00:00
Armin Rigo 2ccea17856 Any call to marshal.dumps() with the new optional argument 'version' just
immediately segfaults, due to a typo!  This was obviously never tested...
Added a test for it, and also fixed the documentation.
2004-12-20 12:25:57 +00:00
Raymond Hettinger f964154b8c Bug #1088206: zlib decompressobj documentation typo 2004-12-20 06:08:12 +00:00
Raymond Hettinger da264121f4 Bug #1066607: "Limitations" section of profiler docs is incorrect 2004-12-19 20:31:46 +00:00
Walter Dörwald 3fa932f7ed Fix typo (from SF bug #1086127). 2004-12-15 23:44:18 +00:00
Raymond Hettinger 744aaa02e0 SF bug #1084457: ossaudiodev no longer undocumented 2004-12-14 07:19:22 +00:00
Gregory P. Smith 7af53a6de4 the bsddb module now also works with BerkeleyDB 4.3. 2004-12-13 09:57:32 +00:00
Johannes Gijsbers f4a70f35b0 Patch #1080684: typo repair. Thanks George Yoshida!
- Doc/lib/libbase64.tex
s/algorith/algorithm

- Doc/lib/libpickle.tex
s/interchangable/interchangeable

- Doc/lib/libxmlrpclib.tex
s/{_cmp__}/{__cmp__}

leading underscore needs to be double, not single.

- Doc/ref/ref6.tex
0/1 => False/True
2004-12-12 16:52:40 +00:00
Brett Cannon 222d5b466b Setting textwrap.TextWrapper().expand_tabs to True calls expandtabs, not
expand_tabs, on the object being wrapped.
2004-12-11 09:53:52 +00:00
Raymond Hettinger a6b45cc31d Eliminate the deprecated option to return None instead of a tuple of arguments in __reduce__(). 2004-12-07 07:05:57 +00:00
Raymond Hettinger a32d22a509 Remove deprecated xmllib from inclusion in the docs. 2004-12-06 12:29:56 +00:00
Walter Dörwald e208412348 Fix for SF bug #947894: calendar.weekheader() undocumented 2004-12-06 07:58:14 +00:00
Brett Cannon c8aa848ece Have test_mkalias_relative check that sys.prefix already exists; otherwise test
is pointless.

Also add a note to the docs for the 'test' package that test cases should check
first that any conditions needed in the operating system are met before having
a test run.

Closes bug #1077302.  THanks, Ian Holsman.
2004-12-06 06:08:59 +00:00
Peter Astrand 5f5e141589 Changed signature of call function to avoid confusion: this 'args' is not the same as the one to the Popen constructor 2004-12-05 20:15:36 +00:00
Raymond Hettinger b2594050ea Added optional None arguments to itertools.islice(). 2004-12-05 09:25:51 +00:00
Raymond Hettinger 1d542f2446 Remove the deprecated statcache module. 2004-12-05 05:29:51 +00:00
Raymond Hettinger 3489cad30a Removed the deprecated bin parameter from the pickle module. 2004-12-05 05:20:42 +00:00
Raymond Hettinger 1bc82f891c Removed deprecated method arguments from the shelve module. 2004-12-05 03:58:17 +00:00
Raymond Hettinger 6c92d76abc Removed deprecated method from pstats. 2004-12-05 03:28:00 +00:00
Raymond Hettinger f3fa9460de Removed deprecated use_statcache argument. 2004-12-05 01:58:09 +00:00
Raymond Hettinger 784ab76c87 Remove the deprecated whrandom module. 2004-12-04 10:50:51 +00:00
Andrew M. Kuchling 07b28b920e Hyphenate 'one-argument' 2004-12-03 14:59:09 +00:00
Raymond Hettinger 3b0c7c20a1 SF patch #1077353: add key= argument to min and max
(First draft of patch contributed by Steven Bethard.)
2004-12-03 08:30:39 +00:00
Vinay Sajip e8fdc4502f Fixed errors reported in SF bug #1074693 2004-12-02 21:27:42 +00:00
Raymond Hettinger 4901a1f267 Add key= argument to heapq.nsmallest() and heapq.nlargest(). 2004-12-02 08:59:14 +00:00
Raymond Hettinger 5d6057f073 Fix typo. 2004-12-02 08:31:41 +00:00
Andrew M. Kuchling ab807e8a0d Make the example server code clearer; add the corresponding example client. [Bugfix candidate] 2004-12-01 18:34:11 +00:00
Peter Astrand 6fdf3cbb13 Corrected example for replacing shell pipeline. Fixes bug 1073790. 2004-11-30 18:06:42 +00:00
Michael W. Hudson 02d74f68c6 Hear the #error: change the default value of the mutable_arg argument
to ioctl() and remove the warning when it is not supplied.
2004-11-30 14:31:54 +00:00
Raymond Hettinger 4fd38b3f77 Fix typo. 2004-11-25 05:35:32 +00:00
Raymond Hettinger 23ce5848aa Clarify the ordering of dictionary keys. 2004-11-25 05:16:19 +00:00
Raymond Hettinger 3de9aa40ec Make sure the money formatting recipe can doesn't run out of digits
to the right of the decimal point.
2004-11-25 04:47:09 +00:00
Raymond Hettinger 8f2c4eed93 SF bug #1071566: moneyfmt recipe in decimal documentation has error 2004-11-24 05:53:26 +00:00
Tim Peters 7f13cfa674 os.walk(): Changed the "sum of bytes consumed by files" example to use
a generator expression instead of a listcomp.

Not a backport candidate (genexps are new in 2.4).
2004-11-22 16:53:46 +00:00
Tim Peters 919a3b40f9 SF bug 1071087: os.walk example for deleting a full tree is sometime wrong.
Clarify that the example assumes no links are present; the point of the
example is to illustrate a need for topdown=False, not to wrestle with
platform-dependent link convolutions.

Also spell os.path.join() out in full, instead of using a shortcut import.
The bug reporter was confused by that too, and it's clearer this way.

Bugfix candidate; but I don't intend to backport it.
2004-11-22 16:49:02 +00:00
Facundo Batista 139af0295c Fixed quantize syntax. 2004-11-20 00:33:51 +00:00
Raymond Hettinger a2325f67a1 SF patch #1068456: small update for pdb docs 2004-11-18 08:39:33 +00:00
Tim Peters fdc58f2391 SF bug 1066438: datetime.replace method description error
Repair typo in example.
2004-11-15 03:50:16 +00:00
Facundo Batista 441609466b SF bug 1060644. Better explanation of min() and max() methods. Thanks Raymond Hettinger and Tim Peters. 2004-11-12 02:03:36 +00:00
Greg Ward 961eda7ad9 SF #1063757: fix markup error (had LaTeX markup in the reST source,
oops!).
2004-11-12 01:20:17 +00:00
Vinay Sajip edde492f13 Minor grammatical errors fixed 2004-11-11 13:54:48 +00:00
Fred Drake 2269d86598 Fix SF bug #1061770: Manual typesets bit-shift operators as guillemet 2004-11-11 06:14:05 +00:00
Fred Drake 758f5ea419 Replace last two uses of the "list" environment with "description"
environments.

Closes SF bug #692442: Konqueror can't render docs because of
malformed HTML.  While the generated HTML is still terrible, the cited
cases of <DL COMPACT> have been removed.  The general problem of XHTML
conformance has not been solved, but is endemic to LaTeX2HTML output.
2004-11-11 05:04:55 +00:00
Fred Drake 8efc80a909 - remove use of a "list" environment (replace with a table)
- fix minor markup nits
2004-11-11 04:39:56 +00:00
Johannes Gijsbers 4de9374b0e Patch #1062033 / bug #1027771: clarify what happens when calling
insertBefore() with refChild=None.
2004-11-07 19:55:18 +00:00
Johannes Gijsbers 4f18caa07b Patch #1062018 / bug #1038693: comment out dead link in tkinter docs. 2004-11-07 19:36:48 +00:00
Peter Astrand 3546188123 Added more documentation about the executable argument.
Fixes #1056441.
2004-11-07 16:38:08 +00:00
Johannes Gijsbers f164322fe8 Patch #1061924: add documentation for BaseRotatingHandler and correct
reference to non-existent function 'setRollover()'.
2004-11-07 16:11:35 +00:00
Johannes Gijsbers eaaa771816 Clarify that it's not necessary to subclass from TestCase to create a
test case. As Jeremy put it: "subclassing is an implementation
technique, not a type declaration".
2004-11-07 16:02:07 +00:00
Johannes Gijsbers 4f802ac2b6 Patch #1061857: add documentation for previously undocumented
TimedRotatingFileHandler class. Thanks Jeroen Vloothuis!
2004-11-07 14:14:27 +00:00
Raymond Hettinger 700d9b9b63 SF patch #1061780: use a new -m option in pdb and profile invocations
Doc patch submitted by Ilya Sandler.
2004-11-07 06:18:37 +00:00
Raymond Hettinger bb4e859ecf SF bug #1060825: Error in difflib docs 2004-11-05 16:38:08 +00:00
Tim Peters 2cf5e1920b Point out some platform vagaries in stat() and utime().
Bugfix candidate (the vagaries aren't new <wink>), but I don't intend to
backport this.
2004-11-04 21:27:48 +00:00
Armin Rigo 80adba6873 Mistakes in the "sequence types" page:
* explanation for example with lists of lists made confusing use of
  the word "contains" to mean "is built out of".

* wrong formula for slices with step.  Is it ok to use LaTeX formulas
  (which become images in the html document)?  This version needs one
  because it's based on a fraction.  Just writing "\code{(j-i)/k}" here would
  be ambiguous because it looks like a rounding-down-to-the-previous-integer
  division, which is not what we need here.  Of course we could write
  "\code{float(j-i)/k}" but it just looks confusing.
2004-11-04 11:29:09 +00:00
Fred Drake 99e5ce5cf4 markup nit 2004-11-04 05:45:44 +00:00
Skip Montanaro 599bd5e1e1 Fix bug 1052242. Also includes rewrite of test case using unittest and
avoiding use of popen.
2004-11-04 04:31:30 +00:00
Barry Warsaw 87d6fc5161 SF bug #1030118, this should have named the email.Utils module as the one
containing these functions.  (I will backport to Python 2.3)
2004-11-01 03:59:24 +00:00
Barry Warsaw 8c72eae237 SF patch #1056967, changes the semantics of Template.safe_substitute() to not
raise a ValueError for dangling delimiters (the delimiter itself is returned).
2004-11-01 03:52:43 +00:00
Johannes Gijsbers 63e2090fda Bug #1057535: add link in time module to calendar.timegm(). 2004-10-31 12:19:34 +00:00
Fred Drake 048840c485 style consistency:
- always include a space after the "#" that starts a comment
- easier to read imports
2004-10-29 14:35:42 +00:00
Vinay Sajip 006483b003 Added network logging example 2004-10-29 12:30:28 +00:00
Hye-Shik Chang 182ac85147 SF #737473: Show up-to-date source code in tracebacks always.
And add an optional argument 'filename' to linecache.checkcache()
to enable checking caches per-file.
2004-10-26 09:16:42 +00:00
Fred Drake 3ed238503d add missing line break 2004-10-25 21:35:17 +00:00
Vinay Sajip 93ae4c100e Added example of multiple destinations 2004-10-22 21:43:15 +00:00
Andrew M. Kuchling 57712b3d9a Remove the current version of zlib (we'll just have to keep updating it); rewrite following sentence to make sense without the previous one 2004-10-19 19:50:23 +00:00
Andrew M. Kuchling 28d07ab676 Typo fixes, and a minor edit to clarify a sentence 2004-10-19 19:39:02 +00:00
Andrew M. Kuchling 5fcc003566 [Bug #1049826] Update version of zlib referenced in text 2004-10-19 18:52:49 +00:00
Brett Cannon 6b1597c7c7 Clarify note about using %U and %W with strptime(). 2004-10-18 01:53:15 +00:00
Brett Cannon 8abcc5d533 Add support for %U and %W to contribute to calculating the date when the year
and day of the week are specified.

Closes bug #1045381.
2004-10-18 01:37:57 +00:00
Neal Norwitz a5c64599d5 SF bug #1048756, Doc typo for pdb 2004-10-17 19:55:47 +00:00
Neal Norwitz 2562ff2de3 SF patch #1047577, typo in liblocale.tex 2004-10-17 16:36:05 +00:00
Fredrik Lundh b04b6afd01 SF Patch #1048341: subprocess documentation, based on PEP/docstring by
Peter Astrand, with markup by Fredrik Lundh and Raymond Hettinger.
2004-10-17 16:29:48 +00:00
Facundo Batista 2784df7502 SF Bug #1046800: Importing Tkinter correctly (thanks Vishnu). 2004-10-16 21:40:35 +00:00
Tim Peters 371e4d895b SF bug 1046690: difflib.HtmlDiff doc errors.
Easy doc corrections from Dan Gass.
Also repaired the LaTeX for optional keyword arguments throughout, which
was (incorrectly) nested instead of flat.
2004-10-14 03:09:48 +00:00
Johannes Gijsbers 9fc9789a0d Document that on Unix, the 'cmd' argument to the os.popen2/3/4 and
popen2.popen2/3/4 functions can be a sequence. All texts are a variation on the
following:

On \UNIX, \var{cmd} may be a sequence, in which case arguments will be passed
directly to the program without shell intervention (as with
\function{os.spawnv()}). If \var{cmd} is a string it will be passed to the shell
(as with \function{os.system()}).
2004-10-11 18:12:20 +00:00
Anthony Baxter 3dd9e46161 Added a usegmt flag to email.Utils.formatdate - this allows it to be
used to replace rfc822.formatdate for protocols like HTTP (where 'GMT' must
be the timezone string).
2004-10-11 13:53:08 +00:00
Andrew M. Kuchling 7a8ce5afcc [Bug #1022311] curses module uses y,x ordering of arguments, not x,y 2004-10-08 18:48:43 +00:00
Andrew M. Kuchling 293dc9d70f [Bug #1041501] Fix example code 2004-10-08 18:34:47 +00:00
Raymond Hettinger 77d110d6b8 SF patch #1041364: True/False instead of 1/0 in libstdtypes.tex
(Contributed by Gerrit Holl.  Reviewed by Jeff Epler.)
2004-10-08 01:52:15 +00:00
Tim Peters 29978aedcb The docs claimed a test would pass that actually wouldn't pass. Repaired
the example so it does pass.
2004-10-04 03:34:32 +00:00
Vinay Sajip 1dc5b1e5a2 Clarified documentation about exc_info keyword parameter 2004-10-03 19:10:05 +00:00
David Goodger 1cbf206d32 SF bug #997050: Document, test, & check for non-string values in ConfigParser. Moved the new string-only restriction added in rev. 1.65 to the SafeConfigParser class, leaving existing ConfigParser & RawConfigParser behavior alone, and documented the conditions under which non-string values work. 2004-10-03 15:55:09 +00:00
Michael W. Hudson bfe5684308 typo 2004-10-03 09:41:26 +00:00
Barry Warsaw 8df5921247 Blarg, fix the versions. 2004-10-03 03:58:01 +00:00
Barry Warsaw 43790b4b21 Updates for distutils package. 2004-10-03 03:57:37 +00:00
Barry Warsaw 2ec4854f13 Add documentation about as_string() mangling From_ lines. 2004-10-03 03:39:47 +00:00
Barry Warsaw bb11386730 Big email 3.0 API changes, with updated unit tests and documentation.
Briefly (from the NEWS file):

- Updates for the email package:
  + All deprecated APIs that in email 2.x issued warnings have been removed:
    _encoder argument to the MIMEText constructor, Message.add_payload(),
    Utils.dump_address_pair(), Utils.decode(), Utils.encode()
  + New deprecations: Generator.__call__(), Message.get_type(),
    Message.get_main_type(), Message.get_subtype(), the 'strict' argument to
    the Parser constructor.  These will be removed in email 3.1.
  + Support for Python earlier than 2.3 has been removed (see PEP 291).
  + All defect classes have been renamed to end in 'Defect'.
  + Some FeedParser fixes; also a MultipartInvariantViolationDefect will be
    added to messages that claim to be multipart but really aren't.
  + Updates to documentation.
2004-10-03 03:16:19 +00:00
Raymond Hettinger 565ea5ae37 SF bug#1038917 fix typos (Contributed by George Yoshida.) 2004-10-02 11:02:59 +00:00
Greg Ward e644a1b921 Get references working (except for references to "Extending optparse",
which isn't being converted from reST yet).
2004-10-01 01:16:39 +00:00
Edward Loper 0fe00aafc3 Added 2 notes about the complexities of testing SyntaxErrors. 2004-09-30 17:18:18 +00:00
Raymond Hettinger f751fa6195 SF bug #1035279: hex() and oct() documentation is incorrect
* Updated docs to reflected signed return values.
* Fixed a doubled word typo.
2004-09-30 00:59:08 +00:00
Skip Montanaro 5497feefac minor doc tweaks for writexml 2004-09-28 18:40:42 +00:00
Skip Montanaro 67db9a5b72 typo 2004-09-28 18:30:03 +00:00
Edward Loper 7d88a58e85 Reverted the addition of a NORMALIZE_NUMBERS option, per Tim Peter's
request.  Tim says that "correct 'fuzzy' comparison of floats cannot
be automated."  (The motivation behind adding the new option
was verifying interactive examples in Python's latex documentation;
several such examples use numbers that don't print consistently on
different platforms.)
2004-09-28 05:50:57 +00:00
Edward Loper aec3c9b54f Added a new NORMALIZE_NUMBERS option, which causes number literals in
the expected output to match corresponding number literals in the
actual output if their values are equal (to ten digits of precision).
2004-09-28 04:29:57 +00:00
Edward Loper 1793dd31de Fixed minor typo in interactive example (extra '.'s in '...' prompts) 2004-09-28 03:12:01 +00:00
Edward Loper dcdb4b4d78 Fixed minor typo in interactive example (extra blank line) 2004-09-28 03:08:57 +00:00
Raymond Hettinger 78a5271d3e SF bug #1033038: Misleading error message in random.choice
Added a clarifying line to the docs.
2004-09-28 03:04:23 +00:00
Edward Loper ad512265a5 Fixed minor typo in interactive example 2004-09-28 02:56:45 +00:00
Edward Loper 3077b02ff4 Fixed minor typo in interactive example (backslash shouldn't be doubled) 2004-09-28 02:54:54 +00:00
Edward Loper a7f62814cf Updated interactive examples in the "Examples" session to reflect the
fact that compiler.ast.Function now takes a "decorators" argument.
2004-09-28 02:53:50 +00:00
Greg Ward b6f7fb7327 Major overhaul to reflect Optik 1.5. Section references currently broken. 2004-09-28 01:30:23 +00:00
Armin Rigo b6aa856f25 Patch #1009075, bug #952953: allow execve with empty 2nd argument 2004-09-27 19:54:33 +00:00
Edward Loper a4c6a8522c - Added a "parser" option to testfile() and DocFileTest(). 2004-09-27 04:08:20 +00:00
Edward Loper 456ff91664 - Fixed typo in multi-line exception example
- Fixed indentation for a verbatim block
2004-09-27 03:30:44 +00:00
Tim Peters 36ee8ce373 Give a saner example for script_from_examples(); also mention an intended
but not entirely obvious use case.
2004-09-26 21:51:25 +00:00
Tim Peters 9463d8761b Made most module references "clickable". 2004-09-26 21:05:03 +00:00
Tim Peters 0041121c25 Docs for run_docstring_examples(). 2004-09-26 20:45:04 +00:00
Tim Peters 05b05febad Added a lot of new stuff to the debugging section. 2004-09-26 05:09:59 +00:00
Tim Peters 16be62f054 register_optionflag(): Moved from the Debugging section to the section
on option flags; added a versionadded decoration.
2004-09-26 02:38:41 +00:00
Tim Peters 6a0a64b7ad Document set_unittest_reportflags(). 2004-09-26 02:12:40 +00:00
Raymond Hettinger c90ea82302 Fix double word error. 2004-09-25 08:09:23 +00:00
Tim Peters 3f7912521d Assorted minor changes, plus a lot more soap. 2004-09-25 03:50:35 +00:00
Tim Peters 8c0a2cf938 Explain the motivation for the unittest functions, and beef up the
example.  Squash repeated argument descriptions.  Minor rewordings.
2004-09-25 03:02:23 +00:00
Tim Peters b2b26aca13 Repaired mistakes in the descriptions of testmod()/testfile(), and
squashed massive duplication of common argument descriptions.
2004-09-25 01:51:49 +00:00
Tim Peters 2dc820599b Since the doctest warnings section was reduced to one bullet point,
get rid of the itemize structure.
2004-09-25 01:30:16 +00:00
Tim Peters 39c5de0376 In the "doctest warnings" section, removed obsolete info, and noted that
ELLIPSIS can be used to deal with examples that embed object addresses.
2004-09-25 01:22:29 +00:00
Tim Peters 06cc847cee Beef up the section on testfile(), giving a complete example in
reStructuredText format.  Remove words describing the return value of
testmod() and testfile() in the intro sections, since it's never
useful in such simple cases.
2004-09-25 00:49:53 +00:00
Tim Peters cac5e7b81d Typo. 2004-09-25 00:11:43 +00:00
Tim Peters 7a082142d8 Since the LaTeX isn't doctest'ed, examples are always wrong <wink>. 2004-09-25 00:10:53 +00:00
Vinay Sajip 739d49e39b Added log() function documentation 2004-09-24 11:46:44 +00:00
Raymond Hettinger 596ba4d89e Granted Noam Raphael's request for minor improvements to the re module and
its documentation.

* Documented that the compiled re methods are supposed to be more full
  featured than their simpilified function counterparts.

* Documented the existing start and stop position arguments for the
  findall() and finditer() methods of compiled regular expression objects.

* Added an optional flags argument to the re.findall() and re.finditer()
  functions.  This aligns their API with that for re.search() and
  re.match().
2004-09-24 03:41:05 +00:00
Raymond Hettinger 4533f1fb7f Improve three recipes in the itertools docs. 2004-09-23 07:27:39 +00:00
Vinay Sajip c6646c097a Added getLoggerClass() 2004-09-22 12:55:16 +00:00
Edward Loper b3666a3da2 - Updated docs to reflect changes in 2.4.
- Reorganized the documentation
  - Shifted focus a little more towards "literate testing"
  - Documented new functions and classes:
    - testfile()
    - Example, DocTest
    - DocTestParser, DocTestFinder, DocTestRunner, OutputChecker
    - DocFileSuite
    - DebugRunner, DocTestFailure, UnexpectedException
    - register_optionflag()
2004-09-21 03:00:51 +00:00
Edward Loper 6cc1350807 - Updated example output to match actual output
- Minor wording changes
- Changed the docs to reflect the fact that multiple option directives
  can be specified on a single line (and updated the directive
  production list, as well).
2004-09-19 01:16:44 +00:00
Barry Warsaw 33db656dbf Update Template/PEP 292 documentation to current implementation. 2004-09-18 21:13:43 +00:00
Martin v. Löwis 39a317890f Patch #1025790: Add status code constants to httplib. 2004-09-18 09:03:49 +00:00
Raymond Hettinger 23f1241dc6 SF #1027105: HardwareRandom should be renamed OSRandom
Renamed the new generator at Trevor's recommendation.
The name HardwareRandom suggested a bit more than it
delivered (no radioactive decay detectors or such).
2004-09-13 22:23:21 +00:00
Tim Peters 8278860e52 Document testmod's new exclude_empty argument. 2004-09-13 15:03:17 +00:00
Tim Peters 2ee8099bd8 HtmlDiff corrections from Dan Gass, + trimmed trailing whitespace. 2004-09-12 03:21:00 +00:00
Johannes Gijsbers 2014c033f7 Patch #1022152: add required 'domain' argument to gettext.translation() examples. 2004-09-11 17:33:25 +00:00
Johannes Gijsbers d345225ae5 Patch #1026384: fix two common typo's:
- accomodate -> accommodate
- occured -> occurred

Thanks George Yoshida!
2004-09-11 16:50:06 +00:00
Johannes Gijsbers c9c37ca62e Patch #1025800: remove TeX quoting from verbatim section. Thanks Dima Dorfman! 2004-09-11 15:47:30 +00:00
Andrew M. Kuchling 55be9eab38 Typo fix: 'comparisions' is not a word 2004-09-10 12:59:54 +00:00
Fred Drake 961c2882a9 document the exceptions raised by sgmllib, htmllib, and HTMLParser 2004-09-10 01:20:21 +00:00
Fred Drake a2544ee7f0 fix typo in markup 2004-09-10 01:16:49 +00:00
Walter Dörwald 69652035bc SF patch #998993: The UTF-8 and the UTF-16 stateful decoders now support
decoding incomplete input (when the input stream is temporarily exhausted).
codecs.StreamReader now implements buffering, which enables proper
readline support for the UTF-16 decoders. codecs.StreamReader.read()
has a new argument chars which specifies the number of characters to
return. codecs.StreamReader.readline() and codecs.StreamReader.readlines()
have a new argument keepends. Trailing "\n"s will be stripped from the lines
if keepends is false. Added C APIs PyUnicode_DecodeUTF8Stateful and
PyUnicode_DecodeUTF16Stateful.
2004-09-07 20:24:22 +00:00
Raymond Hettinger 8158e84930 Fix erroneous docstring comment. 2004-09-06 07:04:09 +00:00
Raymond Hettinger 785c65ccd2 Markup nits. 2004-09-06 01:01:08 +00:00
Raymond Hettinger bb30af4565 Add missing close parenthesis. 2004-09-06 00:42:14 +00:00
Raymond Hettinger 18c6960964 SF bug #901654: split method documentation can be improved
* Discuss the algorithmic distinctions between s.split() and s.split(sep).
* Document the split behavior for empty strings.
* Note the behavior when maxsplit is zero.
* Include short examples.
2004-09-06 00:12:04 +00:00
Brett Cannon 1b262977a0 Rework some wording. 2004-09-05 19:42:15 +00:00
Raymond Hettinger 2a72f19528 SF bug #1020540: a wrong link from "frame object" in lib index 2004-09-04 21:14:34 +00:00