Commit Graph

4215 Commits

Author SHA1 Message Date
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
Tim Peters 0b4d1ee29d SF 964876 mapping a 0 length file
Document that it can't be done on Windows.
2004-06-06 16:51:46 +00:00
Andrew M. Kuchling e1ca355425 [Bug #918710] Add paragraph to clarify docs 2004-06-05 19:25:30 +00:00
Fred Drake 175d18840a avoid backticks in examples; use repr() instead 2004-06-03 16:23:23 +00:00
Martin v. Löwis 4a9b8069e0 Document string methods that are locale-dependent. Fixes #935749.
Will backport to 2.3.
2004-06-03 09:47:01 +00:00
Martin v. Löwis eac324b90b Patch #957240: Add count parameter to asyncore.loop. 2004-06-03 09:18:35 +00:00
Hye-Shik Chang 974ed7cfa5 - SF #962502: Add two more methods for unicode type; width() and
iswide() for east asian width manipulation. (Inspired by David
Goodger, Reviewed by Martin v. Loewis)
- Move _PyUnicode_TypeRecord.flags to the end of the struct so that
no padding is added for UCS-4 builds. (Suggested by Martin v. Loewis)
2004-06-02 16:49:17 +00:00
Martin v. Löwis 92816de18e Patch #932930: suggest the use of rawstrings for backslashes. 2004-05-31 19:01:00 +00:00
Martin v. Löwis 2a6ba9097e Patch #963318: Add support for client-side cookie management. 2004-05-31 18:22:40 +00:00
Raymond Hettinger 027bb633b6 Add weakref support to sockets and re pattern objects. 2004-05-31 03:09:25 +00:00
Skip Montanaro 79cddc56b3 stupid, stupid, stupid... raw_input() already supports readline() if the
readline module is loaded.
2004-05-24 14:20:16 +00:00
Skip Montanaro b98a8ba14d Add example that uses readline.readline(). 2004-05-23 19:06:41 +00:00
Skip Montanaro 0dc23101a0 Exposed readline() function from the readline module. 2004-05-23 17:46:50 +00:00
Raymond Hettinger e36894da3a Updated to reflect new types. 2004-05-22 16:38:11 +00:00
Piers Lauder 8bc81fc5c7 Added description for authenticate and namespace 2004-05-20 12:12:58 +00:00
Fred Drake 82903148a8 ConfigParser:
- read() method returns a list of files parsed successfully
- add tests, documentation
(closes SF patch #677651)
2004-05-18 04:24:02 +00:00
Fred Drake b4c6091984 ConfigParser:
- DuplicateSectionError is only raised by add_section()
(closes SF bug #830449)
2004-05-18 03:56:51 +00:00
Fred Drake abc086fb0d ConfigParser:
- don't allow setting options to non-string values; raise TypeError
  when the value is set, instead of raising an arbitrary exception
  later (such as when string interpolation is performed)
- add tests, documentation
(closes SF bug #810843)
2004-05-18 03:29:52 +00:00
Fred Drake bc12b01d83 ConfigParser:
- ensure that option names in interpolations are handled by
  self.optionxform in the same way that other references to option
  names
- add tests, documentation
(closes SF bug #857881, patch #865455)
2004-05-18 02:25:51 +00:00
Raymond Hettinger 0e371f2cb6 Make sure "del d[n]" is properly supported. Was necessary because the
same method that implements __setitem__ also implements __delitem__.
Also, there were several good use cases (removing items from a queue
and implementing Forth style stack ops).
2004-05-12 20:55:56 +00:00
Fred Drake 1cd6e4dc38 fix various descriptions of "ctime"
(closes SF patch #870287)
2004-05-12 03:51:40 +00:00
Fred Drake bb066cf841 fix various typos; thanks, George Yoshida!
(closes SF patch #952047)
2004-05-12 03:07:27 +00:00
Fred Drake f72de0fb8c add note about the __name__ read-only attribute
(closes SF bug #952212)
2004-05-12 02:48:29 +00:00
Fred Drake 0d73621cb2 markup adjustment 2004-05-11 05:29:34 +00:00
Barry Warsaw dd69b0ab6c Added a note describing how fp should be opened in binary mode, especially on
Windows.  Closes SF # 586899.
2004-05-10 23:12:52 +00:00
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