openstack/deb-python-eventlet
Code Issues Proposed changes

Pruning docs.

Browse Source
This commit is contained in:
Ryan Williams
2010-01-29 16:21:47 -08:00
parent 04a5459bfb
commit 84eb240231
2 changed files with 4 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
doc/index.rst
View File

@@ -3,12 +3,12 @@ Eventlet
Eventlet is a networking library written in Python. It achieves high scalability by using `non-blocking io <http://en.wikipedia.org/wiki/Asynchronous_I/O#Select.28.2Fpoll.29_loops>`_ while at the same time retaining high programmer usability by using `coroutines <http://en.wikipedia.org/wiki/Coroutine>`_ to make the non-blocking io operations appear blocking at the source code level. Eventlet is a networking library written in Python. It achieves high scalability by using `non-blocking io <http://en.wikipedia.org/wiki/Asynchronous_I/O#Select.28.2Fpoll.29_loops>`_ while at the same time retaining high programmer usability by using `coroutines <http://en.wikipedia.org/wiki/Coroutine>`_ to make the non-blocking io operations appear blocking at the source code level.
Eventlet is different from other event-based frameworks out there because it doesn't require you to restructure your code to use it. You don't have to rewrite your code to use callbacks, and you don't have to replace your main() method with some sort of dispatch method. You can just sprinkle eventlet on top of your code. Eventlet is different from other event-based frameworks out there because it doesn't require you to restructure your code to use it. You don't have to rewrite your code to use callbacks, and you don't have to replace your main() method with some sort of dispatch method. You can just sprinkle eventlet on top.
Web Crawler Example Simple Example
------------------- -------------------
This is a simple web crawler that fetches a bunch of urls using a coroutine pool. It has as much concurrency (i.e. pages being fetched simultaneously) as coroutines in the pool:: This is a simple web crawler that fetches a bunch of urls concurrently.
urls = ["http://www.google.com/intl/en_ALL/images/logo.gif", urls = ["http://www.google.com/intl/en_ALL/images/logo.gif",
"https://wiki.secondlife.com/w/images/secondlife.jpg", "https://wiki.secondlife.com/w/images/secondlife.jpg",
@@ -20,7 +20,7 @@ This is a simple web crawler that fetches a bunch of urls using a coroutine pool
def fetch(url): def fetch(url):
return urllib2.urlopen(url).read() return urllib2.urlopen(url).read()
pool = eventlet.GreenPool(200) pool = eventlet.GreenPool()
for body in pool.imap(fetch, urls): for body in pool.imap(fetch, urls):
print "got body", len(body) print "got body", len(body)
@@ -43,22 +43,6 @@ Contents
authors authors
Requirements
------------
Eventlet runs on Python version 2.4 or greater, with the following dependencies:
* `Greenlet <http://cheeseshop.python.org/pypi/greenlet>`_
* `pyOpenSSL <http://pyopenssl.sourceforge.net/>`_
Areas That Need Work
--------------------
* Not enough test coverage -- the goal is 100%, but we are not there yet.
* Not well-tested on Windows, though it is a supported platform and bug reports are encouraged.
* The :mod:`eventlet.processes` module is known to not work on Windows.
License License
--------- ---------
Eventlet is made available under the terms of the open source `MIT license <http://www.opensource.org/licenses/mit-license.php>`_ Eventlet is made available under the terms of the open source `MIT license <http://www.opensource.org/licenses/mit-license.php>`_

2
doc/modules.rst
View File

@@ -4,13 +4,11 @@ Module Reference
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
modules/api
modules/backdoor modules/backdoor
modules/corolocal modules/corolocal
modules/debug modules/debug
modules/db_pool modules/db_pool
modules/event modules/event
modules/greenio
modules/greenpool modules/greenpool
modules/greenthread modules/greenthread
modules/pools modules/pools