Commit Graph

16247 Commits

Author SHA1 Message Date
Victor Stinner c520edc08b asyncio doc: add an client example using streams 2014-01-23 11:25:48 +01:00
Victor Stinner 24f8ebf4c5 asyncio doc: Move streams to their own dedicated page 2014-01-23 11:05:01 +01:00
Victor Stinner c8ea81330c asyncio doc: link create_connection() to open_connection() and create_server()
to start_server()

Rename also the "Network functions" section to "Stream functions" and move it to the Stream section.
2014-01-23 11:02:09 +01:00
Victor Stinner 7235c05085 asyncio doc: move stream classes to their own class 2014-01-23 10:54:57 +01:00
Victor Stinner 3eb45d3eae asyncio: Fix open_connection() documentation, writer is a StreamWriter 2014-01-23 10:20:18 +01:00
Larry Hastings 42d9e1b9f3 Doc fixes for Argument Clinic. 2014-01-22 05:49:11 -08:00
R David Murray f1e4fdcf16 whatsnew: smtpd *map* argument, new ssl functions/methods.
Fleshed out Christian's placeholder for the new ssl methods.
2014-01-21 18:30:42 -05:00
Zachary Ware 5116f78221 Issue #20301: Merge with 3.3 2014-01-21 13:50:13 -06:00
Zachary Ware f7d2874d30 Issue #20301: Mention the correct KEY_* value as the default
for 'access' in winreg.DeleteKeyEx.  Already correct in the docs
function signature and docstring.  Noticed by Justin Foo.
2014-01-21 13:49:22 -06:00
Georg Brandl 2866c6a2a1 merge with 3.3 2014-01-21 19:20:58 +01:00
Georg Brandl 7ed509a38f fix deprecated-removed directive with sphinx 1.2 2014-01-21 19:20:31 +01:00
Terry Jan Reedy a67a79da24 Merge with 3.3 2014-01-21 00:02:17 -05:00
Terry Jan Reedy 30ffe7eb68 Issue #20222: file is no longer a builtin in 3.x. 2014-01-21 00:01:51 -05:00
Antoine Pitrou b6457249bf Fix the description of pickle protocol numbers 2014-01-21 02:39:54 +01:00
Eli Bendersky 679688e70d Fix grammar and add markup 2014-01-20 08:13:31 -08:00
Eli Bendersky 3245e79b82 Formatting & rst link markup fixes 2014-01-20 07:51:31 -08:00
Eli Bendersky 029981bbfc Clarify what the loop arguments means for functions listed in 18.5.2.5 2014-01-20 07:02:22 -08:00
Eli Bendersky 2d26af82c1 Explain the 'result' argument in asyncio.sleep 2014-01-20 06:59:23 -08:00
Gregory P. Smith 5a6d4bf671 Fixes Issue #20165: The unittest module no longer considers tests marked with
@expectedFailure successful if they pass.
2014-01-20 01:11:18 -08:00
Benjamin Peterson 27b490c713 merge 3.3 (#6627) 2014-01-20 00:12:24 -05:00
Benjamin Peterson 1cfe009b96 put notes in a ..note section 2014-01-20 00:10:23 -05:00
Benjamin Peterson f6ffb4b264 document that a new Python thread context is created in ctypes callbacks (closes #6627)
Patch by Nikolaus Rath.
2014-01-20 00:09:53 -05:00
Larry Hastings b7ccb20423 Issue #20294: Argument Clinic now supports argument parsing for __new__ and
__init__ functions.
2014-01-18 23:50:21 -08:00
Benjamin Peterson dc3cce077d merge 3.3 (#17811) 2014-01-18 22:57:05 -05:00
Benjamin Peterson e83ed43281 improve description of buffers argument for readv/writev (closes #17811)
Patch by Nikolaus Rath.
2014-01-18 22:54:59 -05:00
Larry Hastings 537d760766 Doc improvements for Clinic howto "Goals" section. 2014-01-18 01:08:50 -08:00
Benjamin Peterson 3c16c1d821 merge 3.3 2014-01-18 00:49:30 -05:00
Benjamin Peterson af69fe2311 rm extra whitespace 2014-01-18 00:49:04 -05:00
Benjamin Peterson 9308c420d3 merge 3.3 2014-01-18 00:47:06 -05:00
Benjamin Peterson eacec1ccff link to builtin open not io.open 2014-01-18 00:47:00 -05:00
Benjamin Peterson d8af6700b9 merge 3.3 (#17814) 2014-01-18 00:46:49 -05:00
Benjamin Peterson 3d8814e1d3 describe type of Popen streams (closes #17814)
Patch more or less by Nikolaus Rath.
2014-01-18 00:45:56 -05:00
Larry Hastings bebf73511a Issue #20287: Argument Clinic's output is now configurable, allowing
delaying its output or even redirecting it to a separate file.
2014-01-17 17:47:17 -08:00
Zachary Ware 601d366844 Issue #20265: Merge with 3.3 2014-01-17 15:24:18 -06:00
Zachary Ware c3cf97b4ea Issue #20265: Updated some parts of the Using Windows document.
Includes:
-mention cx_Freeze instead of py2exe (at least until py2exe supports Python 3)
-update ActivePython link
-Remove mention of platforms that were never supported by Python 3 (Win9x, DOS)
2014-01-17 15:23:42 -06:00
Vinay Sajip 5714e815c9 Merged documentation update from 3.3. 2014-01-17 18:36:41 +00:00
Vinay Sajip eb14deca15 Added example to recently added cookbook entry. 2014-01-17 18:36:02 +00:00
Brett Cannon 24f60b4616 Issues #20194,20195: Add missing :deprecated: markers to some module
docs.
2014-01-17 12:06:28 -05:00
Brett Cannon f0996a9970 Issue #20208: Clarify some things in the Python porting HOWTO.
Thanks to Rodrigo Bernardo Pimentel, Ondřej Čertík, and Dmitry
Shachnev for the feedback leading to the changes.
2014-01-17 11:45:01 -05:00
Brett Cannon c089f70b54 Issue #18394: Document that cgi.FieldStorage now cleans up after its
'file' attribute properly in Python 3.4.

Thanks to Marcel Hellkamp for pointing out the oversight.
2014-01-17 11:03:19 -05:00
Zachary Ware 77007344d9 Issue #20266: Merge with 3.3 2014-01-17 09:00:36 -06:00
Zachary Ware 9fc0e9955d Issue #20266: Update parts of the Windows FAQ 2014-01-17 08:59:44 -06:00
Victor Stinner 9731183390 asyncio: oops, add missing word :-) 2014-01-17 10:31:02 +01:00
Larry Hastings 2a727916c5 Issue #20226: Major improvements to Argument Clinic.
* You may now specify an expression as the default value for a
  parameter!  Example: "sys.maxsize - 1".  This support is
  intentionally quite limited; you may only use values that
  can be represented as static C values.
* Removed "doc_default", simplified support for "c_default"
  and "py_default".  (I'm not sure we still even need
  "py_default", but I'm leaving it in for now in case a
  use presents itself.)
* Parameter lines support a trailing '\\' as a line
  continuation character, allowing you to break up long lines.
* The argument parsing code generated when supporting optional
  groups now uses PyTuple_GET_SIZE instead of PyTuple_GetSize,
  leading to a 850% speedup in parsing.  (Just kidding, this
  is an unmeasurable difference.)
* A bugfix for the recent regression where the generated
  prototype from pydoc for builtins would be littered with
  unreadable "=<object ...>"" default values for parameters
  that had no default value.
* Converted some asserts into proper failure messages.
* Many doc improvements and fixes.
2014-01-16 11:32:01 -08:00
Victor Stinner 59759ff234 asyncio doc: replace "coroutine" with "coroutine object" or "coroutine function" 2014-01-16 19:30:21 +01:00
Victor Stinner db39a0da0c asyncio: add a new "Develop with asyncio" section to the documentation 2014-01-16 18:58:01 +01:00
Benjamin Peterson 5cacb84d83 merge 3.3 (#20272) 2014-01-16 10:10:26 -05:00
Benjamin Peterson 2989f587a7 linkify chain.from_iterable (closes #20272) 2014-01-16 10:10:13 -05:00
Benjamin Peterson a65d121607 merge 3.3 (#20278) 2014-01-16 09:53:22 -05:00
Benjamin Peterson 216e47d834 update pysqlite website (closes #20278) 2014-01-16 09:52:38 -05:00
Vinay Sajip 3763f2bc07 Merged documentation update from 3.3. 2014-01-15 15:09:43 +00:00
Vinay Sajip cbefe3b9a0 Added cookbook entry on alternative formatting styles. 2014-01-15 15:09:05 +00:00
Vinay Sajip 6ed2893aae Merged documentation update from 3.3. 2014-01-15 13:29:24 +00:00
Vinay Sajip 350e623623 Clarified documentation note on module-level convenience functions. 2014-01-15 13:28:39 +00:00
Ronald Oussoren 6db6653bbc Issue #14455: Fix some issues with plistlib
* Negative integer support in binary plists was broken

* Better exception for invalid data

* Fix the versionadded/versionchanged markup in the documentation

* Add the interface cleanup to what's new for 3.4
2014-01-15 11:32:35 +01:00
Larry Hastings 4a714d48ad Issue #20268: Argument Clinic now supports cloning the parameters
and return converter from existing functions.
2014-01-14 22:22:41 -08:00
Zachary Ware af029de7b0 Issue #20255: Update the about and bugs pages. 2014-01-14 16:03:51 -06:00
Zachary Ware 71337cb281 Issue #20255: Update the about and bugs pages. 2014-01-14 16:03:11 -06:00
Zachary Ware 5c15424aa9 Closes #20253: Merge typo fix 2014-01-14 09:10:33 -06:00
Zachary Ware 9774ce0cab Issue #20253: Fixed a typo in the ipaddress docs that advertised an
illegal attribute name.  Found by INADA Naoki.
2014-01-14 09:09:48 -06:00
Zachary Ware 1bef5c6cc8 Merge typo fix. 2014-01-14 08:45:38 -06:00
Zachary Ware 26d5fab8c8 Fix typo. Found by David Pesta on docs@. 2014-01-14 08:44:49 -06:00
Zachary Ware f6cb6c5e11 Merge typo fix. 2014-01-14 08:41:41 -06:00
Zachary Ware 2d13036769 Fix typo. Found by David Pesta on docs@. 2014-01-14 08:40:53 -06:00
Georg Brandl 92b7adb60d merge 2014-01-14 12:27:44 +01:00
Georg Brandl 738cb60f65 merge with 3.3 2014-01-14 12:27:21 +01:00
Georg Brandl 8bd656ddb8 Closes #20258: Sphinx toolchain: move back to Jinja2 2.3.1 with support for Py2.5. 2014-01-14 12:00:45 +01:00
Zachary Ware e74f96ded5 Merge typo fix. 2014-01-13 20:39:21 -06:00
Zachary Ware 80602e0e1b Fix typo. 2014-01-13 20:38:57 -06:00
Zachary Ware 335957e087 Correct a typo. Found by Lauri Hakko on docs@. 2014-01-13 16:08:54 -06:00
R David Murray 75ff6d284a Merge #20236: Fix sphinx markup. 2014-01-13 13:51:42 -05:00
R David Murray 66c9350a89 #20236: Fix sphinx markup. 2014-01-13 13:51:17 -05:00
Senthil Kumaran 95be7ff911 merge from 3.3
Issue #19082: Working xmlrpc.server and xmlrpc.client examples. Both in modules and in documentation.
2014-01-12 16:07:59 -08:00
Senthil Kumaran 939e2db48d Issue #19082: Working xmlrpc.server and xmlrpc.client examples. Both in modules and in documentation. 2014-01-12 16:06:58 -08:00
Larry Hastings 0191be3899 Minor doc fix in Clinic howto. 2014-01-12 13:57:36 -08:00
Larry Hastings 4a55fc5a9d Issue #20214: Fixed a number of small issues and documentation errors in
Argument Clinic (see issue for details).
2014-01-12 11:09:57 -08:00
Georg Brandl 632c812942 small grammar fix. 2014-01-12 18:03:12 +01:00
Georg Brandl 57bc1e21e7 merge with 3.3 2014-01-12 08:10:52 +01:00
Georg Brandl 6392ad98d0 Doc: update Sphinx toolchain also in make.bat 2014-01-12 08:09:01 +01:00
Georg Brandl 932c3458df Merge with 3.3 2014-01-11 20:04:29 +01:00
Georg Brandl 5636eb7b93 Update Sphinx toolchain. 2014-01-11 20:04:19 +01:00
Georg Brandl fa5a765506 Fix minor markup bug: sub-toctrees should not have :numbered: 2014-01-11 19:52:17 +01:00
Zachary Ware c1cb227b3f Closes #20200: Argument Clinic custom converter example should be in a
'python' clinic block, not a 'clinic' clinic block.  Patch written by
Ryan Smith-Roberts.
2014-01-09 21:41:23 -06:00
R David Murray 0ae7ae1fc9 whatsnew: InspectLoader.get_code now concrete, b32decode raises binascii.Error.
And a news item rephrase.
2014-01-08 18:16:02 -05:00
R David Murray fdc58fd897 Merge: Fix verb tense in base64 docs, and the phrasing of a news entry. 2014-01-08 18:14:20 -05:00
R David Murray 78ee3289e9 Fix verb tense in base64 docs, and the phrasing of a news entry. 2014-01-08 18:09:29 -05:00
R David Murray 66bf12a58e whatsnew: FileIO.readall performance, os.cpu_count.
And more news item tweaks.
2014-01-08 17:21:22 -05:00
Brett Cannon 8d942296bb Issue #19719: Update various finder and loader ABCs such that their
old methods now provide implementations when PEP 451 APIs are present.

This should help with backwards-compatibility with code which has not
been updated to work with PEP 451.
2014-01-07 15:52:42 -05:00
Larry Hastings 61272b77b0 Issue #19273: The marker comments Argument Clinic uses have been changed
to improve readability.
2014-01-07 12:41:53 -08:00
Larry Hastings 77561cccb2 Issue #20141: Improved Argument Clinic's support for the PyArg_Parse "O!"
format unit.
2014-01-07 12:13:13 -08:00
R David Murray 0bce6e7462 whatsnew: expand 'dis' entry.
Also add one missing versionadded.
2014-01-07 14:30:17 -05:00
Brett Cannon 9ca21b3e1d Issue #20096: Update the Python 2/3 porting HOWTO to focus on
source-compatibility instead of 2to3.
2014-01-07 11:52:04 -05:00
R David Murray a101bdb88c whatsnew: ssl getpeercert/do_handshake raise OSError, weakref __callback__.
Also add a missing word to gc entry, and delete a now-obsolete doc note
in the weakref __callback__ docs.  (Opened an issue for rewriting
the section that compares finalizers and __del__ method.)
2014-01-06 16:32:05 -05:00
R David Murray 9835827593 whatsnew: pydoc.Scanner removal, check_output input parm, operator.py.
Also fleshed out the entry on struct.iter_unpack.
2014-01-05 20:52:06 -05:00
Larry Hastings b7f5dcadf2 Merge 3.4.0b2 release revisions back into mainline. 2014-01-06 07:24:19 -08:00
Ethan Furman df3ed242c0 Issue19995: %o, %x, %X now only accept ints 2014-01-05 06:50:30 -08:00
Larry Hastings bfd715ebd1 Regenerated pydoc/topics.py, and fix a "suspicious" doc error. 2014-01-05 04:35:56 -08:00
Larry Hastings 6d2ea21337 Argument Clinic: fixed test suite, improved howto. 2014-01-05 02:50:45 -08:00
R David Murray 410d320703 whatsnew: XMLPullParser, plus some doc updates.
I was confused by the text saying that read_events "iterated", since it
actually returns an iterator (that's what a generator does) that the
caller must then iterate.  So I tidied up the language.  I'm not sure
what the sentence "Events provided in a previous call to read_events()
will not be yielded again." is trying to convey, so I didn't try to fix that.

Also fixed a couple more news items.
2014-01-04 23:52:50 -05:00
R David Murray 244ad600e9 whatsnew: removal of TYPE_INT64 from marshal.
Also update news entry for SMTPException; when I changed it from
IOError to OSError I forgot to update the news item.
2014-01-04 21:17:52 -05:00
R David Murray 9cf617bff9 whatsnew: logging TimedRotatingFileHandler atTime parameter. 2014-01-04 18:55:01 -05:00
R David Murray 4908f4a151 whatsnew: from __future__ string exception, attribute UTF-32 decoder speedup.
And more news entry clarifications.
2014-01-04 18:07:20 -05:00
R David Murray b231b2be07 whatsnew: ppring string wrapping, string pickling optimization.
Also clarify some NEWS entries.
2014-01-04 17:11:23 -05:00
R David Murray 57fcf76d73 whatsnew: Mock mock_open readline(s); expand description of subtests feature. 2014-01-03 23:31:54 -05:00
Serhiy Storchaka 78194cd4e9 Merge heads 2014-01-04 22:49:40 +02:00
Larry Hastings 78cf85c669 Issue #19659: Added documentation for Argument Clinic. 2014-01-04 12:44:57 -08:00
Serhiy Storchaka 3079328d29 Reverted changeset b72c5573c5e7 (issue #15027). 2014-01-04 22:44:01 +02:00
Serhiy Storchaka 583a93943c Issue #15027: Rewrite the UTF-32 encoder. It is now 1.6x to 3.5x faster. 2014-01-04 19:25:37 +02:00
R David Murray e608255328 whatsnew: consistently use 3 blanks between major sections. 2 for minor. 2014-01-03 16:15:45 -05:00
R David Murray 59171722f0 whatsnew: make bullet list presentation style consistent. 2014-01-03 15:52:22 -05:00
R David Murray db085f56b9 whatsnew: unittest discovery sorting, urlllib Request getter/setter removals. 2014-01-03 15:46:24 -05:00
R David Murray a2924cabaf whatsnew: porting note for HTTP[S]Connection strict parameter removal.
It was discussed in issue #17460 whether or not to make the remaining
arguments keyword only so that things would fail noisily if someone was still
using positional parameters, but no decision was made and we are now well past
the Beta API change deadline.
2014-01-03 14:06:01 -05:00
R David Murray 0056936a4b whatsnew: deprecation of HTTPConnection's strict parameter. 2014-01-03 13:04:25 -05:00
R David Murray 42fa110035 whatsnew: unittest import time SkipTest reported as skip not error. 2014-01-03 13:03:36 -05:00
R David Murray a475a8d313 whatsnew: http.server send_error explain parameter.
Also rewrote the send_error description for clarity and correct English.
2014-01-03 13:03:00 -05:00
Martin v. Löwis 24e43308b7 * Issue #16113: Remove sha3 module again.
Patch by Christian Heimes, with modifications.
2014-01-03 14:05:06 +01:00
Benjamin Peterson 002033ed63 correct word for __annotations__ doc (closes #20110)
Patch from Claudiu Popa.
2014-01-02 16:47:50 -06:00
R David Murray 12e930f3a4 #17282: Document unittest.main defaultTest argument. 2014-01-02 13:37:26 -05:00
Benjamin Peterson 3a990c69b8 remove brackets 2014-01-02 12:22:30 -06:00
Benjamin Peterson 8ec15f7a92 merge 3.3 (#20110) 2014-01-02 16:48:24 -06:00
R David Murray 9025f1c5c4 whatsnew: sqlite3 uri parm, unittest.main defaultTest, ftplib.Netrc deprecation 2014-01-02 13:44:18 -05:00
R David Murray 6e731b0a41 Merge and update #17282: Document unittest.main defaultTest argument.
In 3.4 defaultTest can also be a list (see issue 15132).
2014-01-02 13:43:02 -05:00
Benjamin Peterson c22eaecd53 merge 3.3 (closes #20108) 2014-01-02 12:26:50 -06:00
Benjamin Peterson a015bb1e2b merge 3.3 2013-12-31 22:02:41 -06:00
Benjamin Peterson fa10ae0978 update copyright year 2013-12-31 22:02:22 -06:00
R David Murray 33ef1aeb1e whatsnew: mock called_with improvements, socket CAN_BCM support.
Also reworded the other entries in the socket section of whatsnew, as
well as a couple of unrelated news entries.
2013-12-31 16:04:50 -05:00
R David Murray 8b2d68245e whatsnew: random.getrandbits performance.
Also fix a NEWS file issue number error, and some spacing fixes in whatsnew.
2013-12-31 15:06:05 -05:00
R David Murray d592bb2dc4 whatsnew: afic.open supports 'with'. 2013-12-31 13:45:38 -05:00
Zachary Ware 1cb4f607d1 Merge with 3.3 2013-12-31 12:10:24 -06:00
Zachary Ware 340a692283 str subclasses may have non-empty __slots__, bytes subclasses can't. 2013-12-31 12:09:26 -06:00
R David Murray fced3ec2db whatsnew: argparse FileType accepts errors and encodings args. 2013-12-31 11:18:01 -05:00
R David Murray 2bc930f044 whatsnew: epoll supports with.
Also reworded the description of the feature in the docs.
2013-12-31 11:17:21 -05:00
Christian Heimes f598558afb Fixed typo (thx Arfrever) 2013-12-30 09:33:46 +01:00
Michael Foord 4d1639f4e5 Closes issue 20031. Document unittest.TextTestRunner.run method. 2013-12-29 23:38:55 +00:00
R David Murray 2691ee6183 whatsnew: abc.ABC. Also add issue number to news entry and reword. 2013-12-28 23:15:12 -05:00
Antoine Pitrou 3e86ba4e32 Issue #19422: Explicitly disallow non-SOCK_STREAM sockets in the ssl module, rather than silently let them emit clear text data. 2013-12-28 17:26:33 +01:00
Antoine Pitrou e6d2f159fc Issue #19422: Explicitly disallow non-SOCK_STREAM sockets in the ssl module, rather than silently let them emit clear text data. 2013-12-28 17:30:51 +01:00
R David Murray 473f45b4bc whatsnew: rewrite urllib, doctest, and poplib sections.
Also collapse redundant versionadded/versionchanged markup in
poplib.stls entry.
2013-12-27 17:01:16 -05:00
R David Murray d26538163e whatsnew: importlib cleanup and source_to_code add; python partial impl. 2013-12-27 14:06:15 -05:00
R David Murray 0e814634e5 whatsnew for gc.get_stats, plus doc tweaks.
Clarified the "At the moment" wording, and added the get_stats entry in the
module summary that Serhiy noted was missing at the end of issue 16351.

Given that pydoc lists all the function docstrings, I'm not sure that module
summary section is actually needed; but, it is probably better to address that
when the module is converted to use Argument Clinic.  In the meantime we
should keep the list complete.
2013-12-26 15:11:28 -05:00
R David Murray 575fb31955 shelf in with stmt, fish/csh in venv, ElementTree short_empty_elements keyword.
Also added versionadded for for fish/csh, fixed indentation of versionadded
for ElementTree.write, and make the behavior of shelf as a context manager
explicit in the docs.
2013-12-25 23:21:03 -05:00
R David Murray 6e39015f61 pty.spawn returns os.waitpid; optimization of BZ2File and LZMAFile. 2013-12-24 22:28:04 -05:00
R David Murray 3edcc7832e #16832: s/integer/object/ in docs/docstring, and add whatsnew entry. 2013-12-24 16:13:32 -05:00
R David Murray 5ea95249d5 idle -n deprecation, fix case of pickle section. 2013-12-24 15:59:57 -05:00
R David Murray d74d09ab4a Neaten up structure of major sections.
Also move tick_counter from deprecated section to removed section.
2013-12-24 15:33:02 -05:00
R David Murray 076deadd81 Move no-longer-supported operating systems into 'removed' section. 2013-12-24 14:59:50 -05:00
R David Murray e7cf678ad2 Use title case for all section titles except module names. 2013-12-24 14:51:25 -05:00
R David Murray d17aba7139 sys.getallocatedblocks + regrtest -R, make coverage-report, SO macro goes away. 2013-12-24 14:46:23 -05:00
R David Murray 061efb175f Use endash in PEP callouts.
Despite Serhiy's suggestion in issue18529, the emdash just looks
too long to me, at least in my browser.  This usage case is sort
of halfway between endash (connective) and emdash (pause/separator).
2013-12-24 12:35:59 -05:00
R David Murray 6dd1830c25 Move argument clinic into its own section, like the other PEPs. 2013-12-24 12:23:56 -05:00
R David Murray d91ba206a2 Mention Windows 2000 and OS/2 drops, python-config as shell script. 2013-12-24 12:13:44 -05:00
R David Murray 72420ff3ce Mention PATHEXT and removed Misc dirs; clarify wording of a NEWS entry. 2013-12-24 10:46:44 -05:00
Serhiy Storchaka f47036c130 Removed spaces before colons and semicolons. 2013-12-24 11:04:36 +02:00
R David Murray 347f9c7457 Make the 'read on' sentence cover more ground. 2013-12-23 21:30:06 -05:00
R David Murray bcaaecfe1e Move other improvements and optimization sections above deprecated.
This arrangement means the sections that have summaries come
first, and everything else comes after those.
2013-12-23 21:23:36 -05:00
R David Murray 4d48f2a6e7 Collapse 'python invocation changes' into 'other improvements'. 2013-12-23 21:21:09 -05:00
R David Murray 9217dadd12 Link new module summary entries to their description sections. 2013-12-23 21:08:28 -05:00
Serhiy Storchaka 89e84e7523 Removed spaces before colons and semicolons. 2013-12-24 11:05:24 +02:00
Serhiy Storchaka a4d170d985 Removed spaces before commas and periods. 2013-12-23 18:20:51 +02:00
R David Murray 68790662fc Add pep 435 summary entry in new required features, and ensurepip description.
Also added a note about platform packagers not being required to install
pip by default, if they provide an appropriate pip hook, to the PEP
description section.
2013-12-23 11:17:51 -05:00
R David Murray f9976e7254 Add link to selectors description from its summary line. 2013-12-23 10:32:02 -05:00
R David Murray 8d85678d5c Make summary entry format consistent (always end with pep or issue in parens). 2013-12-23 10:28:57 -05:00
Serhiy Storchaka 2a6145290b Removed spaces before commas and periods. 2013-12-23 18:21:57 +02:00
Nick Coghlan 6256fcbc97 Close #19734: ignore pip env vars in ensurepip 2013-12-23 16:16:07 +10:00
R David Murray 3f122d6f44 Mention deprecation and porting sections in intro. 2013-12-22 21:09:16 -05:00
R David Murray f85b2a8dc7 Reflow 'modulespec' paragraphs. 2013-12-22 21:06:13 -05:00
R David Murray e9b74d45d3 Make mailing list thread reference an inline link, reword i.e. abbreviation. 2013-12-22 21:05:04 -05:00
R David Murray 809487e5f5 Make the organization of the body and the summary have parallel structure.
This means I moved the 'new expected features' section to the top of the
summary, and made a new section with the same name at the start of
the body, turning the previous top level sections there into subsections.

I also added a line to the new first summary section for modulespec (pep 451).
2013-12-22 20:49:40 -05:00
R David Murray 8f7664ab15 Add description of marshal changes. 2013-12-22 20:40:11 -05:00
R David Murray a93ca971a5 Be consistent in how PEPs are referenced throughout the summary section. 2013-12-22 14:10:21 -05:00
R David Murray ca7946193f Rewrite module-globals summary entry, and expand the full description a bit. 2013-12-22 14:05:11 -05:00
R David Murray 2aa9d52ed2 Make argument clinic summary entry parallel to other PEP entries.
The existing entry repeated the same info that was in the body text, which
means it didn't satisfy the sections "brevity" requirement :)
2013-12-22 13:57:45 -05:00
Antoine Pitrou a936c40ede s/lightweight/minimal/, as per issue #11379. 2013-12-22 01:57:45 +01:00
Antoine Pitrou f20ea13996 s/lightweight/minimal/, as per issue #11379. 2013-12-22 01:57:01 +01:00
R David Murray c16dfe1837 Make CPython PEP summary entry links consistent, add pep 456 discussion. 2013-12-21 12:32:10 -05:00
Christian Heimes af01f66817 Issue #16136: Remove VMS support and VMS-related code 2013-12-21 16:19:10 +01:00
R David Murray 26b80cfde0 Add link from email summary entry to entry in changed module section. 2013-12-20 17:26:52 -05:00
R David Murray ac18622126 Add links to discussion of multiprocessing spawn/forkserver feature. 2013-12-20 17:23:57 -05:00
R David Murray 748bad2cd0 Tidy up ssl whatsnew references, make ssl section formatting consistent.
Also remove some extra blank lines in the ssl doc acctions for tls1.1/1.2,
and reflow a paragraph.
2013-12-20 17:08:39 -05:00
R David Murray c054040f86 Add link from pickle protocol 4 in summary to the section about it. 2013-12-20 16:38:09 -05:00
R David Murray cde1a06a54 Include sha3 addition in hashlib section of whatsnew.
And link to it from the summary, and link to the Hash Algorithms
section of hashlib from the linked description.
2013-12-20 16:33:52 -05:00
R David Murray a17e0d873a No need for single para descriptions to have separate contributed by para. 2013-12-20 16:12:28 -05:00
R David Murray e0f7a78877 whatsnew: s/no new syntax features planned/no new syntax features added/ 2013-12-20 16:04:29 -05:00
R David Murray 0a1021661f Fix spelling error in single dispatch whatsnew summary, and add link. 2013-12-20 15:00:54 -05:00
R David Murray f9909c27df Make the 'PEP 446' string link to the PEP in whatsnew new feature description.
I also further qualified the cross reference link, since those are
global names.
2013-12-20 14:50:12 -05:00
R David Murray 6d5cb07382 Move versionadded for tracemalloc into the standard location (right after title) 2013-12-20 14:48:50 -05:00
R David Murray 43ad138160 Move versionadded for ensurepip into the standard location (right after title) 2013-12-20 14:40:11 -05:00
R David Murray 6a14381530 Fix Sphinx markup for asyncio modules so :mod:`asyncio` links work. 2013-12-20 14:37:39 -05:00
R David Murray fd1ff1c888 Add versionadded to enum docs. 2013-12-20 14:20:49 -05:00
R David Murray 6adb4543fc Add email package to whatsnew list of significantly improved stdlib modules. 2013-12-20 13:10:43 -05:00
Vinay Sajip f468d5b259 Closes #19902: Merged update from 3.3. 2013-12-19 11:51:19 +00:00
Vinay Sajip 800e11b406 Issue #19902: Added list of logging levels. 2013-12-19 11:50:24 +00:00
Zachary Ware e61f4df275 Closes #20005: Fix typo in operator docs. Patch by Claudiu Popa. 2013-12-18 12:22:35 -06:00
Zachary Ware 0bffca006a Issue #20005: Fix typo in operator docs. Patch by Claudiu Popa. 2013-12-18 12:21:49 -06:00
Nick Coghlan 9a76735b1d Close #19946: use runpy as needed in multiprocessing
- handles main files without a suffix
- handles main submodules properly
- adds test cases for the various kinds of __main__
2013-12-17 22:17:26 +10:00
Eric Snow 7cff4cd7e9 Issue #19713: Fix mistakes in the import page of language reference.
These mistakes were introduced by the initial PEP 451 merge.
2013-12-16 23:10:50 -07:00
Eric Snow ca2d854df8 Issue #19713: Update importlib docs for module spec changes, including deprecations. 2013-12-16 23:06:52 -07:00
Eli Bendersky 5100311bd8 Issue #20001: Add the SVG source of the pathlib-inheritance diagram to Hg 2013-12-16 21:13:40 -08:00
Victor Stinner 1d006a2c0e Backout a1a05e2724dd: shutil.which(bytes) is a new feature and my patch does not work on Windows 2013-12-16 23:39:40 +01:00
Victor Stinner fffb96ba66 Issue #18283: shutil.which() now supports bytes argument, not only text argument. 2013-12-16 22:48:48 +01:00
Antoine Pitrou f6abb70b48 Mention specific exceptions instead of OSError where appropriate. 2013-12-16 21:00:53 +01:00
Antoine Pitrou 0048c98fef Issue #19921: When Path.mkdir() is called with parents=True, any missing parent is created with the default permissions, ignoring the mode argument (mimicking the POSIX "mkdir -p" command).
Patch by Serhiy.
2013-12-16 20:22:37 +01:00
Nick Coghlan 720c7e28cb Issue #19700: set __spec__ appropriately in runpy
Note that __spec__.name is not currently guaranteed to be in
sys.modules when the code is running, only __name__ is.

The "running module is in sys.modules" invariant will be
expanded to also cover __spec__.name in a subsequent patch.
2013-12-15 20:33:02 +10:00
R David Murray 530a69fafc #19970: fix additional typo in 3.4 asyncio docs. 2013-12-14 11:26:06 -05:00
Ezio Melotti 66f8518acb #19981: merge with 3.3. 2013-12-14 12:43:08 +02:00
Ezio Melotti 956040a7cc #19981: fix typo in email.mailbox docs. Patch by Claudiu Popa. 2013-12-14 12:42:29 +02:00
Brett Cannon 706a7296d7 merge for issue #19963 2013-12-13 13:58:47 -05:00
Brett Cannon 98620d87f2 Issue #19963: Document that importlib.import_module() will import
parent packages automatically.
2013-12-13 13:57:41 -05:00
R David Murray 18701160cc Merge: #18036: update .pyc FAQ entry in light of PEP 3147. 2013-12-13 12:30:29 -05:00
R David Murray d913d9d54e #18036: update .pyc FAQ entry in light of PEP 3147.
Initial patch by Phil Connell.
2013-12-13 12:29:29 -05:00
Victor Stinner 774b2e0af2 Issue #14432: Document the removal of the PyFrameObject.f_tstate field 2013-12-13 14:33:01 +01:00
Victor Stinner 86e139ad65 asyncio doc: explain where does the task come from. 2013-12-13 12:51:24 +01:00
Victor Stinner 68bccb4922 asyncio doc: change style of the sequence diagram to focus on the control flow 2013-12-13 12:47:39 +01:00
Victor Stinner 2748bc735e asyncio: remove references to the Tulip project, rename Tulip to asyncio.
Patch written by Vajrasky Kok.
2013-12-13 10:57:04 +01:00
Victor Stinner 441adb8c57 Backout changeset 46393019b650
test_capi is failing and the fix is not trivial, I prefer to revert
2013-12-13 04:14:41 +01:00
Victor Stinner cd0cb8ccd3 Close #19787: PyThread_set_key_value() now always set the value. In Python 3.3,
the function did nothing if the key already exists (if the current value is a
non-NULL pointer).

_testcapi.run_in_subinterp() now correctly sets the new Python thread state of
the current thread when a subinterpreter is created.
2013-12-13 03:22:00 +01:00
Victor Stinner 1c4b892d71 Add a sequence diagram for the chained coroutines example 2013-12-12 12:35:17 +01:00
R David Murray 50bfbb9903 #19063: fix set_payload handling of non-ASCII string input.
This version of the fix raises an error instead of accepting the invalid
input (ie: if a non-ASCII string is used but no charset is specified).
2013-12-11 16:52:11 -05:00
Eric Snow b282b3d804 Issue #18864: Add a setter for ModuleSpec.has_location. 2013-12-10 22:16:41 -07:00
Nick Coghlan 1f609e9b02 Issue #19407: merge PPUG notes from 3.3 2013-12-10 21:31:14 +10:00
Nick Coghlan b5c4fd0a96 Issue #19407: add Python Packaging User Guide notes
The stdlib docs for package distribution and building extensions
are rather dated, and that isn't expected to change for 2.7 and
3.3.

The Python Packaging User Guide isn't complete either, but it's
already a much better road map for new users than the existing
stdlib docs.
2013-12-10 21:24:55 +10:00
Victor Stinner a6fa15367f asyncio doc: simplify task example 2013-12-10 12:20:14 +01:00
Victor Stinner 0839ed4730 asyncio doc: don't document Task.cancel(), already documented in Future.cancel() 2013-12-10 12:18:15 +01:00
Victor Stinner 742520be43 asyncio: document Task.current_task() 2013-12-10 12:14:50 +01:00
Victor Stinner fc25d629ab asyncio: don't document private functions 2013-12-10 02:52:49 +01:00
Victor Stinner 34f2946a11 asyncio: fix 2nd task example 2013-12-10 02:51:05 +01:00
Victor Stinner dbd8950b28 asyncio doc: rewrite the callback hello world to use call_soon() instead of a
direct call.
2013-12-10 02:47:22 +01:00
Victor Stinner b69d62dcac assyncio doc: rewrite, improve and move coroutine, Future and Task examples 2013-12-10 02:09:46 +01:00
Stefan Krah 29e64548c5 Fix typo. 2013-12-09 19:18:59 +01:00
Stefan Krah 345ec35da3 Fix whitespace. 2013-12-09 19:11:05 +01:00
Stefan Krah 2d181de44c Merge 3.3. 2013-12-09 19:03:24 +01:00
Victor Stinner a881a7f205 asyncio doc: explain why the loop is running twice 2013-12-09 13:19:23 +01:00
Victor Stinner d8f11e9265 asyncio: another Future example using add_done_callback() 2013-12-09 13:04:12 +01:00
Victor Stinner 45c2fd9f8a asyncio doc: add an example with Future 2013-12-09 12:40:17 +01:00
Stefan Krah 1761fa9dd1 Add libmpdec license. 2013-12-08 20:54:02 +01:00
Nadeem Vawda bd6932a576 Closes #18430: Document that peek() may change the position of the underlying
file for the BZ2File, GzipFile and LZMAFile classes.
2013-12-08 19:50:05 +01:00
Nadeem Vawda 6976104a36 #18430: Document that peek() may change the position of the underlying file for
the BZ2File, GzipFile and LZMAFile classes.
2013-12-08 19:47:22 +01:00
doko@ubuntu.com ca616a2709 - Issue #19736: Add module-level statvfs constants defined for GNU/glibc
based systems.
2013-12-08 15:23:07 +01:00
Christian Heimes 5bb414d176 Issue #19343: Expose FreeBSD-specific APIs in resource module. Original patch by Koobs. 2013-12-08 14:35:55 +01:00
Guido van Rossum 9710ff04ac Silently ignore unregistering closed files. Fixes issue 19876. With docs and slight test refactor. 2013-12-07 15:57:01 -08:00
Alexandre Vassalotti d05c9ff845 Issue #6784: Strings from Python 2 can now be unpickled as bytes objects.
Initial patch by Merlijn van Deen.

I've added a few unrelated docstring fixes in the patch while I was at
it, which makes the documentation for pickle a bit more consistent.
2013-12-07 01:09:27 -08:00
Benjamin Peterson d45a46b60d merge 3.3 (#19910) 2013-12-06 20:12:51 -05:00
Benjamin Peterson 933142a8f2 document that compile() can take bytes (closes #19910) 2013-12-06 20:12:39 -05:00
Antoine Pitrou 9bcb1127f1 Mention pickle protocol 4, and some tweaks. 2013-12-07 01:05:57 +01:00
Antoine Pitrou 9858e8b98d Issue #19900: improve generalities at the start of the pickle module doc 2013-12-07 00:57:44 +01:00
Antoine Pitrou d4d60554bc Issue #19900: improve generalities at the start of the pickle module doc 2013-12-07 00:56:59 +01:00
Vinay Sajip 1b8b868b84 Merged minor documentation update from 3.3. 2013-12-06 11:23:08 +00:00
Vinay Sajip b1a92a4c89 Added minor clarification in logging HOWTO. 2013-12-06 11:22:24 +00:00
Antoine Pitrou 710280b6d6 Issue #18840: Introduce the json module in the tutorial, and deemphasize the pickle module. 2013-12-05 23:48:10 +01:00
Antoine Pitrou dd799d2e32 Issue #18840: Introduce the json module in the tutorial, and deemphasize the pickle module. 2013-12-05 23:46:32 +01:00
Antoine Pitrou f9c54944df Merge socket doc changes from 3.3 2013-12-04 21:15:24 +01:00
Antoine Pitrou a5cc9d68b9 Tweak the socket module doc layout 2013-12-04 21:11:03 +01:00
Antoine Pitrou e3658a70c3 Issue #19882: tweak docs for socket.close() 2013-12-04 21:02:42 +01:00
Victor Stinner 31d83228c2 asyncio doc: add some notes on the ping example 2013-12-04 11:16:17 +01:00
Victor Stinner 99c2ab4b83 asyncio doc: oh, asyncio module has its own Future class
Improve also wait() documentation: mention that the first parameter is a
sequence
2013-12-03 19:17:25 +01:00
Victor Stinner cf6f72e329 Fix typo in asyncio.AbstractServer documentation 2013-12-03 18:23:52 +01:00
Victor Stinner c6fba92ebc asyncio doc: add one more example of coroutines 2013-12-03 17:37:31 +01:00
Victor Stinner 85a2be7da7 ayncio: replace the disclamer with a seealso section 2013-12-03 15:04:36 +01:00
Victor Stinner 15faa9c8ad asyncio doc: simplify ping example, remove the useless timeout 2013-12-03 15:04:18 +01:00
Victor Stinner afbf827875 asyncio doc: fix definition of stop() method 2013-12-03 02:05:42 +01:00
Victor Stinner 933a8c82ce asyncio doc: reorder methods; typo 2013-12-03 01:59:38 +01:00
Victor Stinner 1ca5ba611b asyncio io: group transports and protocols in a new title 2013-12-03 01:49:43 +01:00
Victor Stinner 0c6f1ca40c asyncio doc: write a complete TCP echo example, client and server
Example based on tcp_echo.py example from Tulip source code.
2013-12-03 01:46:39 +01:00
Victor Stinner 3e09e32c8a asyncio doc: move coroutine example to the Task page 2013-12-03 01:22:06 +01:00
Victor Stinner ea3183f5b8 Split asyncio documentation into subfiles 2013-12-03 01:08:00 +01:00
Victor Stinner fa2ce78a21 asyncio doc: change level of titles
Remove also a duplicated Protocols section!
2013-12-03 00:56:27 +01:00
Victor Stinner b3be72cac3 asyncio doc: reorder sections 2013-12-03 00:49:26 +01:00
Victor Stinner 34d8df5171 asyncio: document wait() function 2013-12-03 00:42:59 +01:00
Victor Stinner dd339a248c asyncio doc
* complete create_connection() prototype
* link to Server
* document get_extra_info() keys
2013-12-03 00:32:48 +01:00
Christian Heimes a5768f7292 Issue #19785: smtplib now supports SSLContext.check_hostname and server name
indication for TLS/SSL connections.
2013-12-02 20:44:17 +01:00
Christian Heimes 216d463b1f Issue #19783: nntplib now supports SSLContext.check_hostname and server name
indication for TLS/SSL connections.
2013-12-02 20:20:11 +01:00
Christian Heimes 1bc7068d7f Issue #19784: poplib now supports SSLContext.check_hostname and server name
indication for TLS/SSL connections.
2013-12-02 20:10:50 +01:00
Christian Heimes b8a3f58158 merge 2013-12-02 20:02:04 +01:00
Christian Heimes 48aae57996 Issue #19782: imaplib now supports SSLContext.check_hostname and server name
indication for TLS/SSL connections.
2013-12-02 20:01:29 +01:00
Serhiy Storchaka 6de88b3107 Fixed formatting (was parsed as description list). 2013-12-02 20:31:00 +02:00
Serhiy Storchaka 475546facf Fixed regex match representation in an example. 2013-12-02 20:23:19 +02:00
Victor Stinner 0c924b83ee asyncio: sort some methods 2013-12-02 17:52:31 +01:00
Victor Stinner b09f9b33d2 asyncio doc: group transport method by classes
Declare classes because they are mentionned in documentation of other functions
2013-12-02 17:46:04 +01:00
Victor Stinner e91f180efe asyncio: more documentation 2013-12-02 17:40:48 +01:00
Victor Stinner be490633be asyncio: document network functions, and stream reader/writer 2013-12-02 17:28:32 +01:00
Eli Bendersky b55c4d4539 Issue #19814: Clarify argparse's docs w.r.t prefix matching 2013-12-02 05:50:48 -08:00
Eli Bendersky f3114532e4 Issue #19814: Clarify argparse's docs w.r.t prefix matching 2013-12-02 05:49:54 -08:00
Victor Stinner c37dd614b6 asyncio: document locks 2013-12-02 14:31:16 +01:00
Victor Stinner 0da1d29c8a asyncio: document Queue classes 2013-12-02 14:06:03 +01:00
Victor Stinner 60efaae4f9 Document Task class and task functions 2013-12-02 13:47:23 +01:00
Victor Stinner 3c3c4f5a11 asyncio: cleanup doc 2013-12-02 13:04:25 +01:00
Victor Stinner 550a09ef86 Issue #19833: Document more asyncio.BaseEventLoop methods 2013-12-02 12:41:54 +01:00
Victor Stinner 4e70bb84e6 Issue #19833: add 2 examples to asyncio doc (hello world) 2013-12-02 12:21:30 +01:00
Victor Stinner 8dc434e092 Issue #19833: asyncio doc: add class name to methods 2013-12-02 12:20:57 +01:00
Victor Stinner 5f5657ee50 (Merge 3.3) Issue #19728: Fix sys.getfilesystemencoding() documentation 2013-12-02 12:17:29 +01:00
Victor Stinner 22d0418f71 Issue #19728: Fix sys.getfilesystemencoding() documentation 2013-12-02 12:16:46 +01:00
Christian Heimes e5b5edfa2c Issue #19781: ftplib now supports SSLContext.check_hostname and server name
indication for TLS/SSL connections.
2013-12-02 02:56:02 +01:00
Christian Heimes 1aa9a75fbf Issue #19509: Add SSLContext.check_hostname to match the peer's certificate
with server_hostname on handshake.
2013-12-02 02:41:19 +01:00
Charles-François Natali 837a6e012f Issue #19849: selectors: Document the possibility of early select() wakeup upon
EINTR.
2013-12-01 13:23:48 +01:00
Zachary Ware 7c63c85f17 Issue #19845: Updated the Compiling Python on Windows docs. 2013-11-30 17:03:03 -06:00
Zachary Ware f8ceb04fcf Issue #19845: Updated the Compiling Python on Windows docs. 2013-11-30 16:59:33 -06:00
Vinay Sajip 8b1e2f351d Closes #19789: Merged update from 3.3. 2013-11-30 22:46:29 +00:00
Vinay Sajip a9c179bd3e Issue #19789: Clarified documentation for logging.disable. 2013-11-30 22:45:29 +00:00
Guido van Rossum 8519e5ade6 More realistic example for selectors.py. 2013-11-29 14:51:18 -08:00
Charles-François Natali a951f3d1ac Remove trailing blanks. 2013-11-29 18:57:47 +01:00