[tor-commits] [stem/master] Renaming attach_stream()'s hop argument

[atagar at torproject.org]

commit 9401596d2d07a2baadab5c4d144566f99d16df7d
Author: Damian Johnson <atagar at torproject.org>
Date:   Sun Dec 30 16:28:17 2012 -0800

    Renaming attach_stream()'s hop argument
    
    Renaming the method's 'hop' argument to 'exiting_hop' to be more descriptive.
    Also tweaking how we make the query a bit.
---
 stem/control.py |    9 +++++----
 1 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/stem/control.py b/stem/control.py
index 73f0faf..efe1403 100644
--- a/stem/control.py
+++ b/stem/control.py
@@ -1654,7 +1654,7 @@ class Controller(BaseController):
       else:
         raise stem.ProtocolError("CLOSECIRCUIT returned unexpected response code: %s" % response.code)
   
-  def attach_stream(self, stream_id, circuit_id, hop = None):
+  def attach_stream(self, stream_id, circuit_id, exiting_hop = None):
     """
     Attaches a stream to a circuit.
     
@@ -1663,15 +1663,16 @@ class Controller(BaseController):
     
     :param str stream_id: id of the stream that must be attached
     :param str circuit_id: id of the circuit to which it must be attached
-    :param int hop: hop in the circuit that must be used as an exit node
+    :param int exiting_hop: hop in the circuit where traffic should exit
     
     :raises:
       * :class:`stem.InvalidRequest` if the stream or circuit id were unrecognized
       * :class:`stem.OperationFailed` if the stream couldn't be attached for any other reason
     """
     
-    hop_str = " HOP=" + str(hop) if hop else ""
-    response = self.msg("ATTACHSTREAM %s %s%s" % (stream_id, circuit_id, hop_str))
+    query = "ATTACHSTREAM %s %s" % (stream_id, circuit_id)
+    if exiting_hop: query += " HOP=%s" % exiting_hop
+    response = self.msg(query)
     stem.response.convert("SINGLELINE", response)
     
     if not response.is_ok():