# HG changeset patch
# User Brian Neal <bgneal@gmail.com>
# Date 1338060543 18000
# Node ID 6f13bc4393593ba6cc5e89be5f38a69410abbdd8
# Parent  de413df1c9c579dd1899e9950749520a7ef11488
Changed the Rotor stepping parameter to any old iterable.
Clarified comments.

diff -r de413df1c9c5 -r 6f13bc439359 enigma/rotors/rotor.py
--- a/enigma/rotors/rotor.py	Sat May 26 12:53:00 2012 -0500
+++ b/enigma/rotors/rotor.py	Sat May 26 14:29:03 2012 -0500
@@ -56,8 +56,8 @@
     its own turnover position.
 
     Note that we allow the stepping parameter to be None. This indicates the
-    rotor does not rotate. This allows us to model the entry wheel and receivers
-    as stationary rotors.
+    rotor does not rotate. This allows us to model the entry wheel and
+    reflectors as stationary rotors.
     
     """
 
@@ -78,12 +78,16 @@
         the letter "A" is fixed to pin 0. A value of 1 means "B" is mapped to
         pin 0.
 
-        stepping - this is the stepping or turnover parameter. It can be a
-        simple string such as "R". This will indicate that when the rotor
-        transitions from "Q" to "R" (by observing the operator window), the
-        rotor will "kick" the rotor to its left, causing it to rotate. If the
-        rotor has more than one notch, this parameter should be a list of letter
-        positions, e.g. ['A', 'N'].
+        stepping - this is the stepping or turnover parameter. It should be an
+        iterable, for example a string such as "Q". This will indicate that when
+        the rotor transitions from "Q" to "R" (by observing the operator
+        window), the rotor will "kick" the rotor to its left, causing it to
+        rotate. If the rotor has more than one notch, a string of length 2 could
+        be used, e.g. "ZM".  Another way to think of this parameter is that when
+        a character in the stepping string is visible in the operator window, a
+        notch is lined up with the pawl on the left side of the rotor.  This
+        will allow the pawl to push up on the rotor to the left when the next
+        key is depressed.
 
         alpha_labels - when True, the letters A-Z are used for the rotor ring
         labels. If False, numeric string labels (01-26) are used.
@@ -115,7 +119,6 @@
         # Create two lists to describe the internal wiring. Two lists are used
         # to do fast lookup from both entry (from the right) and exit (from the
         # left). 
-        
         self.entry_map = [ord(pin) - ord('A') for pin in self.wiring_str]
         
         self.exit_map = [0] * 26
@@ -130,20 +133,13 @@
 
         # build step list: this is a list of positions where our notches are in
         # place to allow the pawls to move
-        step_list = []
-        if isinstance(stepping, str):
-            step_list = [stepping]
-        elif isinstance(stepping, tuple) or isinstance(stepping, list):
-            step_list = stepping
-        elif stepping is not None:
-            raise RotorError("stepping")
-
         self.step_set = set()
-        for pos in step_list:
-            if pos in self.display_map:
-                self.step_set.add(self.display_map[pos])
-            else:
-                raise RotorError("stepping: %s" % pos)
+        if stepping is not None:
+            for pos in stepping:
+                if pos in self.display_map:
+                    self.step_set.add(self.display_map[pos])
+                else:
+                    raise RotorError("stepping: %s" % pos)
 
     def set_display(self, val):
         """Spin the rotor such that the string val appears in the operator
diff -r de413df1c9c5 -r 6f13bc439359 enigma/tests/test_rotor.py
--- a/enigma/tests/test_rotor.py	Sat May 26 12:53:00 2012 -0500
+++ b/enigma/tests/test_rotor.py	Sat May 26 14:29:03 2012 -0500
@@ -67,7 +67,10 @@
                 self.assertEqual(s, rotor.get_display())
 
     def test_wiring(self):
-
+        """Loop through all ring settings & rotor positions and test the
+        wiring.
+        
+        """
         for r in range(26):
             rotor = Rotor('I', WIRING, ring_setting=r, alpha_labels=True)