Commit Graph

6173 Commits

Author SHA1 Message Date
R David Murray 9cc5fd7b59 #18854: make it explicit that is_multipart does not mean 'multipart/xxx'.
Original patch (and the idea of using _structure) by Abhilash Raj.
2014-09-27 15:37:40 -04:00
R David Murray 1f3a88fe55 #20974: Update version table in email intro.
Note that the email version string in 3.3 and 3.4 is inaccurate, since it
still exists but wasn't updated while the code was.
2014-09-27 14:59:36 -04:00
Berker Peksag 6c1f0ad665 Issue #17462: Add a paragraph about advantages of argparse over optparse.
Patch by Anastasia Filatova.
2014-09-26 15:34:26 +03:00
R David Murray 22dd8334cd Improve English phrasing in asyncio task docs. 2014-09-24 11:09:09 -04:00
Benjamin Peterson eb83ffe1b3 fix error in split() examples (closes #22459)
Patch by Raúl Cumplido.
2014-09-22 22:43:50 -04:00
Jesus Cea ca2e02cfe6 Typo: headeronly -> headersonly 2014-09-22 00:43:39 +02:00
Antoine Pitrou afe8d0646c Issue #21332: Ensure that ``bufsize=1`` in subprocess.Popen() selects line buffering, rather than block buffering. 2014-09-21 21:10:56 +02:00
R David Murray 8a97896a76 #21091: make is_attachment a method.
Since EmailMessage is a provisional API we can fix API bugs in a
maintenance release, but I used a trick suggested by Serhiy to
maintain backward compatibility with 3.4.0/1.
2014-09-20 18:05:28 -04:00
Vinay Sajip 2f1cd8a7fc Issue #22436: Improved documentation for getEffectiveLevel() and getLevelName(). 2014-09-18 18:01:12 +01:00
Berker Peksag 2d510e3bab Issue #14824: Update Repr.repr_TYPE documentation to use correct name mangling implementation.
Patch by Chris Rebert.
2014-09-18 06:05:14 +03:00
Ethan Furman f75805edb8 Issue21738: clarify usage of __new__ in Enum subclasses 2014-09-16 19:13:31 -07:00
Vinay Sajip d1d4fbff63 Issue #22386: fixed regression. 2014-09-11 23:06:09 +01:00
Serhiy Storchaka 148679982f Issue #22369: Change "context manager protocol" to "context management protocol". 2014-09-10 23:43:41 +03:00
Nick Coghlan af117ed3d7 Issue #22346: also include asyncio PEP 411 notice in 3.4 2014-09-06 19:43:06 +10:00
Victor Stinner 41f3c3f226 Closes #22275: asyncio: enhance documentation of OS support 2014-08-31 14:47:37 +02:00
Benjamin Peterson e218bcbf39 getuid() returns real process id not effective (closes #22307) 2014-08-30 21:04:15 -04:00
Victor Stinner d84fd73de2 Issue #22063: Fix asyncio documentation of socket and pipe operations regarding
to non-blocking mode. The non-blocking mode does not matter when using a
ProactorEventLoop, only for SelectorEventLoop.
2014-08-26 01:01:59 +02:00
Victor Stinner 52bb949fd3 asyncio, tulip issue 203: Add _FlowControlMixin.get_write_buffer_limits() method 2014-08-26 00:22:28 +02:00
Victor Stinner d71dcbb043 asyncio: update the doc
* dev: mention that the logging must be configured at DEBUG level
* streams: drain() has no more a strange return value, it's just
  a standard coroutine
2014-08-25 17:04:12 +02:00
Terry Jan Reedy ee55826072 Issue #13540: add missing markup. 2014-08-23 22:21:47 -04:00
Zachary Ware f9dd274692 Issue #22178: Fix the date of the Windows epoch (Jan 1, 1601). 2014-08-11 15:00:48 -05:00
Victor Stinner 337e03ff78 Issue #22112, asyncio doc: replace loop.create_task(coro) with
asyncio.async(coro), mention that asyncio.async() can be used to scheduler a
coroutine, and make it clear that create_task() is only available in Python
3.4.2 and later.
2014-08-11 01:11:13 +02:00
Raymond Hettinger ac191ce1d3 Issue #22174: Clean-up grammar and ambiguities in property() docs. 2014-08-10 10:41:25 -07:00
Raymond Hettinger 31b3683d9b Issue #22180: Remove weak example 2014-08-10 10:33:03 -07:00
Nick Coghlan e4936b830c Issue #21777: separate docs for binary sequence methods 2014-08-09 16:14:04 +10:00
Vinay Sajip 12d9ddf532 Issue #22130: Corrected fileConfig() documentation. 2014-08-05 10:34:16 +01:00
Ezio Melotti 67f6d5f4d0 #21928: clarify functools.wraps docs. 2014-08-05 08:14:28 +03:00
Ezio Melotti 591176e544 #18588: update the timeit examples to be consistent. 2014-08-04 17:01:16 +03:00
Raymond Hettinger c6f22cc0a6 Remove unused leftover stray line 2014-08-04 00:21:11 -07:00
Raymond Hettinger c0de59bfc3 Fix markup. 2014-08-03 23:44:30 -07:00
Raymond Hettinger c566431bf0 Improve regex tokenizer example by using re.finditer().
Also, improve variable names and fix column numbers
in the generated output.
2014-08-03 23:38:54 -07:00
Jason R. Coombs b3d4c212f7 Issue #13540: Merge changes from 3.3 2014-08-03 15:26:58 -04:00
Jason R. Coombs 89e186f24e Issue #13540: Merge changes from 3.2 2014-08-03 15:26:32 -04:00
Jason R. Coombs 79690ac1d0 Issue #13540: Update references to Action class to match syntax used for other classes in this file. 2014-08-03 14:54:11 -04:00
Raymond Hettinger 400daedb13 Fix whitespace in example. 2014-08-02 22:32:10 -07:00
Victor Stinner ec2ce092a2 Issue #22063: Mention in asyncio documentation that socket operations require
the socket to be non-blocking
2014-07-29 23:12:22 +02:00
Andrew Svetlov f200ce6333 Document lock parameter for asyncio.Condition() 2014-07-26 19:50:37 +03:00
Zachary Ware 88a1977a08 Issue #22072: Fix a couple of SSL doc typos. Patch by Alex Gaynor. 2014-07-25 13:30:50 -05:00
Victor Stinner 45cff66cf6 Issue #16133: The asynchat.async_chat.handle_read() method now ignores
BlockingIOError exceptions. Initial patch written by Xavier de Gaye.

Document also in asyncore documentation that recv() may raise BlockingIOError.
2014-07-24 18:49:36 +02:00
Victor Stinner 992019c006 Backport os.rst documentation from Python 3.5. 2014-07-24 12:42:45 +02:00
Victor Stinner 6d4f4feca2 Issue #21813: Enhance documentation of the os.stat_result class. 2014-07-24 12:42:16 +02:00
Andrew Svetlov ca4f34366a Fix incomplete sentence in asyncio docs. 2014-07-24 11:36:33 +03:00
Terry Jan Reedy 9ff41803af Asyncio doc fixes: spelling, grammar, duplication. 2014-07-24 02:59:02 -04:00
Terry Jan Reedy c935a9530c Englich grammar nit. 2014-07-24 02:33:14 -04:00
Terry Jan Reedy 9f5388f24f Fix doc example bug reported on python-list by Akshay Verma. 2014-07-23 20:30:29 -04:00
Zachary Ware f012ba42fe Issue #22002: Make full use of test discovery in test sub-packages.
Adds `load_package_tests` function to test.support, uses it in test_asyncio,
test_email, test_json, test_tools, test_importlib and all test_importlib
sub-packages to implement test discovery.
2014-07-23 12:00:29 -05:00
Andrew Svetlov 588517ca63 Fix grammar 2014-07-23 11:27:17 +03:00
Jason R. Coombs eb0ef415d5 Issue #13540: Removed redundant documentation about Action instance attributes. Updated example and documentation per recommendations by Steven Bethard in msg149524. 2014-07-20 10:52:46 -04:00
Mark Dickinson e004c6cad5 Issue #22006: Remove outdated _thread caveat. Thanks Dan O'Reilly for the report. 2014-07-19 21:45:06 +01:00
Zachary Ware 0069eac0e5 Issue #22004: Correct an argument name. 2014-07-18 09:11:48 -05:00
Victor Stinner d55b54d5c0 asyncio, tulip issue 190: Process.communicate() now ignores
ConnectionResetError too
2014-07-17 13:12:03 +02:00
Victor Stinner cc996b5789 asyncio, tulip issue 190: Process.communicate() must ignore BrokenPipeError
If you want to handle the BrokenPipeError, you can easily reimplement
communicate().

Add also a unit test to ensure that stdin.write() + stdin.drain() raises
BrokenPipeError.
2014-07-17 12:25:27 +02:00
Berker Peksag 38bf87c7f2 Issue #21994: Fix SyntaxError in the SSLContext.check_hostname documentation. 2014-07-17 05:00:36 +03:00
Zachary Ware 8faecbfb42 Fix a minor typo in the turtle docs. Found by Brandon Passmore on docs@. 2014-07-16 14:48:48 -05:00
Raymond Hettinger 8323f68f3e Issue 21977: Minor improvements to the regexes in the tokenizer example. 2014-07-14 01:52:00 -07:00
Victor Stinner 4bfb14ac10 asyncio: Server.close() leaves client sockets open 2014-07-12 03:20:24 +02:00
Victor Stinner 8ebeb03740 asyncio: improve the documentation of servers
- Fix the documentation of Server.close(): it closes sockets
- Replace AbstractServer with Server
- Document Server.sockets attribute
2014-07-11 23:47:40 +02:00
Victor Stinner 778015b3bc asyncio: enhance documentation of platform support 2014-07-11 12:13:39 +02:00
Berker Peksag 740c730086 Issues #21948 and #16040: Fix typos. 2014-07-09 20:15:28 +03:00
Victor Stinner aea82293be Issue #21680: Document asyncio event loops 2014-07-08 23:42:38 +02:00
Victor Stinner 530ef2f069 Update asyncio documentation
- Document the new create_task() method
- "Hide" the Task class: point to the create_task() method for interoperability
- Rewrite the documentation of the Task class
- Document the "Pending task destroyed"
- Update output in debug mode of examples in the dev section
- Replace Task() with create_task() in examples
2014-07-08 12:39:10 +02:00
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