Commit Graph

13468 Commits

Author SHA1 Message Date
Vinay Sajip dd7987382d Merged upstream changes. 2012-06-24 11:24:05 +01:00
Vinay Sajip d89dae18e8 Added Windows launcher documentation. 2012-06-24 11:23:07 +01:00
Georg Brandl b9831ab63c Move Linux-only *xattr() functions to their own subheading. 2012-06-24 11:57:07 +02:00
Georg Brandl 7ac2af78a2 Fix typo. 2012-06-24 11:56:47 +02:00
Georg Brandl b1a1ac0b67 Small nits in os doc. 2012-06-24 11:54:07 +02:00
Georg Brandl 50c4000685 "Refactor" docs for the new dir_fd, follow_symlinks, path-as-fd APIs: document the options at a central place and link to it. 2012-06-24 11:45:20 +02:00
R David Murray 97f43c019f #15160: Extend the new email parser to handle MIME headers.
This code passes all the same tests that the existing RFC mime header
parser passes, plus a bunch of additional ones.

There are a couple of commented out tests where there are issues with the
folding.  The folding doesn't normally get invoked for headers parsed from
source, and the cases are marginal anyway (headers with invalid binary data)
so I'm not worried about them, but will fix them after the beta.

There are things that can be done to make this API even more convenient, but I
think this is a solid foundation worth having.  And the parser is a full RFC
parser, so it handles cases that the current parser doesn't.  (There are also
probably cases where it fails when the current parser doesn't, but I haven't
found them yet ;)

Oh, yeah, and there are some really ugly bits in the parser for handling some
'postel' cases that are unfortunately common.

I hope/plan to to eventually refactor a lot of the code in the parser which
should reduce the line count...but there is no escaping the fact that the
error recovery is welter of special cases.
2012-06-24 05:03:27 -04:00
Mark Dickinson b8dc3ab08b Issue #12965: More PyLong_As* clarifications. Thanks Stefan Krah. 2012-06-23 12:12:52 +01:00
Mark Dickinson f0acfeeccf Issue #12965: Clean up C-API docs for PyLong_AsLongLong(AndOverflow); clarify that __int__ will be called for non-PyLongs 2012-06-23 11:14:22 +01:00
Mark Dickinson 0a22924d52 Issue #12965: Clean up C-API docs for PyLong_AsLong(AndOverflow); clarify that __int__ will be called for non-PyLongs 2012-06-23 10:49:12 +01:00
Ezio Melotti f90ea1f0a0 #14840: Add a bit on the difference between tuples and lists. Initial patch by Zachary Ware. 2012-06-17 14:10:59 +02:00
Antoine Pitrou 13775221e0 Issue #14933: fix misleading doc about weakref support in extension types. 2012-06-15 19:11:31 +02:00
Sandro Tosi 27b130e702 Issue #15060: better fix, thanks to review on #python-dev 2012-06-14 00:37:09 +02:00
Sandro Tosi 56692f5722 Issue #15060: fix typo in socket doc; Patch by anatoly techtonik 2012-06-13 23:58:54 +02:00
Nick Coghlan a3a164a03c Nudge readers towards a more accurate mental model for loop else clauses 2012-06-07 22:41:34 +10:00
Sandro Tosi 7f671338de backport c4bd68be5fc6 to 3.2 2012-06-02 23:41:19 +02:00
Sandro Tosi 964f205a34 refer to time.strftime 2012-06-02 18:22:02 +02:00
R David Murray 554b3481fa #14957: fix doc typo. 2012-06-02 11:20:29 -04:00
R David Murray ae1b94b6e4 #14957: clarify splitlines docs.
Initial patch by Michael Driscoll, I added the example.
2012-06-01 16:19:36 -04:00
Sandro Tosi 3f7d1d3303 Issue #14968: set 'Inplace Operators' as subsection; patch by Lars Buitinck 2012-06-01 20:23:20 +02:00
Brian Curtin 13c70345ca Fix #14943. Update the proper default value and list the proper argument names in the explanation. 2012-05-29 18:34:45 -05:00
R David Murray e1398f77ea #11785: fix the :mod: references in email package submodule titles. 2012-05-27 17:17:53 -04:00
Petri Lehtinen 1a01ebc41c #14863: Update the documentation of os.fdopen()
There's no bufsize argument anymore, and os.fdopen() is only a very
thin wrapper around open() anymore. Change the documentation to
reflect that.
2012-05-24 21:46:36 +03:00
Hynek Schlawack 979f37afd2 Restore [] where default arguments are not keywords
Reverts some changes of d13fdd97cc8e.
2012-05-22 16:12:18 +02:00
Hynek Schlawack dfa465243c #14804: Remove [] around optional arguments with default values 2012-05-21 11:01:54 +02:00
Hynek Schlawack f54c0604c8 Fix `versionchanged` tags for json.load
`versionchanged` tags about 2.7 are useless in 3.x branches.
2012-05-20 18:32:53 +02:00
Vinay Sajip 69d8493899 Fixes #14864: Added documentation on how to undo the effects of a logging.disable() call. 2012-05-20 15:36:17 +01:00
Hynek Schlawack 1203e83d28 Document when json.load's parse_constant behaviour changed
It doesn't get called on 'null', 'true', 'false' since f686aced02a3.
2012-05-20 12:03:17 +02:00
Petri Lehtinen 079bfc962d #14494: Document that absolute imports became default in 3.0 instead of 2.7. 2012-05-19 18:36:33 +03:00
Petri Lehtinen 1033b310a3 Fix time.time() references in the time module docs
Closes #14842.
2012-05-18 21:22:47 +03:00
R David Murray f7a6615719 #14823: Simplify threading.Lock.acquire argument discussion. 2012-05-17 09:13:30 -04:00
Hynek Schlawack 9729fd4427 #14692 Fix json docs to reflect changes in json.load
The behaviour of the parse_constant callback changed insofar that 'null',
'true', 'false' don't trigger its call anymore.

