Yury Selivanov
bb96134368
asyncio.docs: Use less confusing title
2015-06-25 11:54:34 -04:00
Yury Selivanov
7185461897
docs/asyncio: Document set_task_factory/get_task_factory
2015-05-11 16:28:27 -04:00
Victor Stinner
83704963c0
asyncio: add a note about (non) thread safety in each class
2015-02-25 14:24:15 +01:00
Victor Stinner
bdd574d09a
asyncio doc: annotate coroutine on coroutine functions and methods
2015-02-12 22:49:18 +01:00
R David Murray
756f0b1982
Fix asyncio doc typo.
2015-01-29 19:53:33 -05:00
Victor Stinner
a092a615f5
asyncio doc: fix section of event loop examples
2015-01-09 15:58:41 +01:00
Victor Stinner
4d5115c7b5
asyncio doc: call_soon() does not call immediatly the callback. Patch written
...
by Martin Panter.
2014-12-15 17:50:55 +01:00
Victor Stinner
8464c24c82
asyncio doc: explain how to pass keywords to callbacks (functools.partial)
2014-11-28 13:15:41 +01: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
Victor Stinner
2cef300187
asyncio doc: fix typo in an example
2014-10-23 22:38:46 +02:00
Victor Stinner
7f314ed71b
asyncio doc: write simpler examples to introduce asyncio
2014-10-15 18:49:16 +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
c7edffdddd
asyncio doc: add UDP client and server examples
2014-10-12 11:24:26 +02: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
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
Victor Stinner
41f3c3f226
Closes #22275 : asyncio: enhance documentation of OS support
2014-08-31 14:47:37 +02: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
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
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
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
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
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
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
Victor Stinner
d143209d7f
Tulip issue 83: document more asyncio functions in docstrings
2014-06-19 17:11:49 +02: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
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
f9e49dd346
Tulip issue 83, Python issue #21252 : Fill some XXX docstrings in asyncio
2014-06-05 12:06:44 +02: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
984600fba7
Issue #21006 : asyncio doc: reorganize subprocess doc
2014-03-25 09:40:26 +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
Larry Hastings
3732ed2414
Merge in all documentation changes since branching 3.4.0rc1.
2014-03-15 21:13:56 -07:00
Yury Selivanov
53281b1626
asyncio.docs: Document subprocess_exec and subprocess_shell. Issue #20694 .
2014-02-20 20:10:28 -05:00
Yury Selivanov
37f15bcfed
asyncio.docs: Improve wordings; add a note to the Coroutines section. Issue #20706
2014-02-20 16:20:44 -05:00
Yury Selivanov
43ee1c1325
asyncio.docs: Document Error Handling API and asyncio.Handle
2014-02-19 20:58:44 -05:00
Victor Stinner
1415e25e05
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
0f3e6bca1b
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
a6919aa4ed
asyncio: document new create_unix_connection() and create_unix_server() methods
...
of BaseEventLoop
2014-02-19 13:32:34 +01:00
Victor Stinner
fd9d374ae9
Issue #20493 : Document that asyncio should not exceed one day
2014-02-18 09:37:43 +01:00
Victor Stinner
1b0580b320
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
Larry Hastings
ad88d7a26b
Python 3.4.0rc1 release: Updated pydoc topics, fixed suspicious markup errors.
2014-02-10 04:26:10 -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
Victor Stinner
c1567df61e
asyncio doc: document missing event loop methods
2014-02-08 23:22:58 +01: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
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
Victor Stinner
084443809f
asyncio: document the new asyncio.subprocess module
2014-02-02 22:43:39 +01:00
Victor Stinner
9592edb834
asyncio doc: add "asyncio-" prefix to references
2014-02-02 15:03:02 +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
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
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
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
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
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
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
59759ff234
asyncio doc: replace "coroutine" with "coroutine object" or "coroutine function"
2014-01-16 19:30:21 +01:00
R David Murray
6a14381530
Fix Sphinx markup for asyncio modules so :mod:`asyncio` links work.
2013-12-20 14:37:39 -05: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
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
afbf827875
asyncio doc: fix definition of stop() method
2013-12-03 02:05:42 +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