openstack/deb-python-eventlet
Code Issues Proposed changes

Deprecated coros.Actor, tweaked README and testing docs.

Browse Source
This commit is contained in:
Ryan Williams
2010-01-18 23:32:47 -08:00
parent 52e1522af4
commit 5bbac943b7
3 changed files with 22 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
README
View File

@@ -1,14 +1,22 @@
Getting Started Getting Started
=============== ===============
There's some good documentation up at: http://eventlet.net/doc/
Here's something you can try right on the command line:
% python % python
>>> from eventlet import api >>> import eventlet
>>> help(api) >>> from eventlet.green import urllib2
>>> gt = eventlet.spawn(urllib2.urlopen, 'http://eventlet.net')
>>> gt2 = eventlet.spawn(urllib2.urlopen, 'http://secondlife.com')
>>> gt2.wait()
>>> gt.wait()
Also, look at the examples in the examples directory. Also, look at the examples in the examples directory.
Building the Docs Building the Docs Locally
================= =========================
To build a complete set of HTML documentation, you must have Sphinx, which can be found at http://sphinx.pocoo.org/ To build a complete set of HTML documentation, you must have Sphinx, which can be found at http://sphinx.pocoo.org/

6
doc/testing.rst
View File

@@ -87,7 +87,7 @@ Coverage.py is an awesome tool for evaluating how much code was exercised by uni
.. code-block:: sh .. code-block:: sh
nosetests --with-coverage nosetests --with-coverage --cover-package=eventlet
After running the tests to completion, this will emit a huge wodge of module names and line numbers. For some reason, the ``--cover-inclusive`` option breaks everything rather than serving its purpose of limiting the coverage to the local files, so don't use that. After running the tests to completion, this will emit a huge wodge of module names and line numbers. For some reason, the ``--cover-inclusive`` option breaks everything rather than serving its purpose of limiting the coverage to the local files, so don't use that.
@@ -95,6 +95,6 @@ The annotate option is quite useful because it generates annotated source files
.. code-block:: sh .. code-block:: sh
coverage annotate -d annotated --omit tempmod coverage annotate -d annotated --omit='tempmod,<console>'
(``tempmod`` is omitted because it gets thrown away at the completion of its unit test and coverage.py isn't smart enough to detect this) (``tempmod`` and ``console`` are omitted because they gets thrown away at the completion of their unit tests and coverage.py isn't smart enough to detect this)

7
eventlet/coros.py
View File

@@ -317,6 +317,13 @@ class Actor(object):
to process concurrently. If it is 1, the actor will process messages to process concurrently. If it is 1, the actor will process messages
serially. serially.
""" """
warnings.warn("We're phasing out the Actor class, so as to get rid of"
"the coros module. If you use Actor, please speak up on "
"eventletdev@lists.secondlife.com, and we'll come up with a "
"transition plan. If no one speaks up, we'll remove Actor "
"in a future release of Eventlet.",
DeprecationWarning, stacklevel=2)
self._mailbox = collections.deque() self._mailbox = collections.deque()
self._event = _event.Event() self._event = _event.Event()
self._killer = api.spawn(self.run_forever) self._killer = api.spawn(self.run_forever)