openstack/deb-python-cassandra-driver
Code Issues Proposed changes

doc: mention gevent/eventlet patching assumptions

Browse Source
This commit is contained in:
Adam Holmberg
2015-10-21 14:19:43 -05:00
parent 915dc94b7c
commit db58ba7042
3 changed files with 9 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
cassandra/cluster.py
View File

@@ -407,18 +407,17 @@ class Cluster(object):
* :class:`cassandra.io.asyncorereactor.AsyncoreConnection`
* :class:`cassandra.io.libevreactor.LibevConnection`
* :class:`cassandra.io.geventreactor.GeventConnection` (requires monkey-patching)
* :class:`cassandra.io.eventletreactor.EventletConnection` (requires monkey-patching - see doc for details)
* :class:`cassandra.io.geventreactor.GeventConnection` (requires monkey-patching - see doc for details)
* :class:`cassandra.io.twistedreactor.TwistedConnection`
By default, ``AsyncoreConnection`` will be used, which uses
the ``asyncore`` module in the Python standard library. The
performance is slightly worse than with ``libev``, but it is
supported on a wider range of systems.
the ``asyncore`` module in the Python standard library.
If ``libev`` is installed, ``LibevConnection`` will be used instead.
If gevent monkey-patching of the standard library is detected,
GeventConnection will be used automatically.
If ``gevent`` or ``eventlet`` monkey-patching is detected, the corresponding
connection class will be used automatically.
"""
control_connection_timeout = 2.0

2
cassandra/io/eventletreactor.py
View File

@@ -44,6 +44,8 @@ def is_timeout(err):
class EventletConnection(Connection):
"""
An implementation of :class:`.Connection` that utilizes ``eventlet``.
This implementation assumes all eventlet monkey patching is active. It is not tested with partial patching.
"""
_read_watcher = None

3
cassandra/io/geventreactor.py
View File

@@ -17,7 +17,6 @@ from gevent.queue import Queue
from gevent import select, socket
import gevent.ssl
from collections import defaultdict
from functools import partial
import logging
import os
@@ -44,6 +43,8 @@ def is_timeout(err):
class GeventConnection(Connection):
"""
An implementation of :class:`.Connection` that utilizes ``gevent``.
This implementation assumes all gevent monkey patching is active. It is not tested with partial patching.
"""
_read_watcher = None