Commit Graph

6312 Commits

Author SHA1 Message Date
Victor Stinner 63b21a8ffa Closes #21921: Fix ResourceWarning in the asyncio examples: close the event
loop at exit. Patch written by Vajrasky Kok (I modified also the "hello world"
example using a coroutine).
2014-07-05 15:38:59 +02:00
Berker Peksag 5021cb553c Issue #21920: Add a missing colon to the __main__ doc.
Patch by Stefan Tatschner.
2014-07-05 11:10:16 +03:00
Berker Peksag 3410af45f8 Add an index entry for exec() builtin.
Reported by Draic Kin on docs@.
2014-07-04 15:06:45 +03:00
Raymond Hettinger 11cda47661 Fix guidance for subclassing collections.Set() 2014-07-03 00:31:30 +01:00
Andrew Svetlov ee750d8f8d Use try-finally idiom in example for locks in multiprocessing 2014-07-02 07:21:03 +03:00
Ned Deily 5c867018f0 Issue #21875: Remove vestigial references to Classic Mac OS in os module docs. 2014-06-26 23:40:06 -07:00
Jesus Cea 0c4baa40ec MERGE: Closes #20872: dbm/gdbm/ndbm close methods are not documented 2014-06-25 13:06:07 +02:00
Jesus Cea ac4b7f705a Closes #20872: dbm/gdbm/ndbm close methods are not documented 2014-06-25 13:05:31 +02:00
Senthil Kumaran 99597c4d12 Correct the quopri module documentation. Mention the correct types of the
parameters on encodestring and decodestring.

