Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity
33,562 Commits 6 Branches 592 Tags 2.6 GiB
Commit Graph

3889 Commits

Author SHA1 Message Date
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
Tim Peters 1fbf9c5ec1 Added IGNORE_EXCEPTION_DETAIL comparison option. The need is explained 
in the new docs.

DocTestRunner.__run:  Separate the determination of the example outcome
from reporting that outcome, to squash brittle code duplication and
excessive nesting.
 2004-09-04 17:21:02 +00:00
Gustavo Niemeyer a01a2ee933 Applying modified version of patch #1018386, which fixes 
some escaping bugs in SRE.
 2004-09-03 17:06:10 +00:00
Skip Montanaro 0bbf137fbd Make the api of the _dispatch() method more concrete. I have no idea if 
this is the right way to document such things (Fred, help me out here :-),
but I got misled by the existing documentation and assumed the parameter
list was a *args sort of thing.
 2004-09-03 00:04:05 +00:00
Andrew M. Kuchling ecd5754925 Remove rotor reference 2004-08-31 13:49:36 +00:00
Andrew M. Kuchling ab459f71d6 Remove docs for xreadlines, mpz, rotor 2004-08-31 13:22:43 +00:00
Andrew M. Kuchling e723863ba1 Remove xreadlines reference 2004-08-31 13:21:07 +00:00
Andrew M. Kuchling a46fd8480f Remove TERMIOS docs 2004-08-31 13:05:59 +00:00
Andrew M. Kuchling e4133d8d67 Use correct constant; remove reference to TERMIOS.py 2004-08-31 13:05:36 +00:00
Vinay Sajip 17952b78e1 Updated doc for getLogger() 2004-08-31 10:21:51 +00:00
Tim Peters 38330fe5ef The distinction between comparison flags and reporting flags isn't unique 
to unittest, so make it official:  new module constants COMPARISON_FLAGS
and REPORTING_FLAGS, which are bitmasks or'ing together the relevant
individual option flags.

set_unittest_reportflags():  Reworked to use REPORTING_FLAGS, and
simplified overly complicated flag logic.

class FakeModule:  Removed this; neither documented nor used.
 2004-08-30 16:19:24 +00:00
Johannes Gijsbers ae882f7984 Patch #941486: add os.path.lexists(). Also fix bug #940578 by using lexists in glob.glob. 2004-08-30 10:19:56 +00:00
Raymond Hettinger 356a4599ac Teach the random module about os.urandom(). 
* Use it for seeding when it is available.
* Provide an alternate generator based on it.
 2004-08-30 06:14:31 +00:00
Martin v. Löwis e064b41f5a Patch #914575: difflib side by side diff support, diff.py s/b/s HTML option. 2004-08-29 16:34:40 +00:00
Martin v. Löwis dc3883f671 Patch #934711: Expose platform-specific entropy. 2004-08-29 15:46:35 +00:00
Raymond Hettinger 6ab78cd0c0 SF feature request #992967: array.array objects should support sequences. 
Made the constructor accept general iterables.
 2004-08-29 07:50:43 +00:00
Johannes Gijsbers 592ef6110f Correct incorrect "it's" to "its". 2004-08-26 10:40:12 +00:00
Tim Peters f33683fd40 Fine tune a word. 2004-08-26 04:52:46 +00:00
Tim Peters cf53355fcf Thinko repair. 2004-08-26 04:50:38 +00:00
Tim Peters a07bcd46f3 Reorg of exception section. Now that there are fewer details needing 
explanation, it's easier to push the remaining insufferably anal details
into a "fine print" section at the bottom.
 2004-08-26 04:47:31 +00:00
Raymond Hettinger f4fd79ca49 Small wording fixups. 2004-08-26 03:11:56 +00:00
Edward Loper a89f88d53f Added REPORT_ONLY_FIRST_FAILURE flag, which supresses output after the 
first failing example in each test.
 2004-08-26 02:45:51 +00:00
Edward Loper 71f55af826 Renamed UNIFIED_DIFF->REPORT_UDIFF; CONTEXT_DIFF->REPORT_CDIFF; and 
NDIFF_DIFF->REPORT_NDIFF.  This establishes the naming convention that
all reporting options should begin with "REPORT_" (since reporting
options are a different class from output comparison options; but they
are both set in optionflags).
 2004-08-26 01:41:51 +00:00
