Commit Graph

5747 Commits

Author SHA1 Message Date
Zachary Ware 19c1f3dce6 Fix unfinished thought in xml overview page. Suggested by Bo Bayles on docs@. 2014-01-31 11:30:36 -06:00
Yury Selivanov d71e52fc33 inspect.doc: Soften the note about inspect.signature not supporting
all builtin functions.
2014-01-30 00:22:57 -05:00
Yury Selivanov 224c9c1f49 inspect.docs: Document constructors for Signature & Parameter #20442 2014-01-30 00:12:02 -05:00
Yury Selivanov 783568980a inspect.docs: Document constructors for Signature & Parameter #20442 2014-01-30 00:10:54 -05:00
Victor Stinner 1ad5afc050 asyncio: document iscoroutine(), iscoroutinefunction() and wait_for()
Mention that wait_for() now accepts None for the timeout.
2014-01-30 00:18:50 +01:00
Victor Stinner f40c66334d asyncio doc: close the loop at exit 2014-01-28 23:32:40 +01:00
Ned Deily eecbbad89b Fix doc reference to OS X 10.9 Mavericks. 2014-01-27 19:03:07 -07:00
Victor Stinner 041ff9be13 asyncio doc: list Windows and Mac OS X limitations and explain how to work
around them
2014-01-28 02:24:22 +01:00
Victor Stinner eedf1c1ebf asyncio doc: subprocess_exec/subprocess_shell are not available on Windows 2014-01-27 23:01:41 +01:00
Yury Selivanov 2393dca472 inspect.signature: Use '/' to separate positional-only parameters from
the rest in Signature.__str__. #20356
2014-01-27 15:07:58 -05:00
Yury Selivanov ea2d66e68a doc/inspect: Clarify docs for __defaults__, add docs for __kwdefaults__ #20380 2014-01-27 14:26:28 -05:00
Victor Stinner 32970b8dec asyncio: IncompleteReadError is a subclass of EOFError 2014-01-27 12:18:49 +01:00
Victor Stinner b7f19ff94b asyncio: document the IncompleteReadError exception 2014-01-27 11:58:49 +01:00
Victor Stinner 8b86348dfa asyncio: document add_signal_handler/remove_signal_handler, add an example for
signals
2014-01-27 10:07:50 +01:00
Victor Stinner b9915973f3 Issue #20367: Fix behavior of concurrent.futures.as_completed() for duplicate
arguments.  Patch by Glenn Langford.
2014-01-27 09:11:48 +01:00
Guido van Rossum e6994ff6e3 Fix issue #20367: concurrent.futures.as_completed() for duplicate arguments.
Patch by Glenn Langford.
2014-01-26 09:57:51 -08:00
Guido van Rossum 9ad116bcd0 Document asyncio.QueueFull/Empty. 2014-01-25 17:38:31 -08:00
Victor Stinner 669eeaf933 Merge latest Tulip into asyncio
- Make the new granularity attribute private
- Simplify BaseEventLoop._run_once(): avoid math.ceil(), use simple arithmetic
  instead
2014-01-26 00:02:31 +01:00
Eric Snow 6029e08691 Issue 19944: Fix importlib.find_spec() so it imports parents as needed.
The function is also moved to importlib.util.
2014-01-25 15:32:46 -07:00
Victor Stinner f67255ab94 Issue #20311: asyncio: Add a granularity attribute to BaseEventLoop: maximum
between the resolution of the BaseEventLoop.time() method and the resolution of
the selector. The granuarility is used in the scheduler to round time and
deadline.
2014-01-25 15:01:33 +01:00
Victor Stinner 635fca9704 Issue #20311: selectors: Add a resolution attribute to BaseSelector. 2014-01-25 14:56:48 +01:00
Victor Stinner 62f8eccdbf asyncio doc: document StreamWriter.drain() 2014-01-24 18:47:26 +01:00
Victor Stinner 8c462c5a80 asyncio doc: move AbstractServer to the event loop page
Add also entries in the table of content for each synchronization primitive
class.
2014-01-24 18:11:43 +01:00
Victor Stinner 4b4f9ebfea asyncio doc: add a "Coroutines and protocols" section 2014-01-24 17:33:20 +01:00
Victor Stinner 1374bd41b1 asyncio: mention that transports/protocols are low-level, streams are high-level 2014-01-24 15:34:19 +01:00
Larry Hastings 5c66189e88 Issue #20189: Four additional builtin types (PyTypeObject,
PyMethodDescr_Type, _PyMethodWrapper_Type, and PyWrapperDescr_Type)
have been modified to provide introspection information for builtins.
Also: many additional Lib, test suite, and Argument Clinic fixes.
2014-01-24 06:17:25 -08:00
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
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
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
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
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
Brett Cannon 24f60b4616 Issues #20194,20195: Add missing :deprecated: markers to some module
docs.
2014-01-17 12:06:28 -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
Victor Stinner 9731183390 asyncio: oops, add missing word :-) 2014-01-17 10:31:02 +01: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
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
Georg Brandl 92b7adb60d merge 2014-01-14 12:27:44 +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
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
Georg Brandl 632c812942 small grammar fix. 2014-01-12 18:03:12 +01:00
Georg Brandl fa5a765506 Fix minor markup bug: sub-toctrees should not have :numbered: 2014-01-11 19:52:17 +01: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
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
R David Murray 0bce6e7462 whatsnew: expand 'dis' entry.
Also add one missing versionadded.
2014-01-07 14:30:17 -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 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 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
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
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
R David Murray d592bb2dc4 whatsnew: afic.open supports 'with'. 2013-12-31 13:45:38 -05: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
Michael Foord 4d1639f4e5 Closes issue 20031. Document unittest.TextTestRunner.run method. 2013-12-29 23:38:55 +00: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 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 3edcc7832e #16832: s/integer/object/ in docs/docstring, and add whatsnew entry. 2013-12-24 16:13:32 -05:00
Serhiy Storchaka f47036c130 Removed spaces before colons and semicolons. 2013-12-24 11:04:36 +02:00
Serhiy Storchaka 89e84e7523 Removed spaces before colons and semicolons. 2013-12-24 11:05:24 +02:00
Serhiy Storchaka 2a6145290b Removed spaces before commas and periods. 2013-12-23 18:21:57 +02:00
Serhiy Storchaka a4d170d985 Removed spaces before commas and periods. 2013-12-23 18:20:51 +02:00
Nick Coghlan 6256fcbc97 Close #19734: ignore pip env vars in ensurepip 2013-12-23 16:16:07 +10: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 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 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 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
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
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
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 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
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
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
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