openstack/deb-python-eventlet
Code Issues Proposed changes

Consolidated tpool and threading documentation.

Browse Source
This commit is contained in:
Ryan Williams
2010-01-02 08:56:42 -08:00
parent ed301bd5bd
commit 9791fefac6
3 changed files with 10 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
doc/modules.rst
View File

@@ -16,6 +16,5 @@ Module Reference
modules/processes modules/processes
modules/proc modules/proc
modules/saranwrap modules/saranwrap
modules/tpool
modules/util modules/util
modules/wsgi modules/wsgi

6
doc/modules/tpool.rst
View File

@@ -1,6 +0,0 @@
:mod:`tpool` -- Thread pooling
================================
.. automodule:: eventlet.tpool
:members:

12
doc/threading.rst
View File

@@ -1,5 +1,5 @@
Using Eventlet with Threads Threads
============================= ========
Eventlet is thread-safe and can be used in conjunction with normal Python threads. The way this works is that coroutines are confined to their 'parent' Python thread. It's like each thread contains its own little world of coroutines that can switch between themselves but not between coroutines in other threads. Eventlet is thread-safe and can be used in conjunction with normal Python threads. The way this works is that coroutines are confined to their 'parent' Python thread. It's like each thread contains its own little world of coroutines that can switch between themselves but not between coroutines in other threads.
@@ -9,6 +9,11 @@ You can only communicate cross-thread using the "real" thread primitives and pip
The vast majority of the times you'll want to use threads are to wrap some operation that is not "green", such as a C library that uses its own OS calls to do socket operations. The :mod:`~eventlet.tpool` module is provided to make these uses simpler. The vast majority of the times you'll want to use threads are to wrap some operation that is not "green", such as a C library that uses its own OS calls to do socket operations. The :mod:`~eventlet.tpool` module is provided to make these uses simpler.
The pyevent hub is not compatible with threads.
Tpool - Simple thread pool
---------------------------
The simplest thing to do with :mod:`~eventlet.tpool` is to :func:`~eventlet.tpool.execute` a function with it. The function will be run in a random thread in the pool, while the calling coroutine blocks on its completion:: The simplest thing to do with :mod:`~eventlet.tpool` is to :func:`~eventlet.tpool.execute` a function with it. The function will be run in a random thread in the pool, while the calling coroutine blocks on its completion::
>>> import thread >>> import thread
@@ -20,3 +25,6 @@ The simplest thing to do with :mod:`~eventlet.tpool` is to :func:`~eventlet.tpoo
running in new thread: True running in new thread: True
My default there are 20 threads in the pool, but you can configure this by setting the environment variable ``EVENTLET_THREADPOOL_SIZE`` to the desired pool size before importing tpool. My default there are 20 threads in the pool, but you can configure this by setting the environment variable ``EVENTLET_THREADPOOL_SIZE`` to the desired pool size before importing tpool.
.. automodule:: eventlet.tpool
:members: