Commit Graph

6165 Commits

Author SHA1 Message Date
Benjamin Peterson dbd4bcfcca correct versionchanged version 2014-11-23 20:09:31 -06:00
Benjamin Peterson 7243b574e5 don't require OpenSSL SNI to pass hostname to ssl functions (#22921)
Patch by Donald Stufft.
2014-11-23 17:04:34 -06:00
Benjamin Peterson 378e15d7ab document that cadefault does nothing now 2014-11-23 11:43:33 -06:00
Serhiy Storchaka f751a9e6a2 Issue #22845: Improved formatting of dis documentation. 2014-11-11 10:02:11 +02:00
Berker Peksag 4900877bca Issue #22839: Fix Snapshot.statistics() link. 2014-11-10 23:15:32 +02:00
Raymond Hettinger 86e9b6b164 Issue 22830: Clarify docs for functools.cmp_to_key(). 2014-11-09 17:20:56 -08:00
Berker Peksag b556399fb5 Issue #22808: Link to the correct time method in BaseEventLoop.call_at().
Patch by Mark Grandi.
2014-11-07 19:51:07 +02:00
Raymond Hettinger dc69e03ef3 Issue 22803: Add missing versionadded directive. 2014-11-05 21:27:56 -08:00
Georg Brandl b9b389efed Closes #22525: clarify documentation for ast.literal_eval(). 2014-11-05 20:20:28 +01:00
Benjamin Peterson 4ffb075271 PEP 476: enable HTTPS certificate verification by default (#22417)
Patch by Alex Gaynor with some modifications by me.
2014-11-03 14:29:33 -05:00
Benjamin Peterson a5c9c37dd5 wrap 2014-11-02 13:17:56 -05:00
Senthil Kumaran 8b7e161ac3 backport context argument of urlopen (#22366) for pep 476 2014-09-19 15:23:30 +08:00
R David Murray 64f10d4f5e Reflow paragraph. 2014-11-02 12:32:26 -05:00
R David Murray 3ca68e77b8 Fix English phrasing. 2014-11-02 12:31:47 -05:00
Georg Brandl 36ac510956 Closes #22771: "verbose" is unused; deprecate it. 2014-10-31 10:54:06 +01:00
Georg Brandl 8ed75cd8e9 #22613: minor other fixes in library docs (thanks Jacques Ducasse) 2014-10-31 10:25:48 +01:00
Georg Brandl 2677faecf5 #22613: document Cmd.cmdqueue (thanks Jacques Ducasse) 2014-10-31 10:25:38 +01:00
Georg Brandl 717e02896f #22613: fix heading levels in tracemalloc docs (thanks Jacques Ducasse) 2014-10-31 10:21:07 +01:00
Georg Brandl 9b1b0e54e7 #22613: elaborate on arguments of shutil archival functions (thanks Jacques Ducasse) 2014-10-31 10:02:40 +01:00
Georg Brandl f30132fdc9 #22613: explain what "buffer" is in the struct documentation (thanks Jacques Ducasse) 2014-10-31 09:46:41 +01:00
Georg Brandl e4196d3f2e #22613: fix several factual errors in builtin docs (thanks Jacques Ducasse) 2014-10-31 09:41:46 +01:00
Georg Brandl 4433ff958b unittest.mock docs: fix use of default role 2014-10-31 07:59:37 +01:00
Georg Brandl ef08bde8b8 minor markup fix: no inline markup is allowed in a module synopsis 2014-10-30 22:45:27 +01:00
Georg Brandl 6b4c847c4f Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:26:26 +01:00
Georg Brandl b7354a65ce Fixing broken links in doc, part 4: some more breaks and redirects 2014-10-29 10:57:37 +01:00
Georg Brandl 525d355984 Fixing broken links in doc, part 3: the rest 2014-10-29 10:26:56 +01:00
Georg Brandl 728e4debd8 Fix external links to docs.python.org to use internal links instead. 2014-10-29 09:00:30 +01:00
Georg Brandl e73778c1ac Use https:// URLs when referring to python.org hosts. 2014-10-29 08:36:35 +01:00
Georg Brandl ce64cedff4 Fix module name. 2014-10-28 22:58:24 +01:00
Georg Brandl 946faa39e3 Using "-m module" is easier to read and understand than "-mmodule". 2014-10-28 22:54:24 +01:00
Georg Brandl 2b07b0e868 Closes #22249: use IPPROTO_TCP constant instead of SOL_TCP constant for getaddrinfo() proto param 2014-10-28 22:45:27 +01:00
Georg Brandl c943e79384 Remove duplicate bullet point. 2014-10-28 22:40:48 +01:00
Georg Brandl bb2d669292 Closes #22736: move seealso to the bottom of the section about RE syntax. 2014-10-28 21:41:51 +01:00
Georg Brandl 01546a88b8 Closes #22749: remove outdated advice to use clock() for accurate timing. 2014-10-28 21:35:35 +01:00
Ezio Melotti 788f2adeae #22196: link to Enum in the nametuple documentation. Patch by Karmen Dykstra. 2014-10-28 15:07:14 +01:00
Ezio Melotti 9b1e92f5a1 #22237: document that sorted() is guaranteed to be stable. Initial patch by Martin Panter. 2014-10-28 12:57:11 +01:00
Nick Coghlan 3894ae20ea Issue #22711: improve links in new distribution docs
- key term hyperlinks for distutils, setuptools & wheel
- distutils landing page links directly to setuptools docs
- short summary of setuptools benefits provided with link
2014-10-26 00:00:04 +10:00
Victor Stinner 2cef300187 asyncio doc: fix typo in an example 2014-10-23 22:38:46 +02:00
Victor Stinner c803bd84b5 Issue #22695: Fix syntax of open() doc 2014-10-22 09:55:44 +02:00
Antoine Pitrou 4b4ddb2190 Issue #22660: update various mentions in the ssl module documentation. 2014-10-21 00:14:39 +02:00
Jesus Cea 67503c5f1c Docs: 'os.pwrite()' needs bytes, not strings 2014-10-20 16:18:24 +02:00
Benjamin Peterson 0fc08fd2c7 merge 3.3 2014-10-19 10:47:58 -04:00
Benjamin Peterson 9fc59c9fc2 make plural s lowercase 2014-10-19 10:47:49 -04:00
Victor Stinner 7f314ed71b asyncio doc: write simpler examples to introduce asyncio 2014-10-15 18:49:16 +02:00
Ethan Furman 7184bac544 Issue20386: SocketType is again socket.socket; the IntEnum SOCK constants are SocketKind 2014-10-14 18:56:53 -07:00
Victor Stinner 39892055cd asyncio doc: rewrite subprocess doc
* add a new example using transport and protocol
* rewrite the example using streams to make it much simpler (remove error
  handling, use a simpler Python code)
* copy (and adapt) more documentation from the subprocess module:

  - add a note about Process.wait() deadlock
  - add a note about shell injection
  - etc.

* sort Process methods and attributes in the same order than subprocess.Popen
  methods and attributes, so the documentation looks closer
* list differences between Process and subprocess.Popen APIs
2014-10-14 00:52:07 +02:00
Victor Stinner 3c95062f52 asyncio doc: protocol_factory of subprocess_exec() and subprocess_shell() must
instanciate a subclass of SubprocessProtocol
2014-10-14 00:02:10 +02:00
Victor Stinner 4270a24dd9 asyncio doc: document BaseSubprocessTransport.close() method
Modify also the get_pipe_transport() doc to mention explicitly the supported
file descriptors.
2014-10-13 23:56:43 +02:00
Benjamin Peterson 157da6fdd2 merge 3.3 2014-10-13 11:55:02 -04:00
Benjamin Peterson 77a75b3db1 note xmlrpclib doesn't verify certs (yet) 2014-10-13 11:54:50 -04:00
Victor Stinner ed8e3a987e asyncio: add missing @coroutine decorator 2014-10-13 00:55:50 +02:00
Victor Stinner ab1c853079 asyncio doc: update debug traces 2014-10-12 21:37:16 +02:00
Victor Stinner 980dd84f92 asyncio doc: more explicit doc for async()
The function schedules the execution of coroutines, it's not just a wrapper for
something.
2014-10-12 21:36:17 +02:00
Victor Stinner 33f6abe4ae asyncio doc: reformat create_server() doc
Fix also the reate_unix_connection() doc: the method is not support on Windows,
not need to mention that ssl is not support with ProactorEventLoop.
2014-10-12 20:36:04 +02:00
Victor Stinner ed051594d7 asyncio doc: add TCP echo client/server using streams 2014-10-12 20:18:16 +02:00
Georg Brandl 62b08136d7 Closes #22586: clarify meaning of allow_fragments in urlparse. 2014-10-12 16:13:32 +02:00
Victor Stinner 5366434336 asyncio doc: enhance TCP client example 2014-10-12 11:35:09 +02:00
Victor Stinner cfbea3a02e asyncio doc: clarify how servers create protocol instances 2014-10-12 11:30:17 +02:00
Victor Stinner c7edffdddd asyncio doc: add UDP client and server examples 2014-10-12 11:24:26 +02:00
Victor Stinner c2721b41d3 asyncio doc: use server.wait_closed() in TCP echo server example 2014-10-12 11:13:40 +02:00
Berker Peksag edd6ec2dd3 Issue #22613: Fix reprlib.Repr subclass example on Python 3.
Reported by Jacques Ducasse.
2014-10-12 05:11:16 +03:00
Nick Coghlan 36d8ef9cc7 Issue #21061: correctly note redirect_stdout is reentrant 2014-10-12 10:25:00 +10:00
Victor Stinner ccd8e34508 asyncio doc: socket.socketpair() is not available on Windows yet 2014-10-11 16:30:02 +02:00
Victor Stinner 04e6df330d asyncio doc: add examples showing the 3 ways to wait for data from an open
socket
2014-10-11 16:16:27 +02:00
Victor Stinner 6888b96cee asyncio doc: cleanup Hello World examples 2014-10-11 16:15:58 +02:00
Victor Stinner 5121a9ba4a asyncio doc: the "Get HTTP headers" example now supports HTTPS 2014-10-11 15:52:14 +02:00
Georg Brandl dbf8344404 Closes #18959: move optparse and imp to new "superseded modules" chapter 2014-10-11 14:47:11 +02:00
Georg Brandl c5dd095a9b Closes #21675: fix ordering of description in library intro 2014-10-11 14:32:34 +02:00
Zachary Ware a13dab47cb Issue #15414: Clean and correct the os.path.join docs.
In particular, correctly describe the behavior of ntpath.join.

Based on a patch by Dave Sawyer.
2014-10-10 16:03:14 -05:00
Terry Jan Reedy f9bd920cfa Issue 22603: add missing 'self'. Patch by Francisco Fernández Castaño. 2014-10-10 16:00:18 -04:00
Victor Stinner cfb2a0a855 Issue #22564: ssl doc: mention asyncio in the non-blocking section 2014-10-10 12:45:10 +02:00
Victor Stinner d28fe8c8f4 Issue #22564: ssl doc: mention how SSLSocket are usually created 2014-10-10 12:07:19 +02:00
Victor Stinner 3c3d3c73f3 Issue #22564: ssl doc: use "class" marker to document the SSLSocket class 2014-10-10 12:06:51 +02:00
Victor Stinner 41f92c2818 Issue #22564: ssl doc: document read(), write(), pending, server_side and
server_hostname methods and attributes of SSLSocket.
2014-10-10 12:05:56 +02:00
Victor Stinner 851a6cc071 Issue #22564: ssl doc: fix typos 2014-10-10 12:04:15 +02:00
R David Murray 7445a383a6 #18176: updated stdtypes UCD link, added reminder to makeunicodedata.
Patch by Alexander Belopolsky.
2014-10-09 17:30:33 -04:00
Berker Peksag b2fdafe3d2 Issue #22576: Fix signatures of FTP.storbinary() and FTP.storlines() methods.
The correct parameter name is "fp", not "file".
2014-10-08 13:15:04 +03:00
Larry Hastings 2ce95d7b7c Merge from 3.4.2 release head back into 3.4 mainline. 2014-10-08 02:50:50 -07:00
Georg Brandl 7fa4a8f15a Closes #12148: clarify "or's together option flags" in doctest docs. 2014-10-06 16:56:43 +02:00
Georg Brandl eb7e8f607e Document builtin classes as such, not functions. 2014-10-06 13:54:36 +02:00
Terry Jan Reedy c6ad57608b Issue #22546: update doc for mini-language float None presentation type. 2014-10-06 02:04:33 -04:00
Larry Hastings c6256e5f7d Update pydoc topics and fix supsicious markup for 3.4.2 final. 2014-10-05 19:03:48 -07:00
R David Murray 9db487b31f #14201: Update ctypes docs to match behavior changed from 214b28d7a999.
Original patch by Erik Johansson, slightly updated by Meador Inge.
2014-10-04 18:25:07 -04:00
R David Murray bf92bceaaa #14056: Small improvements to the tarfile documentation.
Patch by Éric Araujo with help from Lars Gustäbel.
2014-10-03 20:18:48 -04:00
Zachary Ware 7280561b5b Fix a few typo/grammar issues in the multiprocessing docs.
Reported by Scott Hinton on docs@.
2014-10-03 10:55:12 -05:00
Georg Brandl 3f1ef9efd5 Closes #18729: minor markup improvement. 2014-10-02 12:37:50 +02:00
Georg Brandl c0a8f8ce84 closes #22528: add source links to symtable and compileall 2014-10-02 08:38:39 +02:00
Terry Jan Reedy 6e978d2754 Issue #21971: Index and update turtledemo doc. 2014-10-02 00:16:31 -04:00
Terry Jan Reedy 1895f2b544 Issue 22492: Be explicit that print does not support binary mode files.
Original patch by Georg Brandl.
2014-10-01 15:37:42 -04:00
Benjamin Peterson 45d929dc64 add link to pdb source (closes #22528) 2014-09-30 16:02:06 -04:00
Berker Peksag 9c1dba2758 Revert #22251 2014-09-28 00:00:58 +03:00
Berker Peksag 3749404ba5 Issue #22251: Fix ReST markup to avoid errors building docs. 2014-09-27 23:21:35 +03:00
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