summaryrefslogtreecommitdiff
path: root/kafka/conn.py
diff options
context:
space:
mode:
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