Patch by Serhiy Storchaka
2012-05-16 19:01:04 +02:00
R David Murray 28e68ea6ea #1440472: reflow 2012-05-15 22:13:29 -04:00
R David Murray ea1badbfef #1440472: Explain that email parser/generator isn't *quite* "idempotent" 2012-05-15 22:07:52 -04:00
R David Murray 539f239e88 #14766: Reflow the altered paragraphs. 2012-05-14 22:17:23 -04:00
R David Murray 9075d8b771 #14766: Add correct algorithm for when a 'time' object is naive.
This patch also clarifies the definition of Naive and Aware.

Original patch by Greg Weller, I modified the first hunk
somewhat to make the exposition even clearer (I hope).
2012-05-14 22:14:46 -04:00
Ezio Melotti e768b06f16 #14405: remove outdated/broken/duplicate links. 2012-05-14 13:26:45 +03:00
Mark Dickinson ba3b0d84bd Issue #14245: Improve floating-point entry in FAQ. Thanks Zbyszek Jędrzejewski-Szmek for some of the wording. 2012-05-13 21:00:35 +01:00
Ezio Melotti b35480e1d2 #14770: improve the library FAQ. 2012-05-13 20:14:04 +03:00
Sandro Tosi 3918b1ebfb Issue #14793: fix grammar in bytes object paragraph; patch by Tshepang Lekhonkhobe 2012-05-13 11:01:20 +02:00
Sandro Tosi 38b86b4cf5 correctly define what 'fill' could be; thanks to Leland Hulbert from docs@ 2012-05-12 23:29:32 +02:00
Antoine Pitrou a9494f6c53 Some nits in the pickle docs. 2012-05-10 15:38:30 +02:00
Antoine Pitrou cc6c673a69 Removed outdated statement about pickle's and marshal's relative performance. 2012-05-10 15:18:20 +02:00
Ezio Melotti bf3165b971 #14763: document default maxsplit value for str.split. 2012-05-10 15:30:42 +03:00
R David Murray b98b37f101 Improve the grammar of a non-sentence. 2012-05-08 21:28:24 -04:00
Georg Brandl 0958a4d63d Fix document title for Sphinx. 2012-05-06 21:39:35 +02:00
Ezio Melotti 9ab3fdd8cb #14034: fix indentation. 2012-05-06 17:05:16 +03:00
Ezio Melotti 6cc7a41c2f #14034: added the argparse tutorial. Patch by Tshepang Lekhonkhobe. 2012-05-06 16:15:35 +03:00
Ned Deily 2e20968feb Issue #10433: Document unique behavior of 'os.getgroups' on Mac OS X. 2012-04-30 11:14:02 -07:00
Ezio Melotti 3d6d7a5e15 #14558: document the module, argv, and testLoader args of unittest.main. 2012-04-30 19:10:28 +03:00
Senthil Kumaran 290416f364 Issue11352 - Update cgi module docs 2012-04-30 22:43:13 +08:00
Raymond Hettinger 99a56386f1 Issue 14688: Fix typo 2012-04-29 09:32:30 -07:00
Ezio Melotti a0b1d1eea2 #14519: fix the regex used in the scanf example. 2012-04-29 11:47:28 +03:00
Ezio Melotti b8e336b974 Fix markup in unittest doc. 2012-04-29 10:52:18 +03:00
Senthil Kumaran db727b4a77 Fix issue6085 - Remove the delay caused by fqdn lookup while logging in BaseHTTPRequestHandler 2012-04-29 13:41:03 +08:00
Ezio Melotti 0a6b5419b0 #14461: fix wording. 2012-04-29 07:34:46 +03:00
Senthil Kumaran 8dc500476a issue14427 - Document Request.get_header and Request.header_items 2012-04-29 11:50:39 +08:00
Ezio Melotti 285e51b7e0 #14155: add a note about \b. 2012-04-29 04:52:30 +03:00
Sandro Tosi 100b889ccd Issue #14448: add reference to IANA timezone database; thanks to Georg/Nick suggestions 2012-04-28 11:19:37 +02:00
Sandro Tosi d11d0d6343 Issue #14448: mention pytz; patch by Andrew Svetlov 2012-04-24 19:46:06 +02:00
Sandro Tosi 3e29d93007 Issue #14554: correct example for captured_stdout(); patch by Tshepang Lekhonkhobe 2012-04-24 18:39:24 +02:00
Sandro Tosi e6c3462607 Issue #13478: document timeit.default_timer() 2012-04-24 18:11:46 +02:00
Sandro Tosi 08ccbf4be9 Issue #13587: use the right RFC2617 name for WWW-Authenticate; patch by Aaron Maenpaa 2012-04-24 17:36:41 +02:00
R David Murray 790e005669 #14640: Fix typos/syntax in pyporting.rst.
Patch by Dionysios Kalofonos.
2012-04-23 14:44:00 -04:00
Sandro Tosi cfdba61c3c Issue #14641: minor fixes to sockets Howto; patch by Dionysios Kalofonos 2012-04-23 19:45:07 +02:00
Senthil Kumaran a42665f4d4 issue2193 - Update 3.2 docs about legal characters allowed in Cookie name 2012-04-22 10:30:17 +08:00
Ned Deily cc19140607 Remove webbrowser doc reference to the previously removed internet-config option. 2012-04-18 12:48:52 -07:00
Vinay Sajip 62930e1cc5 Corrected version numbers in cookbook example. 2012-04-17 00:40:48 +01:00
Vinay Sajip 59b9a79a5a Tweaked format of cookbook example. 2012-04-16 15:46:18 +01:00
Vinay Sajip b00e8f108d Added cookbook example for BOM insertion. 2012-04-16 15:28:50 +01:00
Sandro Tosi 1ee17198c8 fix typo; thanks to Jérôme Mainka from docs@ 2012-04-14 16:01:17 +02:00
Ezio Melotti 84e59aa989 Fix highlight and spacing in json example. 2012-04-13 21:02:18 -06:00
Ezio Melotti f86b28e3d2 #14535: fix code highlight in multiprocessing examples. Patch by Tshepang Lekhonkhobe. 2012-04-13 20:50:48 -06:00
Georg Brandl d46d69c279 3.2 sidebar: link to 3.3, not 3.1 2012-04-12 19:41:10 +02:00
R David Murray e7bade568e #14553: fix word order.
Patch by Tshepang Lekhonkhobe.
2012-04-11 20:13:25 -04:00
R David Murray 644cabed4b #14552: remove redundant wording in 'test' docs.
Original patch by Tshepang Lekhonkhobe.
2012-04-11 20:11:53 -04:00
Antoine Pitrou f6cd9b2d46 Improve the threading.Condition docs. 2012-04-11 19:37:56 +02:00
Georg Brandl 2c5807572f Closes #14545: make clearer what was added. 2012-04-11 18:33:17 +02:00
Antoine Pitrou b96a354556 Small improvements to the threading docs: better publicize support for the with statement. 2012-04-10 22:47:55 +02:00
Antoine Pitrou 2c9f1042c6 Fix some markup in the threading docs. 2012-04-10 22:35:53 +02:00
Antoine Pitrou 126aef768d Issue #8799: Fix and improve the threading.Condition documentation. 2012-04-10 22:24:05 +02:00
Vinay Sajip 074faff925 Updated logging reference and HOWTO. 2012-04-10 19:59:50 +01:00
Senthil Kumaran cc4979092f minor .rst fix 2012-04-10 19:51:00 +08:00
Vinay Sajip 838e638a96 Corrected comment in cookbook example script. 2012-04-09 19:46:24 +01:00
Vinay Sajip 0292fa99ef Added multiprocessing example to logging cookbook. 2012-04-08 01:49:12 +01:00
Georg Brandl 3abebca780 Closes #14511: fix wrong opensearch link for 3.2 docs. 2012-04-07 19:22:17 +02:00
Sandro Tosi fee3fc748e Issue #14502: release() and unlocked lock generates a ThreadError 2012-04-05 22:51:54 +02:00
R David Murray 28b8b94760 #14481: fix formatting of example in subprocess docs. 2012-04-03 08:46:48 -04:00
Sandro Tosi 165a2c2e27 fix typo; thanks to Robert Bardos from docs@ 2012-04-01 01:50:00 +02:00
Antoine Pitrou 6afd11c762 Issue #14456: improve documentation of the signal module w.r.t. threads. 2012-03-31 20:56:21 +02:00
Sandro Tosi 317075de29 use unittest.skip; thanks to Chang Min Jeon from docs@ 2012-03-31 18:34:59 +02:00
Sandro Tosi 9ee65f1f92 add 'safari' to webbrowser browsers table; thanks to Jonathan Eunice from docs@ 2012-03-31 17:23:10 +02:00
R David Murray 5e0c57142d #10423: clarify options vs args in argparse discussion of optparse
Patch by Sandro Tosi.
2012-03-30 18:07:42 -04:00
R David Murray 07cf1d8085 #14416: add missing LOG_SYSLOG facility to syslog docs. 2012-03-29 06:47:35 -04:00
Sandro Tosi 99e7d0706e Issue #14410: fix typo in argparse doc; patch by Tshepang Lekhonkhobe 2012-03-26 19:36:23 +02:00
Vinay Sajip 8ece80faae Minor documentation tweak. 2012-03-26 17:09:58 +01:00
Georg Brandl d34fc8b275 Add missing files for new doc theme. 2012-03-25 20:40:57 +02:00
Georg Brandl ab7121430e Switch to new "lighter" doc design. 2012-03-25 20:31:57 +02:00
Georg Brandl 11ee31ab08 Closes #14401: fix typos in curses howto. 2012-03-25 08:43:22 +02:00
Martin v. Löwis 2dee394af9 Issue #14400: Fix typo. 2012-03-24 17:39:57 +01:00
R David Murray 1623afff67 #14355: remove obsolete doc reference to previously removed init_frozen.
Patch by Eric Snow.
2012-03-18 20:50:03 -04:00
Georg Brandl 3a19e542ff Closes #14250: regex.flags has not only explicit flags but also implicit flags and those from the pattern 2012-03-17 17:29:27 +01:00
Georg Brandl 557a3ec9bb Closes #14343: avoid shadowing builtin input() in example code. 2012-03-17 17:26:27 +01:00
Georg Brandl 5ec6fdb0f6 Closes #14342: remove out-of-date section about avoiding recursion errors. 2012-03-17 17:25:47 +01:00
Georg Brandl 12c3cd7c1f Closes #14306: clarify expensiveness of try-except and update code snippet 2012-03-17 16:58:05 +01:00
Senthil Kumaran f2123d2db5 3.2 explain json.dumps for non-string keys in dicts. closes issue6566. Patch contributed Kirubakaran Athmanathan 2012-03-17 00:40:34 -07:00
R David Murray 41914349ad #11780: s/throw/raise/ 2012-03-16 22:10:00 -04:00
R David Murray 69ebfe43b0 #11780: document that email.encoders throw TypeError on multipart messages. 2012-03-16 22:03:17 -04:00
Eli Bendersky 969b8daf5a Issue #14202: some additional doc fixes 2012-03-16 16:49:58 +02:00
Eli Bendersky 3fb05a90ce Issue #14202: Greatly enhance the documentation of xml.dom.pulldom.
Patch by Florian Mladitsch
2012-03-16 14:37:14 +02:00
Eli Bendersky 604c4ff43d Issue #9257: clarify the events iterparse accepts 2012-03-16 08:41:30 +02:00
Senthil Kumaran 6b3434ae04 Explain the use of charset parameter with Content-Type header. Issue11082 2012-03-15 18:11:16 -07:00
R David Murray 38c2754652 #12758: removing confusing mention of UTC from time.time description
Patch by Dylan Sarber.
2012-03-15 03:06:15 -04:00
Senthil Kumaran 87684e6eea Fix the wrong urllib exampls which use str for POST data. Closes Issue11261 2012-03-14 18:08:13 -07:00
Georg Brandl 300a691026 Closes #14305: fix typo. 2012-03-14 22:40:08 +01:00
Georg Brandl 525fd5447d Closes #14289: put a link to the CHM download page on the docs download page. 2012-03-14 08:18:47 +01:00
Georg Brandl 69c7a69cbe Closes #14283: match() and search() are regex methods, not match methods. 2012-03-14 08:02:43 +01:00
Senthil Kumaran 21c71bac5f closes Issue12365 - Add an example explaining the context manager use case of urllib.urlopen 2012-03-13 19:47:51 -07:00
Senthil Kumaran 6080db7606 closes issue14257 - Grammatical fix 2012-03-12 10:05:34 -07:00
Senthil Kumaran a7fccd8b14 closes issue14257 - 3.2 minor error in glossary wording regarding __hash__ 2012-03-11 21:04:56 -07:00
Mark Dickinson 328dd0d5f3 Closes #9574: Note that complex constructor doesn't allow whitespace around central operator. 2012-03-10 16:09:35 +00:00
Georg Brandl 64a40949cf Closes #14186: add link to PEP 3107 (function annotations) to the function definition section. 2012-03-10 09:22:47 +01:00
Senthil Kumaran 065dedaf47 Fix closes Issue: 14217 - 3.2 branch 2012-03-08 20:56:52 -08:00
Jason R. Coombs 30b8e5461d Use PEP-8 style in logging example 2012-03-07 10:26:08 -05:00
Éric Araujo e5eec7e198 Move xml.etree higher and xml.parsers.expat lower in the markup ToC.
I assume that most users looking at this page are looking for a library
to process XML, not a low-level parser.  First proposed in #11379.
2012-03-05 16:01:41 +01:00
Éric Araujo fdfaf0aba2 Use source reST role instead of file where it makes sense.
source generates a nifty link to the Mercurial web viewer.
2012-03-05 15:50:37 +01:00
Éric Araujo d3899e320f Remove mention of defunct file.
Misc/COPYRIGHT was renamed twelve years ago to LICENSE and later copied
to the main docs, to which there is already a link.
2012-03-05 15:47:32 +01:00
Eli Bendersky b2b18632ce merge 3.2 heads 2012-03-02 07:43:08 +02:00
Eli Bendersky 20293441da Issue #11379: add a note in xml.dom.minidom suggesting to use etree in some cases 2012-03-02 07:37:13 +02:00
Petri Lehtinen 4d2bfb5e08 sqlite3: Port documentation changes from the 2.7 branch
Issue #13491.
2012-03-01 21:48:38 +02:00
Ezio Melotti 443f000bdd #14155: remove duplication about search vs match in re doc. 2012-02-29 13:39:05 +02:00
Ezio Melotti 5a045b9f54 #10713: Improve documentation for \b and \B and add a few tests. Initial patch and tests by Martin Pool. 2012-02-29 11:48:44 +02:00
Larry Hastings 62417a0354 Propagate changes for issues #13053 and #13086 from 2.7 to 3.2. (Doc only.) 2012-02-28 16:21:47 -08:00
Sandro Tosi 83c48822c5 s/div/truediv/; thanks to Félix-Antoine Fortin from docs@ 2012-02-28 22:28:28 +01:00
Vinay Sajip 39b83ac772 Improved logging cookbook example. 2012-02-28 08:05:23 +00:00
Georg Brandl e998386442 Fix markup errors. 2012-02-28 08:21:40 +01:00
Vinay Sajip 982f534fab Updated cookbook with information on customising LogRecords. 2012-02-27 11:56:29 +00:00
Vinay Sajip 6b883a2c4d Updated logging cookbook with info on alternative format styles. 2012-02-27 11:02:45 +00:00
Gregory P. Smith 3bbdc8e822 Issue #14123: Explicitly mention that old style % string formatting has caveats
but is not going away any time soon.
2012-02-26 01:54:07 -08:00
Éric Araujo f527277b67 Branch merge 2012-02-26 04:00:43 +01:00
Éric Araujo a6091998af Use const markup instead of a misleading string literal 2012-02-26 02:13:30 +01:00
Ezio Melotti 4342722f40 #14114: don't include copybutton.js in the htmlhelp output. 2012-02-25 19:24:24 +02:00
Georg Brandl e578021696 Add 3.2.3 to license. 2012-02-23 21:19:18 +01:00
Georg Brandl eb25fb7af7 Fix markup errors. 2012-02-23 21:12:39 +01:00
Georg Brandl 7ef825fdab merge with 3.2 2012-02-21 22:36:37 +01:00
Georg Brandl c9a42070a6 Remove reST markup from --help output. Also: O(n**2) is dict construction, not single insertion. 2012-02-21 22:36:27 +01:00
Georg Brandl 09a7c72cad Merge from 3.1: Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
in order to make algorithmic complexity attacks on (e.g.) web apps much more complicated.

The environment variable PYTHONHASHSEED and the new command line flag -R control this
behavior.
2012-02-20 21:31:46 +01:00
Georg Brandl 2daf6ae249 Issue #13703: add a way to randomize the hash values of basic types (str, bytes, datetime)
in order to make algorithmic complexity attacks on (e.g.) web apps much more complicated.

The environment variable PYTHONHASHSEED and the new command line flag -R control this
behavior.
2012-02-20 19:54:16 +01:00
Vinay Sajip fee358b0df logging: clarified documentation for Handler.handleError. 2012-02-20 18:35:26 +00:00
Éric Araujo c3ef037ee1 Add missing “::” markup.
Also wrap two looong lines.
2012-02-20 01:44:55 +01:00