Tim Peters 0e448073d6 Restored half of a \versionadded only half of which should have been 
deleted.
 2004-08-26 01:02:08 +00:00
Dave Cole e8bbfe4e63 Patch #1015012. Improve markup and punctuation in libsocket.tex 2004-08-26 00:51:16 +00:00
Dave Cole 3203efb55f Patch #1014930. Expose current parse location to XMLParser. 2004-08-26 00:37:31 +00:00
Edward Loper 19b1958730 Only recognize the expected output as an exception if it *starts* with 
a traceback message.  I.e., examples that raise exceptions may no
longer generate pre-exception output.  This restores the behavior of
doctest in python 2.3.  The ability to check pre-exception output is
being removed because it makes the documentation simpler; and because
there are very few use cases for it.
 2004-08-25 23:07:03 +00:00
Martin v. Löwis be83737c7c Patch #798244: More urllib2 examples. 2004-08-25 11:24:42 +00:00
Martin v. Löwis 8d494f3241 Patch #1015021: Stop claiming that coerce can return None. 
Will backport to 2.3.
 2004-08-25 10:42:41 +00:00
Barry Warsaw 08b07def43 Ah whoops, we didn't turn string into a package (thanks Neal!) 2004-08-25 03:09:58 +00:00
Barry Warsaw 8bee76106e PEP 292 classes Template and SafeTemplate are added to the string module. 
This patch includes test cases and documentation updates, as well as NEWS file
updates.

This patch also updates the sre modules so that they don't import the string
module, breaking direct circular imports.
 2004-08-25 02:22:30 +00:00
Tim Peters c885443479 Stop producing or using OverflowWarning. PEP 237 thought this would 
happen in 2.3, but nobody noticed it still was getting generated (the
warning was disabled by default).  OverflowWarning and
PyExc_OverflowWarning should be removed for 2.5, and left notes all over
saying so.
 2004-08-25 02:14:08 +00:00
Dave Cole 07fda7e3a0 Updated the socketpair() docstring and documentation to explain that the 
default famility is AF_UNIX if defined for the platform, otherwise the
default is AF_INET.
 2004-08-23 05:16:23 +00:00
Tim Peters 656f7e4b40 Removed redundant versionadded{} for NDIFF_DIFF. Virtually everything 
in this section is new in 2.4, and that's all mentioned already in
versionadded{} thingies at the end of the section.  It hurts readability
to have them after every line <wink>.
 2004-08-23 00:26:42 +00:00
Neal Norwitz 8bd5cb342c Add version info 2004-08-22 21:48:37 +00:00
Tim Peters c6cbab0db4 Added NDIFF_DIFF option. 2004-08-22 19:43:28 +00:00
Neal Norwitz 7109b287cf Fix grammar, spotted by Hye-Shik Chang 2004-08-20 23:13:26 +00:00
Johannes Gijsbers 8e3bec5418 Correct argument specifications of load_compiled and load_source: the file 
argument is optional on both (the format string is "ss|O!").
 2004-08-20 14:38:56 +00:00
Johannes Gijsbers c89061817b Quote # as \# to make lib compile again. 2004-08-20 14:37:05 +00:00
Neal Norwitz 8623b36ee0 Try to improve grammar and use versionadded 2004-08-20 02:36:27 +00:00
Neal Norwitz 525b315326 Fix markup. versionchanged automatically adds a period, so remove the extra one. 2004-08-20 01:52:42 +00:00
Tim Peters 026f8dc103 Now that they've settled down, document doctest directives. 2004-08-19 16:38:58 +00:00
Martin v. Löwis 75b9da4aaf Patch #995126: Correct directory size, and generate GNU tarfiles by default. 2004-08-18 13:57:44 +00:00
Martin v. Löwis deacce2c87 Patch #800236: add HTTPResponse.getheaders(). 2004-08-18 12:46:26 +00:00
Raymond Hettinger 01884d56f4 Deprecate sys.exitfunc in favor of the atexit module. 
Per Guido, sys.exitfunc will be kept around for backwards compatability
but atexit will become the one preferred way to do it.
 2004-08-18 02:50:00 +00:00
Raymond Hettinger 8de636e2ae SF bug #951482: New module: doc versus action 
Strengthen the warnings about creating bogus objects using the new module.
 2004-08-17 02:31:55 +00:00