Patch by Petri Lehtinen.
2014-06-25 01:12:03 -07:00
Benjamin Peterson f6f78e1d9d clarify that islink only really works if python knows about symlinks (closes #13143)
Patch from Yayoi Ukai.
2014-06-22 17:59:35 -07:00
Benjamin Peterson 9b29acd1fe some timezone doc improvements (closes #16667)
From the combined efforts of Berber Peksage, Andrew Svetlov, and Yayoi Ukai.
2014-06-22 16:26:39 -07:00
Victor Stinner f328c7dc69 asyncio, Tulip issue 171: BaseEventLoop.close() now raises an exception if the
event loop is running. You must first stop the event loop and then wait until
it stopped, before closing it.
2014-06-23 01:02:37 +02:00
Victor Stinner 62511fd6d6 asyncio: document the debug mode 2014-06-23 00:36:11 +02:00
Victor Stinner 7b7120e159 asyncio: Enable the debug mode of event loops when the PYTHONASYNCIODEBUG
environment variable is set
2014-06-23 00:12:14 +02:00
Senthil Kumaran 4932e14542 issue 20091 - index entry for __main__ in runpy docs. 2014-06-20 01:37:53 -07:00
Ezio Melotti 642d4b654f #21690: fix a couple of links in the docs of the re module. Noticed by Julian Gilbey. 2014-06-20 00:52:11 +03:00
Victor Stinner d143209d7f Tulip issue 83: document more asyncio functions in docstrings 2014-06-19 17:11:49 +02:00
Victor Stinner 6bfd854ea8 Closes #21758: asyncio doc: mention explicitly that subprocess parameters are
bytes or character strings
2014-06-19 12:50:27 +02:00
Zachary Ware 8909127af2 Fix typo pointed out by cocoatomo on docs@ 2014-06-17 22:26:59 -05:00
Victor Stinner 64d750b36b asyncio: Fix pyflakes errors
- Add a missing import
- Remove an unused import
- Remove unused variables
2014-06-18 03:25:23 +02:00
Terry Jan Reedy b6d1f48c14 Issue #21559: Add alternative (historical) reason for OverflowError. 2014-06-16 03:31:00 -04:00
Terry Jan Reedy f2fb73f675 Issue #19362: Tweek len() doc and docstring to expand the indicated range of
arguments. Original patch by Gareth Rees.
2014-06-16 03:05:37 -04:00
Benjamin Peterson e58e0c7f33 clarify when the list of subdirectories is read (closes #13779) 2014-06-15 20:51:12 -07:00
Benjamin Peterson ef8abfc082 document IOBase.__del__'s behavior (closes #21764)
Patch from Nikolaus Rath.
2014-06-14 18:51:34 -07:00
Vinay Sajip e0d324d02b Issue #21752: Documented change to behaviour of logging.getLevelName(). 2014-06-14 09:26:26 +01:00
Victor Stinner b2788fe854 Issue #16136: VMSError is done, bye bye VMS 2014-06-13 14:58:48 +02:00
Victor Stinner db74d982d4 Issue #21596: asyncio.wait(): mention that the sequence of futures must not
be empty.
2014-06-10 11:16:05 +02:00
Victor Stinner bb2fc5b2a5 Issue #21326: Add a new is_closed() method to asyncio.BaseEventLoop
Add BaseEventLoop._closed attribute and use it to check if the event loop was
closed or not, instead of checking different attributes in each subclass of
BaseEventLoop.

run_forever() and run_until_complete() methods now raise a RuntimeError('Event loop is
closed') exception if the event loop was closed.

BaseProactorEventLoop.close() now also cancels "accept futures".
2014-06-10 10:23:10 +02:00
Victor Stinner 15386652bf Issue #21700: Fix asyncio doc, add DatagramProtocol 2014-06-10 09:19:26 +02:00
R David Murray 6ceca4e3d8 #20903: clarify what happens when an smtp connection timeout occurs.
Patch by Milan Oberkirch.
2014-06-09 16:41:06 -04:00
Benjamin Peterson 96e0430dfb document TokenError and unclosed expression behavior (closes #12063)
Patch by Amandine Lee.
2014-06-07 17:47:41 -07:00
Benjamin Peterson 4bb09c8432 specify that getuid() returns the real uid (closes #10503)
Patch by εσχατοκυριος.
2014-06-07 13:50:34 -07:00
Benjamin Peterson 9b2731bfdd document the compress_level argument to tarfile.open (closes #21404)
Patch by Katherine Busch.
2014-06-07 12:45:37 -07:00
R David Murray 092135ebc8 #21653: fix doc for return type of sqlite3.Row.keys(). 2014-06-05 15:16:38 -04:00
Victor Stinner f9e49dd346 Tulip issue 83, Python issue #21252: Fill some XXX docstrings in asyncio 2014-06-05 12:06:44 +02:00
Terry Jan Reedy b52f876767 Issue 21533: Dicts take iterables, not iterators. Patch by Wolfgang Maier. 2014-06-02 20:42:56 -04:00
Victor Stinner 8d21357fb5 Issue #21601: Document asyncio.Task.cancel(). Initial patch written by Vajrasky
Kok.
2014-06-02 23:06:46 +02:00
Benjamin Peterson a8195770fa give the correct fixer name (closes #21604) 2014-05-31 13:16:49 -07:00
Terry Jan Reedy 0edb5c1668 Issue #21593: (from StackOverflow) minor doc clarification for re.search. 2014-05-30 16:19:59 -04:00
Vinay Sajip c673a9ab87 Issue #21608: Updated HTTPHandler documentation. 2014-05-30 18:59:27 +01:00
Victor Stinner a5b257af22 Issue #21454: Fix asyncio.BaseEventLoop.connect_read_pipe doc
The function sets the the pipe to non-blocking mode.
2014-05-29 00:14:03 +02:00
Victor Stinner 28d0ae48e9 Issue #21376: document asyncio.TimeoutError 2014-05-29 00:04:57 +02:00
Benjamin Peterson 5e2c4d2de0 grammar and sentence flow fix 2014-05-26 15:48:12 -07:00
Benjamin Peterson f9ea5f39d8 format reST directive in the usual way 2014-05-26 15:45:14 -07:00
Benjamin Peterson 0d81d80f6e link to wikipedia description of cryptographic salt 2014-05-26 15:42:29 -07:00
Benjamin Peterson 0ccff4d3e1 oxford comma 2014-05-26 15:41:26 -07:00
Raymond Hettinger e8e2df3daa Issue 21558: Fix a typo in the contextlib docs 2014-05-25 18:06:04 -07:00
Raymond Hettinger 7096e26983 Issue 21479: Fix markup for the TarFile.open() classmethod. 2014-05-23 03:46:52 +01:00
Raymond Hettinger f7f64f94b1 Issue 21198: Minor tarfile documentation bug. 2014-05-23 00:03:45 +01:00
Antoine Pitrou 75e03388d8 Issue #21430: additions to the description of non-blocking SSL sockets 2014-05-18 00:55:13 +02:00
Antoine Pitrou 2d1ec06484 Issue #21364: remove recommendation of broken pattern. 2014-05-15 22:38:56 +02:00
Victor Stinner ef5b4e3dc3 Issue #21488: Fix doc of codecs.decode() and codecs.encode(), no keyword support.
Patch written by Brad Aylsworth.
2014-05-14 17:08:45 +02:00
R David Murray ae9d193dc4 #21347: use string not list in shell=True example.
Patch by Akira.
2014-05-14 10:09:52 -04:00
Jason R. Coombs 73308d6869 Merge doc change from 3.3 2014-05-12 22:41:15 -04:00
Jason R. Coombs 13266fb5c8 Update docs to reflect resurrection of Setuptools over Distribute 2014-05-12 22:40:49 -04:00
Victor Stinner b0539b27d9 Issue #21485: remove unnecesary .flush() calls in the asyncio subprocess code
example
2014-05-12 23:25:09 +02:00
Gregory P. Smith 8e0aa051e6 Change all references to Unix to POSIX in the subprocess docs. It's
more accurate and sounds less like a strange tale of yore.
2014-05-11 13:28:35 -07:00
Gregory P. Smith 6436cba9db Remove the warning-soup from the subprocess documentation by adding
a Security Considerations section as preferred by both the devguide
and documentation users who do not wish to go insane.
2014-05-11 13:26:21 -07:00
Brett Cannon 062fcac9a4 Issue #21438: Document what loaders don't require a module name for
load_module().
2014-05-09 11:55:49 -04:00
Brett Cannon f26702b86e Issue #21157: Touch up imp docs to be more explicit about importlib
alternatives.
2014-05-09 10:37:31 -04:00
R David Murray a83ade1d60 #21300: fix typo 2014-05-08 10:05:47 -04:00
R David Murray e25244657c #21300: Clean up the docs for the email "policy" arguments. 2014-05-06 21:33:18 -04:00
Guido van Rossum 5280d2e399 asyncio docs: ProactorEventLoop does not support SSL. 2014-05-05 07:34:56 -07:00
Gregory P. Smith d8ea56d26d Document the subprocess Popen.args attribute (issue21353) 2014-04-29 11:33:56 -07:00
Gregory P. Smith 024c5eecbc Document the subprocess Popen.args attribute (issue21353) 2014-04-29 11:33:23 -07:00
Terry Jan Reedy 43e7cd38e5 Issue #21026: Augment site doc based on experiments. Patch by Carol Willing. 2014-04-29 00:31:53 -04:00
R David Murray ae25f46706 #18243: Remove obsolete cautionary note from email mktime_tz docs. 2014-04-26 19:01:18 -04:00
Terry Jan Reedy bddecc3861 Issue #21232: Replace .splitlines arg '1' with 'keepends=True'. 2014-04-18 17:00:19 -04:00
Senthil Kumaran aad7cc9dba Clarify BROWSER envar behavior in webbrowser.py. Noted by David Turner. Closes #21248 2014-04-16 23:43:34 -04:00
Senthil Kumaran 8b4a272c98 Correct the URL in the http.client example. Noted by Evens Fortuné. Closes #21229 2014-04-16 23:33:02 -04:00
Senthil Kumaran cad2bf20c3 Address issue 18229 - Explain http.server.BaseHTTPRequestHandler's .headers attribute further.
Initial patch by Caelyn McAulay.
2014-04-16 13:56:19 -04:00
Terry Jan Reedy 7f84d1eb63 #18566: Whitespace 2014-04-15 23:44:14 -04:00
Terry Jan Reedy 6ac4240b6c Issue #18566: Clarify unittest setUp, tearDown doc. Patch by Nitika Agarwal. 2014-04-15 23:38:18 -04:00
Vinay Sajip 65425b4bc6 Issue #21245: updated documentation on exception() method and function. 2014-04-15 23:13:12 +01:00
R David Murray fe0e1082aa #15104: add backtick code markup. 2014-04-14 18:53:51 -04:00
R David Murray 061cb3b04d #15104: improve the discussion of __main__.
Patch by Sam Lucidi.
2014-04-14 15:04:47 -04:00
Andrew Kuchling 44da19a63d #18518: mention that including a return statement changes/breaks the behaviour 2014-04-14 13:39:43 -04:00
Mark Dickinson abf079de25 Issue #20624: Exception docs wording tweak - clarify that it's okay to inherit from a subclass of Exception. 2014-04-14 11:20:12 -04:00
R David Murray 604453c9ce #21169: add comment and doc update for getpass change. 2014-04-14 10:28:58 -04:00
Terry Jan Reedy f98021cff2 Issue #21170: Removed invalid parameter names from unittest doc.
Patch by Kushal Das.
2014-04-11 14:11:11 -04:00
Benjamin Peterson 222ef82827 fix verb (closes #21174) 2014-04-07 19:34:33 -04:00
Senthil Kumaran 6d6ec25e04 merge from 3.3 2014-04-06 11:00:15 -07:00
Senthil Kumaran f5c34054f9 minor docfix (reported at docs@python.org) trace.py argument is --count not --counts 2014-04-06 10:59:47 -07:00
Raymond Hettinger b30b34c1aa Issue 21143: Fix typo in docs for max(). 2014-04-03 08:01:22 -07:00
Eli Bendersky 0bd22d4277 Issue #20375: Clarify ET's parsing of comments and processing instructions.
Based on patch by Nikolaus Rath.
2014-04-03 06:14:38 -07:00
Raymond Hettinger 31b26f637a Issue #18652: Add an itertools recipe for first_true() 2014-04-02 03:16:42 -07:00
Raymond Hettinger f4284e45d0 Documentation nit. List the traditional keyword-only argument first and the default last. 2014-04-02 00:58:47 -07:00
Raymond Hettinger da4bf8f16a Issue 21125: minor documentation tweak. 2014-04-01 22:17:33 -07:00
Benjamin Peterson 1acc69c650 update version changed 2014-04-01 19:22:06 -04:00
Benjamin Peterson 9dc203fff9 merge 3.3 (#21082) 2014-04-01 19:18:48 -04:00
Benjamin Peterson 4717e2112b merge 3.2 (#21082) 2014-04-01 19:17:57 -04:00
Benjamin Peterson ee5f1c13d1 remove directory mode check from makedirs (closes #21082) 2014-04-01 19:13:18 -04:00
Zachary Ware 9d08562ed4 Issue #15067: Port 2.7 sqlite3 docs to 3.4 2014-04-01 12:21:56 -05:00
Andrew Svetlov c3bf6922b5 #16716: remove deprecation warning 2014-04-01 02:08:25 +03:00
Andrew Svetlov 08af00047b Get rid of deprecated IOError in the doc 2014-04-01 01:13:30 +03:00
Andrew Svetlov 5898d4f4d9 IOError -> OSError 2014-04-01 00:44:13 +03:00
Andrew Svetlov 050f9ea4d7 Fix the doc: add deprecation warning in select module. 2014-04-01 00:23:23 +03:00
Benjamin Peterson 3a4340325b make partialmethod example work (closes #21105) 2014-03-30 15:07:09 -04:00
Guido van Rossum 589872cbdf Fix doc typo. 2014-03-29 21:14:04 -07:00
Raymond Hettinger 1e1e601bd1 Minor readability improvement. 2014-03-29 11:50:08 -07:00
Ned Deily e7d532fbc9 Issue #6676: Ensure a meaningful exception is raised when attempting
to parse more than one XML document per pyexpat xmlparser instance.
(Original patches by Hirokazu Yamamoto and Amaury Forgeot d'Arc, with
suggested wording by David Gutteridge)
2014-03-27 16:39:58 -07:00
Victor Stinner 215ad66405 Issue #12209: Minor edits to faulthandler doc. Patch written by Éric Araujo. 2014-03-25 12:33:56 +01:00
Victor Stinner 984600fba7 Issue #21006: asyncio doc: reorganize subprocess doc 2014-03-25 09:40:26 +01:00
Donald Stufft 4137465bf5 Issue #21043: Remove the recommendation for specific CA organizations
Closes #21043 by updating the documentation to remove specific CA
organizations and update the text to no longer need to tell you to
download root certificates, but instead use the OS certificates
avaialble through SSLContext.load_default_certs.
2014-03-24 19:26:03 -04:00
Georg Brandl df48b97855 Fix a few scoping issues with versionadded/versionchanged directives. 2014-03-24 09:06:18 +01:00
Donald Stufft 6a2ba94908 Issue #21013: Enhance ssl.create_default_context() for server side contexts
Closes #21013 by modfying ssl.create_default_context() to:

* Move the restricted ciphers to only apply when using
  ssl.Purpose.CLIENT_AUTH. The major difference between restricted and not
  is the lack of RC4 in the restricted. However there are servers that exist
  that only expose RC4 still.
* Switches the default protocol to ssl.PROTOCOL_SSLv23 so that the context
  will select TLS1.1 or TLS1.2 if it is available.
* Add ssl.OP_NO_SSLv3 by default to continue to block SSL3.0 sockets
* Add ssl.OP_SINGLE_DH_USE and ssl.OP_SINGLE_ECDG_USE to improve the security
  of the perfect forward secrecy
* Add ssl.OP_CIPHER_SERVER_PREFERENCE so that when used for a server side
  socket the context will prioritize our ciphers which have been carefully
  selected to maximize security and performance.
* Documents the failure conditions when a SSL3.0 connection is required so
  that end users can more easily determine if they need to unset
  ssl.OP_NO_SSLv3.
2014-03-23 19:05:28 -04:00
Antoine Pitrou f8cbbbb652 Issue #20913: make it clear that create_default_context() also enables hostname checking 2014-03-23 16:31:08 +01:00
Antoine Pitrou c5e075ff03 Issue #20913: improve the SSL security considerations to first advocate using create_default_context(). 2014-03-22 18:19:11 +01:00
Donald Stufft 79ccaa2cad Issue #20995: Enhance default ciphers used by the ssl module
Closes #20995 by Enabling better security by prioritizing ciphers
such that:

* Prefer cipher suites that offer perfect forward secrecy (DHE/ECDHE)
* Prefer ECDHE over DHE for better performance
* Prefer any AES-GCM over any AES-CBC for better performance and security
* Then Use HIGH cipher suites as a fallback
* Then Use 3DES as fallback which is secure but slow
* Finally use RC4 as a fallback which is problematic but needed for
  compatibility some times.
* Disable NULL authentication, NULL encryption, and MD5 MACs for security
  reasons
2014-03-21 21:33:34 -04:00
Victor Stinner 51f3129ba2 Close #21010: Fix typo in asyncio doc. Patch written by Claudiu Popa. 2014-03-21 17:17:15 +01:00
Victor Stinner 6bc239619c Issue #21006: Fix subprocess example on Windows in asyncio doc 2014-03-21 11:56:40 +01:00
Victor Stinner 7280486ce3 Close #21005: Fix documentation of asyncio.subprocess.DEVNULL 2014-03-21 11:44:49 +01:00
Benjamin Peterson 409a1be6cf improve start default for relpath 2014-03-20 12:39:53 -05:00
Zachary Ware dbd1c43e52 Fix spelling in enum docs.
"equivalant" was caught by Tobias Käs on docs@, "seperated" and "chartruese"
were discovered by a spell-checker.
2014-03-20 10:01:48 -05:00
Zachary Ware a22ae21db6 Fix parameter name in docs for os.makedirs and os.removedirs.
Pointed out by Colin Davis on docs@.
2014-03-20 09:42:01 -05:00
Zachary Ware 088639936d Issue #20966: Fix Tkinter Resources link 2014-03-18 09:19:18 -05:00
Georg Brandl f5c801fdca Fix option description that is a warning in new Sphinx versions. 2014-03-18 07:44:07 +01:00
Éric Araujo 0b1be1a3b1 Fix typo in example (#20963) 2014-03-17 16:48:13 -04:00
R David Murray f93d3dfc50 closes #20960 2014-03-17 11:20:29 -04:00
Benjamin Peterson 2221f666eb merge 3.3 (#11448) 2014-03-16 15:56:24 -05:00
Benjamin Peterson a48d9eaa5c improve set_tunnel docs (closes #11448)
Patch by Ryan Kelly, karl, and Nikolaus Rath.
2014-03-16 15:55:39 -05:00
Victor Stinner 7bdf786e74 Issue #20950: Fix typo asyncio doc, wait() has no self parameter
self parameter is implicit. Mention also that communicate() and wait() are
coroutines.
2014-03-16 21:29:31 +01:00
Antoine Pitrou 8bc7ef63a4 Close #16665: improve documentation for hex(). Patch by Jessica McKellar. 2014-03-16 02:13:07 +01:00
Antoine Pitrou 790bf0db77 Close #16665: improve documentation for hex(). Patch by Jessica McKellar. 2014-03-16 02:12:20 +01:00
R David Murray b69c0c16cd whatsnew: final edit pass. 2014-03-14 18:31:07 -04:00
R David Murray bcf7012d19 whatsnew: linkify some pip things, and explain why non-inheriting is good. 2014-03-13 19:53:38 -04:00
R David Murray b895505625 whatsnew: HTTPError.headers (#15701). 2014-03-13 11:33:29 -04:00
Benjamin Peterson 5eea8a7780 remove unnecessary word (closes #19060)
Patch by Anastasia Filatova.
2014-03-12 21:41:35 -05:00
Éric Araujo fa5e6e4773 Fix note markup (#16805).
Patch by Tshepang Lekhonkhobe, reviewed by Georg Brandl.
2014-03-12 19:51:00 -04:00
Nick Coghlan f7614d55a2 Close #19407: New installation & distribution guides
- based on pip and other PyPA tools
- includes references to the new Python Packaging User Guide
  where appropriate (and the relevant section is at least
  partially filled in)
- started new FAQ sections
- both guides aim to introduce users to basic open source
  concepts if they aren't aware of them
- existing guides have been relocated (now linked from the
  distutils docs) rather then removed, since there is
  some needed material that has yet to be relocated to the
  distutils docs as a reference for the legacy formats
2014-03-13 22:13:45 +10:00
Victor Stinner 2fb3b82706 asyncio doc: functions are coroutine, they don't return a coroutine
It's not exact, but easier to understand.
2014-03-13 10:58:03 +01:00
Victor Stinner 39930c9ca0 Close #20889: asyncio doc: Document acquire(), locked() and release() method of
Condition
2014-03-13 10:54:18 +01:00
Victor Stinner d079d3a289 Close #20787: asyncio doc: fix typo. Patch written by akira. 2014-03-13 10:50:01 +01:00
Benjamin Peterson 605765fa32 merge 3.3 (#19060) 2014-03-12 21:42:04 -05:00
Éric Araujo abdc16ee1b Merge 3.3 (#16805) 2014-03-12 19:51:50 -04:00
R David Murray 600e08dc1c Merge #20030: doc that TestLoader.discover returns a TestSuite. 2014-03-11 18:46:37 -04:00
R David Murray ed5d95b76b #20030: doc that TestLoader.discover returns a TestSuite.
Patch by Lita Cho.
2014-03-11 18:46:00 -04:00
Benjamin Peterson 86deec1917 merge 3.3 2014-03-11 14:26:21 -05:00
Benjamin Peterson 8e4b3c7f55 improve algorithms_* documentation 2014-03-11 14:26:12 -05:00
Victor Stinner 11a4270b6a What's New in Python 3.4: Security improvements 2014-03-11 13:17:30 +01:00
Victor Stinner 637d2e9296 Issue #20888: improve "Pretty Top" example of tracemalloc, use linecache 2014-03-11 08:12:48 +01:00
R David Murray 0c18282da6 whatsnew: remove XXXs.
Can't figure out what the other issue was for the importlib
changes.  Did find a small typo in the reload doc, though.
2014-03-10 21:38:37 -04:00
R David Murray 9ea2a630fe whatsnew: deprecation of ElementTree XMLParser *html* and iterparse *parser*.
#17741
2014-03-10 18:09:54 -04:00
R David Murray 8df4ec70d3 whatsnew: os.open O_PATH and O_TMPFILE. 2014-03-10 15:48:22 -04:00
R David Murray e8db162f62 whatsnew: PEP 424 implementation. 2014-03-10 15:00:33 -04:00
R David Murray d840b8d613 whatsnew: multiprocessing start methods and context (#8713 and #18999)
Also tweaked the docs a bit to use our standard style for
versionadded/changed.  (I'm guessing there are other places
in the multiprocessing docs where similar tweaks should be made.)
2014-03-10 14:27:21 -04:00
R David Murray c08383633a whatsnew: Message.set_param *replace*, Policy.content_manager.
Also cleaned up the email section and fixed some markup bugs in the
email docs.
2014-03-10 10:08:05 -04:00
R David Murray 2177be2c3a whatsnew: auidioop.byteswap (#16685). 2014-03-09 20:42:49 -04:00
R David Murray 1d342b2e8b whatsnew: plistlib new api and deprecations (#14455)
Also fixed the versionchanged/deprecation tags in the docs.
2014-03-09 15:09:04 -04:00
R David Murray 2dd0473722 whatsnew: SSLSocket.getpeercert new values returned. (#18379) 2014-03-09 12:55:58 -04:00
R David Murray 4e40cec924 whatsnew: sys.__interactivehook__. (#5845)
I decided to leave the (slightly expanded) Other Improvements
entry as well, since someone looking for command line behavior
changes isn't going to look in the 'sys' module section.
2014-03-09 12:03:30 -04:00
R David Murray 3d234837ed whatsnew: hmac *digestmod* accepts strings, and default is deprecated. (#17276) 2014-03-08 22:43:12 -05:00
R David Murray c210de1ea1 whatsnew: base65 encodings. (#17618)
Also updated the base64 module title and introduction to adjust for
the fact that these new encodings are included.

Also adjusted the wording about the base64 alphabets (see
issue #20837).
2014-03-08 12:53:28 -05:00
R David Murray cbf479ae64 whatsnew: sunau/aifc/wave writeframes[raw] accept any bytes-like (#8311) 2014-03-08 11:46:05 -05:00
R David Murray 5d6240e871 whatsnew: Wave_write handles unseekable files. (#5202)
Also clarify the documentation of this feature.
2014-03-08 11:14:29 -05:00
Nick Coghlan 1635578d5f Improve descriptions of introspection changes
Several of the introspection changes in Python 3.4 are indirect,
where inspect module changes affected pydoc, and those in turn
affected the help builtin. This update adds versionchanged
notes in the key locations, as well as more coverage in the
What's New document (in particular, a note in the porting
section regarding the expanded domain for inspect.getfullargspec).
2014-03-08 16:36:37 +10:00
R David Murray 8591563628 whatsnew: audioop accepts any bytes-like, rejects strings. 2014-03-07 21:35:31 -05:00
R David Murray 6c50101fc9 whatsnew: inet_pton/inet_ntop support windows (#7171).
Added versionchanged to docs.
2014-03-07 21:22:39 -05:00
R David Murray 47d083cf1a whatsnew: cp273 codec (#10907797)
Also updated the docs and added the aliases mentioned by the
references.
2014-03-07 21:00:34 -05:00
R David Murray 48b6b70b95 #10197: Update get[status]output versionchanged with actual version.
This was perhaps on the border between a bug fix and a feature since
the Python3 docs did not originally say it was unix only.  However, the
functions never worked anywhere but unix, and the docs were changed to
say it was unix only well before the windows support was added.

Unfortunately, windows support was added in 3.3.4 as well as 3.4.
That leaves us in the uncomfortable position of needing the tag to say
"version changed: 3.3.4" :(
2014-03-07 20:04:41 -05:00
R David Murray 95b696a010 #10197: Update get[status]output versionchanged with actual version.
This was perhaps on the border between a bug fix and a feature since
the Python3 docs did not originally say it was unix only.  However, the
functions never worked anywhere but unix, and the docs were changed to
say it was unix only well before the windows support was added.

Unfortunately, windows support was added in 3.3.4 as well as 3.4.
That leaves us in the uncomfortable position of needing the tag to say
"version changed: 3.3.4" :(
2014-03-07 20:04:17 -05:00
R David Murray 6674ac0873 whatsnew: ipaddress is_global
Also tweaked the docs a bit and added the missing entry for
the ipv6 is_global.
2014-03-06 11:51:37 -05:00
R David Murray 83db8fc3cc whatsnew: improve PyZipFile filterfuc entry, and its docs (#19274). 2014-03-05 10:48:01 -05:00
Nick Coghlan dc855b7b1f Close #20839: pkgutil.find_loader now uses importlib.util.find_spec 2014-03-04 20:39:42 +10:00
Ethan Furman c913a7a6f6 Issue20653: fix ReST for Enum 2014-03-03 15:02:04 -08:00
Ethan Furman 9c45444727 Close issue20653: improve functional API docs; minor code changes 2014-03-03 12:42:52 -08:00
Victor Stinner f70200e5a9 Close #20814: doc: Fix "Pretty top" example of tracemalloc 2014-03-03 11:57:57 +01:00
R David Murray 9c0c101ee4 whatsnew: unittest discover works on namespace packages (#17457).
I also added the docs that never got committed, editing the patch provided by
Claudiu.

I collapsed the now three versionchanged directives for discovery into one.  I
tried several different styles for this.  The most obvious is a bulleted list,
but currently the only way I could find to produce that is to have *something*
appear on the versionchanged line after the colon, which combined with the
blank space before the bulleted list just looks wrong.  I also tried the
current single-line-three-sentences version with bullet characters before each
sentence, and I almost went with that as it made it clear that the three
sentences are independent.  But I decided to just go with the sentences for
simplicity reasons.
2014-03-01 11:57:58 -05:00
Andrew Kuchling 98f2bbf794 #16135: remove mentions of OS/2 from the documentation 2014-03-01 07:53:28 -05:00
Brett Cannon acc74e6c63 Issue #20650: Tweak some awkward wording. 2014-02-28 10:06:18 -05:00
R David Murray 871119eb2f whatsnew: fix textwrap/shorten entry, and improve the related docs.
I had incorrectly added back the shorten method when I initially
made the whatsnew entry, but the shorten function docs were not
correct according to the code.  I also improved the wording in
general.
2014-02-27 18:01:43 -05:00
Zachary Ware 5ea5d2c3f7 Issue #20759: Fix some typos in the mock docs. 2014-02-26 09:34:43 -06:00
Zachary Ware 984689821d Close #20759: Fix some typos in the mock docs. (Merge with 3.3) 2014-02-26 09:38:39 -06:00
R David Murray 13cc883aaa whatsnew: DynanicClassAttribute (#19030), Py_SetStandardStreamEncoding (#16129)
Adding missing docs for DynamicClassAttribute by copying the docstring.  The
doc entry could stand some expansion, which I will note on the issue.
2014-02-25 16:03:14 -05:00
Antoine Pitrou ef85119618 Issue #20765: Add missing documentation for PurePath.with_name() and PurePath.with_suffix(). 2014-02-25 20:33:02 +01:00
R David Murray 7cae336890 whatsnew: Request.method can be overridden in subclasses (#18978).
Jason doced the change in the constructor *method* description, but
not the description of Request.method, so I added the change there
as well.
2014-02-25 10:22:50 -05:00
Guido van Rossum 3e97585b3e Clarify that flow control works for datagrams, except on BSD. 2014-02-24 14:31:25 -08:00
R David Murray 8920e915fa whatsnew: http.server --bind cli option.
Also some fixups in the docs.
2014-02-24 17:21:42 -05:00
R David Murray 4f91364598 Merge #20628: make it clear that DictReader/Writer *fieldnames* is a Sequence.
Including the subsequent line re-wrapping.
2014-02-24 15:34:48 -05:00
R David Murray f031a6f334 #20628: wrap lines to < 80. 2014-02-24 15:32:54 -05:00
R David Murray df714b9f70 #20628: make it clear that DictReader/Writer *fieldnames* is a Sequence.
Patch by Sean Rodman.
2014-02-24 15:29:22 -05:00
Victor Stinner de0e1d30d8 asyncio doc: fix references in subprocess doc 2014-02-24 13:19:19 +01:00
Victor Stinner 07171242d5 subprocess.Popen.wait doc: mention asyncio to avoid busy loop 2014-02-24 13:18:47 +01:00
Georg Brandl 06a70621ed merge with 3.3 2014-02-24 09:27:16 +01:00
Georg Brandl c4f44c027e Closes #20735: remove erroneous deprecated marker from stringprep docs 2014-02-24 09:26:53 +01:00
R David Murray 6e1bc7cab9 whatsnew: textwrap.shorten.
Also add the missing TextWrapper.shorten method doc.
2014-02-23 10:22:07 -05:00
Ezio Melotti 32f30a8d9b #20677: fix typo in enum docs. Patch by Saimadhav Heblikar. 2014-02-23 17:13:31 +02:00
R David Murray 98681d4ac1 Reflow paragraph. 2014-02-22 16:32:07 -05:00
R David Murray 928924d1a1 whatsnew: os.path.ismount recognizes volumes mounted below root. 2014-02-22 16:31:26 -05:00
R David Murray b070b3f502 whatsnew: frozen package __path__; and min/max versionadded. 2014-02-22 15:05:08 -05:00
Yury Selivanov 7a19355c77 asyncio.docs: Document subprocess_exec and subprocess_shell. Issue #20694. 2014-02-20 20:10:28 -05:00
Yury Selivanov f9200ae398 asyncio.docs: Improve wordings; add a note to the Coroutines section. Issue #20706 2014-02-20 16:20:44 -05:00
Yury Selivanov 35669ae77e asyncio.docs: Improve documentation of Streams. Issue #20696. 2014-02-20 14:10:02 -05:00
Yury Selivanov d5797422dd asyncio.docs: Document Error Handling API and asyncio.Handle 2014-02-19 20:58:44 -05:00
Victor Stinner aabc131224 asyncio doc: remove reference to _DEBUG (now replaced with PYTHONASYNCIODEBUG
env var), document the default debug mode
2014-02-20 01:44:10 +01:00
Victor Stinner 7ef60cd8c2 asyncio, Tulip issue #136: Add get/set_debug() methods to BaseEventLoopTests.
Add also a PYTHONASYNCIODEBUG environment variable to debug coroutines since
Python startup, to be able to debug coroutines defined directly in the asyncio
module.
2014-02-19 23:15:02 +01:00
Victor Stinner 03e9cb2b0b asyncio: document new create_unix_connection() and create_unix_server() methods
of BaseEventLoop
2014-02-19 13:32:34 +01:00
Victor Stinner 8b21d91e35 Issue #20493: Document that asyncio should not exceed one day 2014-02-18 09:37:43 +01:00
Victor Stinner 0aba4dc1ed Close #20649: Fix typo in asyncio doc. Patch written by Brett Cannon. 2014-02-18 09:22:00 +01:00
Victor Stinner 38df2adaeb Close #20652: asyncio doc: close the event loop in run_forever() example. Fix
also typo. Patch written by Vajrasky Kok.
2014-02-17 10:54:30 +01:00
Victor Stinner 23f628de4a Issue #20616: Add a format() method to tracemalloc.Traceback. 2014-02-16 23:53:38 +01:00
Andrew Kuchling c77974e033 Merge from 3.3 2014-02-16 12:18:17 -05:00
Andrew Kuchling 3137885c36 #12211: remove paragraph about NaNs 2014-02-16 12:09:35 -05:00
Andrew Kuchling 87a113b807 Merge from 3.3 2014-02-16 11:15:13 -05:00
Andrew Kuchling 8cb1ec3274 #12211: clarify math.copysign() documentation and docstring 2014-02-16 11:11:25 -05:00
Andrew Kuchling a3d0ffe2c6 Merge from 3.3 2014-02-15 17:22:41 -05:00
Andrew Kuchling e5235f1624 #20241: use correct RFC number 2014-02-15 17:11:06 -05:00
Andrew Kuchling ac6e578691 Merge from 3.3 2014-02-15 16:40:08 -05:00
Andrew Kuchling 46ff4ee81c Clarify versionchanged sentence. Closes #20497. 2014-02-15 16:39:37 -05:00
Benjamin Peterson 30f240150e merge 3.3 2014-02-15 15:39:01 -05:00
Andrew Kuchling 4da9ab0357 #20237: make a revision pass over the XML vulnerabilities section 2014-02-15 15:33:44 -05:00
Ezio Melotti 504f6e8653 #19890: merge with 3.3. 2014-02-15 16:59:39 +02:00
Ezio Melotti e426b71789 #19890: fix typo in multiprocessing docs. Patch by Mike Short. 2014-02-15 16:58:52 +02:00
Victor Stinner 28773465e6 ayncio, Tulip issue 129: BaseEventLoop.sock_connect() now raises an error if
the address is not resolved (hostname instead of an IP address) for AF_INET and
AF_INET6 address families.
2014-02-13 09:24:37 +01:00
R David Murray 2167e29d31 whatsnew: os.path.samestat on windows, keyword defaults evaluation order. 2014-02-12 00:02:34 -05:00
R David Murray d630e79cc7 whatsnew: object.__format__ raises TypeError on non-empty string.
See issues #7994 and #9856.  I also modified with wording of the format doc
entry to better match what really happens, and added a versionchanged to the
datamodel object.__format__ section.
2014-02-11 18:34:22 -05:00
Gregory P. Smith bbe3335f65 Deprecate Popen.wait()'s undocumented endtime parameter. issue20572. 2014-02-11 09:21:03 -08:00
Larry Hastings ad88d7a26b Python 3.4.0rc1 release: Updated pydoc topics, fixed suspicious markup errors. 2014-02-10 04:26:10 -08:00
Larry Hastings b082731fbb Issue #20517: Functions in the os module that accept two filenames
now register both filenames in the exception on failure.
This required adding new C API functions allowing OSError exceptions
to reference two filenames instead of one.
2014-02-09 22:05:19 -08:00
Eli Bendersky 136fea253e More complete documentation of event loops and policies.
Documented the AbstractEventLoopPolicy interface explicitly and explained the
relation between the global loop & policy access functions. Added an initial
section that explains the connections in general terms. Documented missing XXX
methods.
2014-02-09 06:55:58 -08:00
Eli Bendersky b73c83318d Various formatting & grammar fixes in asyncio* docs. 2014-02-09 06:07:47 -08:00
Eli Bendersky 8b402629ae Fix typo in library/ipc.rst 2014-02-09 05:54:13 -08:00
Benjamin Peterson 0b094ce170 do not line break reference 2014-02-16 12:46:30 -05:00
Victor Stinner 0c3949c963 asyncio: Remove Process.subprocess attribute; it's too easy to get inconsistent
Process and Popen objects
2014-02-09 02:51:40 +01:00
Brian Curtin c9d1a6b85e merge 2014-02-08 18:36:57 -06:00
Brian Curtin a1afeec9aa Spelling corrections. Submitted to python-dev by python@mrabarnett.plus.com 2014-02-08 18:36:14 -06:00
Victor Stinner 12c68b20b7 asyncio doc: fix gather() doc 2014-02-09 01:35:24 +01:00
Nick Coghlan aa029dad50 Tweaks to What's New and some referenced docs 2014-02-09 10:10:24 +10:00
Nick Coghlan 96bb437ae8 Close #20563: Declare ipaddress API stable 2014-02-09 09:18:26 +10:00
Senthil Kumaran 127242654d merge from 3.3
Include the mention of ResourceWarning being displayed by default by the test runner.
Addressing #issue 20529
2014-02-08 14:28:44 -08:00
Senthil Kumaran 409ea5dac1 Include the mention of ResourceWarning being displayed by default by the test runner.
Addressing #issue 20529
2014-02-08 14:28:03 -08:00
Victor Stinner c1567df61e asyncio doc: document missing event loop methods 2014-02-08 23:22:58 +01:00
Victor Stinner ffbe3c67df asyncio doc: sort methods 2014-02-08 22:50:07 +01:00
Ethan Furman ca1b794dac Close issue20534: all pickle protocols now supported. 2014-02-08 11:36:27 -08:00
Nick Coghlan 73afe2a972 Close #20481: Disallow mixed type input in statistics
The most appropriate coercion rules are not yet clear, so simply
disallowing mixed type input for 3.4.

(Committed on Steven's behalf)
2014-02-08 19:58:04 +10:00
Victor Stinner 85310a50a9 Issue #20505: Remove resolution and _granularity from selectors and asyncio
* Remove selectors.BaseSelector.resolution attribute
* Remove asyncio.BaseEventLoop._granularity attribute
2014-02-07 23:34:58 +01:00
R David Murray 27e9de669b #20531: Revert e20f98a8ed71, the 3.4 version of the #19063 fix. 2014-02-07 12:40:37 -05:00
Victor Stinner 790202d613 asyncio doc: mention that asyncio is not thread-safe 2014-02-07 19:03:05 +01:00
R David Murray 02384bfa94 #20477: add examples of using the new contentmanager API. 2014-02-07 10:55:17 -05:00
Serhiy Storchaka 303718c3d7 Fix empty strings to empty bytes objects. 2014-02-06 21:11:33 +02:00
Serhiy Storchaka 5e028ae09e Fix empty strings to empty bytes objects. 2014-02-06 21:10:41 +02:00
Ethan Furman c72e638643 Close issue20412: Updated Enum docs to have referencable Enum and IntEnum classes 2014-02-06 08:13:14 -08:00
Brett Cannon 3303b6abc8 Merge for issue #20488 2014-02-06 09:49:53 -05:00
Brett Cannon 07fbd78473 Issue #20488: Update docs to say importlib is *the* implementaiton of
import and not *an* implementation.
2014-02-06 09:46:08 -05:00
Ronald Oussoren 94e44a935b Issue #14455: fix handling of unsigned long long values for binary plist files
Values in the range of an unsigned long long, but outside of the range
of a signed long long were serialized as a negative value.

Due to a bug in PyObjC my test scripts indicated that the previous behavior
matched Apple's plist code, instead the handle large unsigned values correctly.

The change to plistlib.py is from a patch by Serhiy.
2014-02-06 11:19:18 +01:00
R David Murray 58af25e930 #14515: clarify that TemporaryDirectory's __enter__ returns the name. 2014-02-05 14:56:39 -05:00
R David Murray 23686074b0 #14515: clarify that TemporaryDirectory's __enter__ returns the name. 2014-02-05 14:53:40 -05:00
Guido van Rossum 3c9bb69fa1 Add missing word ("thread") to sentence about call_soon_threadsafe. 2014-02-04 13:49:34 -08:00
Victor Stinner 5cb84ed5b1 asyncio doc: add an example to schedule a coroutine from a different thread 2014-02-04 18:18:27 +01:00
Vinay Sajip d8b24d756a Closes #20509: Merged documentation update from 3.3. 2014-02-04 16:42:04 +00:00
Vinay Sajip 6068b6c977 Issue #20509: Added cross-reference in documentation. 2014-02-04 16:28:07 +00:00
Victor Stinner e48d4db000 asyncio doc: add an example of asyncio.subprocess with communicate() and wait() 2014-02-03 23:26:28 +01:00
Victor Stinner b79eb0502c asyncio.subprocess: Replace Process.get_subprocess() method with a
Process.subprocess read-only property
2014-02-03 23:08:14 +01:00
Benjamin Peterson 233eac42d4 remove extra backtick 2014-02-03 14:08:00 -05:00
Victor Stinner 3bc647c0fa Issue #20472: asyncio: Adjust the note about Mac OS X on PTY, specify that it
requires at least Mac OS X 10.6.
2014-02-03 00:35:46 +01:00
Antoine Pitrou 9c2389d282 Issue #20423: fix documentation of io.StringIO's newline parameter 2014-02-02 22:49:03 +01:00
Antoine Pitrou be7ff9f2f9 Issue #20423: fix documentation of io.StringIO's newline parameter 2014-02-02 22:48:25 +01:00
Victor Stinner 084443809f asyncio: document the new asyncio.subprocess module 2014-02-02 22:43:39 +01:00
R David Murray 4885f49e7f whatsnew: filecmp.clear_cache, and reword description of cache in docs. 2014-02-02 11:11:01 -05:00
Victor Stinner 9592edb834 asyncio doc: add "asyncio-" prefix to references 2014-02-02 15:03:02 +01:00
Victor Stinner 606ab031c1 asyncio doc: add "Concurrency and multithreading" section 2014-02-01 03:18:58 +01:00
Victor Stinner 45b27ed53d asyncio doc: document the granularity of the event loop
Improve also the "Logging" section
2014-02-01 02:36:43 +01:00
Zachary Ware 607bc3dd82 Merge with 3.3 2014-01-31 11:31:14 -06:00
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
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
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 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