summaryrefslogtreecommitdiff
path: root/kafka/conn.py
diff options
context:
space:
mode:
authorDana Powers <dana.powers@gmail.com>2015-06-08 22:07:55 -0700
committerDana Powers <dana.powers@gmail.com>2015-06-08 22:07:55 -0700
commitfe382a55b253e2c0c4f66052ced1714dbdab65ae (patch)
tree757bfcd9f27065abe0e9ed51e61076aa6a9767c2 /kafka/conn.py
parent712377ab15ae7c1c0b031df310d60235b7c57cae (diff)
parent81abf094dcdfbbe78e55ee519b35658fefa410ef (diff)
downloadkafka-python-fe382a55b253e2c0c4f66052ced1714dbdab65ae.tar.gz
Merge pull request #394 from dpkp/cleanups
Cleanups
Diffstat (limited to 'kafka/conn.py')
-rw-r--r--kafka/conn.py8
1 files changed, 5 insertions, 3 deletions
diff --git a/kafka/conn.py b/kafka/conn.py
index 7a49d8c..432e10b 100644
--- a/kafka/conn.py
+++ b/kafka/conn.py
@@ -161,9 +161,11 @@ class KafkaConnection(local):
def copy(self):
"""
- Create an inactive copy of the connection object
- A reinit() has to be done on the copy before it can be used again
- return a new KafkaConnection object
+ Create an inactive copy of the connection object, suitable for
+ passing to a background thread.
+
+ The returned copy is not connected; you must call reinit() before
+ using.
"""
c = copy.deepcopy(self)
# Python 3 doesn't copy custom attributes of the threadlocal subclass