[tor-commits] [stem/master] Add new GUARD_WAIT circuit status

[atagar at torproject.org]

commit 91b5b9ce404ca099089d12d8b66e6c67a423e1e9
Author: Damian Johnson <atagar at torproject.org>
Date:   Mon Jan 30 08:35:27 2017 -0800

    Add new GUARD_WAIT circuit status
    
    Newly added circuit status...
    
      https://gitweb.torproject.org/torspec.git/commit/?id=6446210
---
 docs/change_log.rst |  4 ++++
 stem/__init__.py    | 23 ++++++++++++++---------
 2 files changed, 18 insertions(+), 9 deletions(-)

diff --git a/docs/change_log.rst b/docs/change_log.rst
index 1111afd..85619b2 100644
--- a/docs/change_log.rst
+++ b/docs/change_log.rst
@@ -43,6 +43,10 @@ Unreleased
 The following are only available within Stem's `git repository
 <download.html>`_.
 
+ * **Controller**
+
+  * Added the GUARD_WAIT :data:`~stem.CircStatus` (:spec:`6446210`)
+
  * **Descriptors**
 
   * Sped descriptor reading by ~25% by deferring defaulting when validating
diff --git a/stem/__init__.py b/stem/__init__.py
index d74e90b..de2ce9d 100644
--- a/stem/__init__.py
+++ b/stem/__init__.py
@@ -86,15 +86,19 @@ Library for working with the tor process.
 
   Statuses that a circuit can be in. Tor may provide statuses not in this enum.
 
-  ============ ===========
-  CircStatus   Description
-  ============ ===========
-  **LAUNCHED** new circuit was created
-  **BUILT**    circuit finished being created and can accept traffic
-  **EXTENDED** circuit has been extended by a hop
-  **FAILED**   circuit construction failed
-  **CLOSED**   circuit has been closed
-  ============ ===========
+  .. versionchanged:: 1.6.0
+     Added the GUARD_WAIT signal.
+
+  ============== ===========
+  CircStatus     Description
+  ============== ===========
+  **LAUNCHED**   new circuit was created
+  **BUILT**      circuit finished being created and can accept traffic
+  **GUARD_WAIT** waiting to see if there's a circuit with a better guard before using
+  **EXTENDED**   circuit has been extended by a hop
+  **FAILED**     circuit construction failed
+  **CLOSED**     circuit has been closed
+  ============== ===========
 
 .. data:: CircBuildFlag (enum)
 
@@ -653,6 +657,7 @@ Signal = stem.util.enum.UppercaseEnum(
 CircStatus = stem.util.enum.UppercaseEnum(
   'LAUNCHED',
   'BUILT',
+  'GUARD_WAIT',
   'EXTENDED',
   'FAILED',
   'CLOSED',