Raymond Hettinger cb40ba1f5e SF bug #805304: super instances don't support item assignment 
Document a nuance of super().  It is designed to work well with dotted
attribute lookup but not with equivalent implicit lookups using operators
or statements.
 2004-08-17 02:21:45 +00:00
Andrew M. Kuchling 7ec7584813 Typo fix 2004-08-16 16:12:23 +00:00
Raymond Hettinger 8df4e6b020 Fix punctuation typo. 2004-08-15 23:51:38 +00:00
Raymond Hettinger 2864b808c7 Add a notes section to the docs: 
* Discuss representation error versus loss of significance.
* Document special values including qNaN, sNaN, +0, -0.
* Show the suprising display of non-normalized zero values.
 2004-08-15 23:47:48 +00:00
Skip Montanaro e5069019e7 Add get_history_item and replace_history_item functions to the readline 
module.  Closes patch #675551.  My apologies to Michal Vitecek for taking so
long to process this.
 2004-08-15 14:32:06 +00:00
Johannes Gijsbers b112d6ed78 bug 990669: os.path.normpath may alter the meaning of a path if it contains 
symbolic links. This has been documented in a comment since 1992, but is now in
the library reference as well.
 2004-08-14 14:41:32 +00:00
Tim Peters 83e259a2c2 Another microburst of snail-like progress. 2004-08-13 21:55:21 +00:00
Tim Peters 41a65ea7fe Doctest has new traceback gimmicks in 2.4. While trying to document 
them (which they are now), I had to rewrite the code to understand
it.  This has got to be the most DWIM part of doctest -- but in context
is really necessary.
 2004-08-13 03:55:05 +00:00
Neal Norwitz ee6511b309 Fix the version number in which changes were made 2004-08-13 02:34:06 +00:00
Tim Peters 2603960525 Markup fiddling. 2004-08-13 01:49:12 +00:00
Tim Peters 8a3b69ca8f Excruciatingly slow progress on the docs. Option flags / directive names 
are documented now, and ripped out a bunch of "private name" convolutions.
 2004-08-12 22:31:25 +00:00
Michael W. Hudson 5e897959db This is my patch 
[ 1004703 ] Make func_name writable

plus fixing a couple of nits in the documentation changes spotted by MvL
and a Misc/NEWS entry.
 2004-08-12 18:12:44 +00:00
Fred Drake ba100c98ad clarify the behavior of the .first() and .last() methods for empty 
databases

this should be backported to the release23-maint branch
 2004-08-10 19:22:48 +00:00
Fred Drake d62d507b9a added missing documentation for UseForeignDTD() (new in 2.3) 
someone should backport to the release23-maint branch
 2004-08-10 17:18:32 +00:00
Fred Drake fb568ca52a add descriptions for many of the new error codes 2004-08-10 16:47:18 +00:00
Fred Drake 9d92d5a9ac minor changes to make this format again 2004-08-10 15:41:03 +00:00
Tim Peters c2388a2b9c Start rewriting doctest's LaTeX docs. Damn, this is slow going! 2004-08-10 01:41:28 +00:00
Andrew M. Kuchling 24884a5ccc [Patch #1005465] Markup tweaks 2004-08-09 17:36:56 +00:00
Fred Drake 151df0794d - make a module reference a hyperlink 
- wrap a long line
 2004-08-09 14:12:05 +00:00
Dave Cole 9dc19c2515 Ooops - for some reason I had the wrong versionadded... 2004-08-09 05:59:09 +00:00
Dave Cole 331708b226 Patch #1003700: Add socketpair function to socket module. 2004-08-09 04:51:41 +00:00
Tim Peters feec4533e2 Bug 1003935: xrange overflows 
Added XXX comment about why the undocumented PyRange_New() API function
is too broken to be worth the considerable pain of repairing.

Changed range_new() to stop using PyRange_New().  This fixes a variety
of bogus errors.  Nothing in the core uses PyRange_New() now.

Documented that xrange() is intended to be simple and fast, and that
CPython restricts its arguments, and length of its result sequence, to
native C longs.

Added some tests that failed before the patch, and repaired a test that
relied on a bogus OverflowError getting raised.
 2004-08-08 07:17:39 +00:00
Andrew M. Kuchling 2ee6a7027a [Patch #999280 ] Update kwargs in pickle docs to match implementations 2004-08-07 20:25:55 +00:00
Andrew M. Kuchling 17e33e4c93 [Bug #914375] Crude modulefinder docs, but the module's code is very hard to read and it's not clear which bits are public and which aren't. The module's author should really be doing this (and using docstrings in the code, too) 2004-08-07 20:13:34 +00:00
Andrew M. Kuchling 32dbddafd5 Remove various modules that have been documented 2004-08-07 19:21:59 +00:00
Andrew M. Kuchling 59a27f1d6e Various minor edits 2004-08-07 19:10:36 +00:00
Andrew M. Kuchling 4cbe95cdd1 [Bug #866222] Update docs to match the module 2004-08-07 19:06:48 +00:00
Michael W. Hudson 1baa248021 Fix 
[ 1000841 ] "make pdf" failure w/ 2.4 docs

in the suggested way, by uglifying a URL.
 2004-08-07 17:39:35 +00:00
Andrew M. Kuchling 0188cdb115 [Bug #998066] Mention result mismatch 2004-08-07 17:28:17 +00:00
Andrew M. Kuchling 8def876d36 [Bug #873146] Document pickletools module (haven't tested the LaTeX yet) 2004-08-07 16:53:59 +00:00
Michael W. Hudson 049e7aaa0f Point out that the setdefault defaults the value to None. Inspired by 
Michael Chermside's thinking about patch #748126 (the chief upshot of
which thinking was "reject it!").
 2004-08-07 16:41:34 +00:00
Andrew M. Kuchling cbbee6fed5 [Bug #984952] Include more material from PEP 307. 
I haven't tried to include all the material on old-style classes using protocols 0,1.  The details are lengthy; someone who knows
more about the pickle module should decide if they're important enough
to be in the docs or not.
 2004-08-07 16:24:18 +00:00
Andrew M. Kuchling 14d535c3d4 [Bug #984952] Include some material from PEP 307 2004-08-07 15:49:24 +00:00
Andrew M. Kuchling 6f937b1c30 [Bug #998307] Use open() instead of file() in docs 2004-08-07 15:11:24 +00:00
Andrew M. Kuchling 34ed2b020a Typo fix; use 'in-place' instead of 'inplace' 2004-08-06 18:55:09 +00:00
Raymond Hettinger 52a21b8e65 SF patch #980695: efficient string concatenation 
(Original patch by Armin Rigo).
 2004-08-06 18:43:09 +00:00
Phillip J. Eby 1884dda233 Warn that settrace() is implementation rather than language 
definition, per Guido's request  in off-list email.
 2004-08-05 12:13:46 +00:00
Matthias Klose 4c8fa42aca Doc/lib/libfuncs.tex: correct items in itemize 
Doc/dist/dist.tex: avoid uncommenting the verbose environment (by the py2texi tool)
 2004-08-04 23:18:49 +00:00
Vinay Sajip 1cf56d0b8a Updated Logger.log() documentation to clarify that lvl parameter should be an integer. 2004-08-04 08:36:44 +00:00
Hye-Shik Chang e9ddfbb412 SF #989185: Drop unicode.iswide() and unicode.width() and add 
unicodedata.east_asian_width().  You can still implement your own
simple width() function using it like this:
    def width(u):
        w = 0
        for c in unicodedata.normalize('NFC', u):
            cwidth = unicodedata.east_asian_width(c)
            if cwidth in ('W', 'F'): w += 2
            else: w += 1
        return w
 2004-08-04 07:38:35 +00:00
Fred Drake f901abdd62 allow ctime(), gmtime(), and localtime() to take None as equivalent to an omitted arg 
(closes SF bug #658254, patch #663482)
 2004-08-03 17:58:55 +00:00
Martin v. Löwis 9513e34ac4 Patch #823072: add option to NOT use ~/.netrc in nntplib.NNTP(). 2004-08-03 14:36:32 +00:00
Raymond Hettinger 70fcdb8be0 Document general mappings for the locals argument for exec and execfile(). 2004-08-03 05:17:58 +00:00
Anthony Baxter c2a5a63654 PEP-0318, @decorator-style. In Guido's words: 
"@ seems the syntax that everybody can hate equally"
Implementation by Mark Russell, from SF #979728.
 2004-08-02 06:10:11 +00:00
Fred Drake 63a5d0b1cf re-wrap paragraphs containing long lines 2004-07-30 19:12:38 +00:00
Fred Drake 69013d070e - document the termination condition for cmd.Cmd.cmdloop() 
- document the use of the return value for cmd.Cmd.do_*() methods
 2004-07-30 18:58:54 +00:00
Martin v. Löwis 479b7a7cdb Fix typo. 2004-07-30 16:09:19 +00:00
Martin v. Löwis 8ddb638e43 Add closing methoddesc. Add versionadded. Rewrap. 2004-07-30 16:08:49 +00:00
Raymond Hettinger f9fd0d7988 SF bug #997533: "disjunct" should be "disjoint" 
* Use plain wording in docs for id().
* Use normal quotation marks instead of single quotes in the description.
 2004-07-29 06:06:34 +00:00
Neal Norwitz f9f0b21653 SF #998170, fix typo. Backport candidate 2004-07-29 03:48:59 +00:00
Neal Norwitz bee417439e Add versionadded info 2004-07-28 02:34:12 +00:00
Martin v. Löwis 7b9190b8fc Patch #998149: imaplib deleteacl and myrights. 2004-07-27 05:07:19 +00:00
Fred Drake fdccf1ad6e fix information about what flag database files are opened with by default 2004-07-26 16:33:29 +00:00
Martin v. Löwis cc0f93233a Patch #605370: Add description[s] for RFC 2980 compliance. 2004-07-26 12:40:50 +00:00
Martin v. Löwis 37ead8f1c3 Patch #997668: Correct explanation of salts. 
Will backport to 2.3.
 2004-07-26 12:05:16 +00:00
Tim Peters abba5c067d Explain that most floats are actually integers. This is a common confusion 
for people using floor(), ceil() and modf().
 2004-07-26 05:12:01 +00:00
Tim Peters 9a729a1cc5 Typo in new docs. 2004-07-26 04:58:50 +00:00
Tim Peters d6ef19309d SF bugs 996748: os.environ documentation should indicate unreliability 
Clarifed that os.environ is captured once; emphasized that it's better
to assign to os.environ than to call putenv() directly (the putenv()
docs said so, but the environ docs didn't).
 2004-07-26 00:42:41 +00:00
Tim Peters 66bb6e661c SF bug 996392: math and cmath docs don't specify radians 
Major rewrite of the math module docs.  Slapped in "radians" where
appropriate; grouped the functions into reasonable categories; supplied
many more words to address common confusions about some of the subtler
issues.
 2004-07-24 23:00:24 +00:00
Tim Peters 336689b9cc A few trivial edits. 2004-07-23 02:48:24 +00:00
Raymond Hettinger cab5b94592 SF bug #995983 and #995987: Documentation nits. 2004-07-22 19:33:53 +00:00
Gustavo Niemeyer 7bd33c5e22 This change implements the following gettext features, as 
discussed recently in python-dev:

In _locale module:

- bind_textdomain_codeset() binding

In gettext module:

- bind_textdomain_codeset() function
- lgettext(), lngettext(), ldgettext(), ldngettext(),
  which return translated strings encoded in
  preferred system encoding, if
  bind_textdomain_codeset() was not used.
- Added equivalent functionality in translate()
  function and catalog classes.

Every change was also documented.
 2004-07-22 18:44:01 +00:00
Vinay Sajip b4bf62f807 Added an extra example to the basic example section 2004-07-21 14:40:11 +00:00
Skip Montanaro bf76075a4b fix typo, highlight True/False correctly 2004-07-21 02:47:10 +00:00
Neal Norwitz 7728b4719e SF #994605, fcntl example is broken 
The last call to fcntl (which wasn't changed) doesn't work for me, but
the first part works now.

Backport candidate.
 2004-07-21 01:41:14 +00:00
Neal Norwitz d96d1015ef SF #918101, allow files >= 8 GB using GNU extension 2004-07-20 22:23:02 +00:00
Martin v. Löwis b0c319a905 Patch #993187: Make rstrip doc similar to lstrip. 
Backported to 2.3.
 2004-07-19 16:34:01 +00:00
Neal Norwitz 76aa2eff4e Get doc to build (add missing backslash) 2004-07-19 01:39:54 +00:00
Tim Peters 3d7d372ce3 Whitespace normalization, via reindent.py. 2004-07-18 06:25:50 +00:00
Hye-Shik Chang 2bb146f2f4 Bring CJKCodecs 1.1 into trunk. This completely reorganizes source 
and installed layouts to make maintenance simple and easy.  And it
also adds four new codecs; big5hkscs, euc-jis-2004, shift-jis-2004
and iso2022-jp-2004.
 2004-07-18 03:06:29 +00:00
Hye-Shik Chang 910d8f1e89 Change CJK encoding aliases to their most popular variation of 
hyphen and underscores in consistency of non-CJK aliases.
(Spotted by Mike Brown at SF #969415)
 2004-07-17 14:44:43 +00:00
Andrew M. Kuchling 872dc5c457 Minor edits 2004-07-17 13:35:43 +00:00
Tim Peters de8332171a SF bug 990749: os constants missing 
A LaTeX comment identified the 6 os.O_XXX constants the docs claimed
are available on Windows but aren't.  The bug report listed the same 6.
Split these non-Windows constants into a different table with a possibly
correct "Availability:" claim.
 2004-07-15 05:46:37 +00:00
Raymond Hettinger 9296023938 Improve examples for working with the context API. 2004-07-14 21:06:55 +00:00
Jim Fulton d15dc06df0 Implemented thread-local data as proposed on python-dev: 
http://mail.python.org/pipermail/python-dev/2004-June/045785.html
 2004-07-14 19:11:50 +00:00
Guido van Rossum 8cec3ab0e4 - Bug #981530: Fix UnboundLocalError in shutil.rmtree(). This affects 
the documented behavior: the function passed to the onerror()
  handler can now also be os.listdir.

[I could've sworn I checked this in, but apparently I didn't, or it
got lost???]
 2004-07-14 00:48:58 +00:00
Andrew M. Kuchling 2a510ce119 Wordsmithing 2004-07-13 14:03:31 +00:00
Brett Cannon 71868e74d6 Add another point in the "Restrictions" section about how the handling of FTP 
URLs will seemingly succeed to read a URL that points to a file whose
permissions you do not have to read.

Backport candidate once everyone agrees with the wording.
 2004-07-13 00:48:42 +00:00
Vinay Sajip 20f42c433b Fixed minor bugs in the example configuration file 2004-07-12 15:48:04 +00:00
Raymond Hettinger d7c7115926 Small elaboration and typo fixes. 2004-07-12 13:22:14 +00:00
Tim Peters 5af0e41482 Bug #788520: Queue class has logic error when non-blocking 
I don't agree it had a bug (see the report), so this is *not* a candidate
for backporting, but the docs were confusing and the Queue implementation
was old enough to vote.

Rewrote put/put_nowait/get/get_nowait from scratch, to use a pair of
Conditions (not_full and not_empty), sharing a common mutex.  The code
is 1/4 the size now, and 6.25x easier to understand.  For blocking
with timeout, we also get to reuse (indirectly) the tedious timeout
code from threading.Condition.  The Full and Empty exceptions raised
by non-blocking calls are now easy (instead of nearly impossible) to
explain truthfully:  Full is raised if and only if the Queue truly
is full when the non-blocking put call checks the queue size, and
similarly for Empty versus non-blocking get.

What I don't know is whether the new implementation is slower (or
faster) than the old one.  I don't really care.  Anyone who cares
a lot is encouraged to check that.
 2004-07-12 00:45:14 +00:00
Fred Drake 2363e8fece Added documentation for the "smtpd" module. 
Closes SF bug #450803.
 2004-07-11 16:25:25 +00:00
Raymond Hettinger 88e8e34ab0 Style nit. 2004-07-11 13:20:11 +00:00
Raymond Hettinger 65df07bf23 Minor improvements, fixups and wording changes everywhere. 2004-07-11 12:40:19 +00:00
Kurt B. Kaiser 8932b41669 Patch 851752 (fixes bug 820583) 
Patch by John J Lee
Reviewed by Jeff Epler / KBK
Doc built OK.

urlopen() may return None if no handler handles the request.

Also clarify what install_opener does.

M liburllib2.tex
 2004-07-11 02:13:17 +00:00
Brett Cannon cd77dd6321 Fix minor error in example. 2004-07-10 23:06:07 +00:00
Brett Cannon 91cc5cd188 Clarify docs for inspect.getargspec() that the fourth value is None when there 
are no default arguments for the function.
 2004-07-10 21:13:06 +00:00
Andrew M. Kuchling 3a2418a1d6 [Patch #969900] Various corrections and updates to cookielib docs 2004-07-10 18:41:28 +00:00
Andrew M. Kuchling 300ce19592 [Patch #972310] Apply correction to docs 2004-07-10 18:28:33 +00:00
Andrew M. Kuchling 099bd524a4 [Bug 949832] Fix example; edit sentence 2004-07-10 16:01:10 +00:00
Raymond Hettinger bf4406971c Improve Context construction and representation: 
* Rename "trap_enablers" to just "traps".
* Simplify names of "settraps" and "setflags" to just "traps" and "flags".
* Show "capitals" in the context representation
* Simplify the Context constructor to match its repr form so that only
  the set flags and traps need to be listed.
* Representation can now be run through eval().

Improve the error message when the Decimal constructor is given a float.

The test suite no longer needs a duplicate reset_flags method.
 2004-07-10 14:14:37 +00:00
Raymond Hettinger 0d278b861e SF bug #987486: fix typo. 2004-07-10 11:15:56 +00:00
Raymond Hettinger 5aa478badf Module and tests: 
* Map conditions to related signals.
* Make contexts unhashable.
* Eliminate used "default" attribute in exception definitions.
* Eliminate the _filterfunc in favor of a straight list.

Docs:
* Eliminate documented references to conditions that are not signals.
* Eliminate parenthetical notes such as "1/0 --> Inf" which are no
  longer true with the new defaults.
 2004-07-09 10:02:53 +00:00
Raymond Hettinger 97c9208c6c Incorporate Facundo's suggestions. 2004-07-09 06:13:12 +00:00
Skip Montanaro 2b2795ac6d show how easy it is to manipulate individual columns - from a request on 
c.l.py
 2004-07-08 19:49:10 +00:00
Raymond Hettinger 536f76b25a Fix markup, typos, and nits. 2004-07-08 09:22:33 +00:00
Vinay Sajip e3c330b42a Replaced some tabs with spaces in verbatim section. 2004-07-07 15:59:49 +00:00
Raymond Hettinger 2f55eb4cca Demonstrate how to round final result. 2004-07-06 01:55:14 +00:00
Raymond Hettinger 10959b1c2a Expand examples to show polymorphism 2004-07-05 21:13:28 +00:00
Raymond Hettinger 77e13b4ead Simplify examples. 2004-07-05 20:27:53 +00:00
Raymond Hettinger c4f93d4410 Doc tested the recipes. 2004-07-05 20:17:13 +00:00
Raymond Hettinger 9c719bafbf Fix typo 2004-07-05 18:56:03 +00:00
Raymond Hettinger d84efb3d93 * Added missing info on construction from a tuple. 
* Added a recipe section.
 2004-07-05 18:41:42 +00:00
Raymond Hettinger 8de63a206e Add decimal docs to the core. 2004-07-05 05:52:03 +00:00
Nicholas Bastin 068979cdd6 Textual change to make the doc reflect reality 2004-07-04 04:47:40 +00:00
Vinay Sajip a13c60b810 Moved example section up to just after the section on Logger objects, and changed it to use the new basicConfig() API 2004-07-03 11:45:53 +00:00
Fred Drake 0a4dd390bf Make weak references subclassable: 
- weakref.ref and weakref.ReferenceType will become aliases for each
  other

- weakref.ref will be a modern, new-style class with proper __new__
  and __init__ methods

- weakref.WeakValueDictionary will have a lighter memory footprint,
  using a new weakref.ref subclass to associate the key with the
  value, allowing us to have only a single object of overhead for each
  dictionary entry (currently, there are 3 objects of overhead per
  entry: a weakref to the value, a weakref to the dictionary, and a
  function object used as a weakref callback; the weakref to the
  dictionary could be avoided without this change)

- a new macro, PyWeakref_CheckRefExact(), will be added

- PyWeakref_CheckRef() will check for subclasses of weakref.ref

This closes SF patch #983019.
 2004-07-02 18:57:45 +00:00
Raymond Hettinger 214b1c3aae SF Bug #215126: Over restricted type checking on eval() function 
The builtin eval() function now accepts any mapping for the locals argument.
Time sensitive steps guarded by PyDict_CheckExact() to keep from slowing
down the normal case.  My timings so no measurable impact.
 2004-07-02 06:41:07 +00:00
Skip Montanaro 78bace7442 add cp866 row 2004-07-02 02:14:34 +00:00
Walter Dörwald ac1075a645 Document that encode() and decode() raise UnicodeError 
instead of ValueError.

Add a note about error handling schemes added by PEP 293.
 2004-07-01 19:58:47 +00:00
Skip Montanaro ecf7a52bb8 link to the codecs page from the "".encode() description. 2004-07-01 19:26:04 +00:00
Skip Montanaro 2ccf5d689b use file() in preference to open() 2004-06-30 21:06:45 +00:00
Michael W. Hudson d5cf143482 Check in the updated version of patch #957240, which doesn't rely 
on the marshalling characteristics of infinities.
 2004-06-30 09:02:33 +00:00
Andrew M. Kuchling 7dd8fda49f [Bug #978556] Update SHA spec URL; bugfix candidate 2004-06-29 13:35:01 +00:00
Barry Warsaw 11b91a0ea3 Added socket.getservbyport(), and make its second argument and that of 
getservbyname() optional.  Update the tests and the docs.
 2004-06-28 00:50:43 +00:00
Martin v. Löwis ef82d2fdfe Patch #923098: Share interned strings in marshal. 2004-06-27 16:51:46 +00:00
Fred Drake b86aa99eb9 move the note about the bsddb185 module above the "See also" box; that 
should always go last in the relevant section's main content, but
before child sections
 2004-06-24 06:03:59 +00:00
Raymond Hettinger 28224f897a Improve the documented advice on how to best use heapq.heapreplace(). 2004-06-20 09:07:53 +00:00
Brett Cannon 3706855d11 Add apparently missing word for InvalidStateError definition. 
Closes bug #973901.  Thanks Brian Gough.
 2004-06-17 21:34:05 +00:00
Michael W. Hudson 9e151d149e add missing closing quote. 2004-06-17 13:29:11 +00:00
Martin v. Löwis 64af6c545c Comment that getfilesystemencoding returns mbcs even on NT+. Fixes #964870. 2004-06-16 04:53:46 +00:00
Raymond Hettinger aefde435ef Reverse argument order for nsmallest() and nlargest(). 
Reads better when the iterable is a generator expression.
 2004-06-15 23:53:35 +00:00
Raymond Hettinger b67ad7e671 Patch #826074: cmath.log optional base argument, fixes #823209 
(Contributed by Andrew Gaul.)
 2004-06-14 07:40:10 +00:00
Martin v. Löwis ad21945d03 Back out #957240. 2004-06-14 04:58:42 +00:00
Neal Norwitz 965eeca630 SF bug #970042, lockf() signature uses len, doc refers to length (use length, same as docstring) 2004-06-13 21:11:03 +00:00
Raymond Hettinger 2e3dfaf707 Install C version of heapq.nsmallest(). 2004-06-13 05:26:33 +00:00
Raymond Hettinger 2e6694086f Minor wording and spacing nits. 2004-06-12 07:59:40 +00:00
Raymond Hettinger 34809170e5 Complete the list of weakreferencable objects. 2004-06-12 06:56:44 +00:00
Raymond Hettinger 33ecffb65a SF patch #969791: Add nlargest() and nsmallest() to heapq. 2004-06-10 05:03:17 +00:00
Fred Drake da4513a88b make a reference to the SimpleHTTPServer module a hyperlink to the 
docs
 2004-06-09 14:50:19 +00:00
Martin v. Löwis 737ea82a5a Patch #774665: Make Python LC_NUMERIC agnostic. 2004-06-08 18:52:54 +00:00
Fred Drake 7f35404b7b - markup fix 
- explain Python/ceval.c from what; lots of people don't use a source
  distro any more
 2004-06-08 14:01:27 +00:00
Martin v. Löwis bdec50f027 Feature request #935915: Add os.path.devnull. 2004-06-08 08:29:33 +00:00
Martin v. Löwis f30d60edbc Patch #510695: Add TSC profiling for the VM. 2004-06-08 08:17:44 +00:00
Andrew M. Kuchling 44cbfd7819 [Bug #953177] Mention .getlist(); text from Paul Moore 2004-06-06 23:28:23 +00:00