Merge pull request #13 from WeatherGod/key_change

ENH: Implement key changing

Author: tacaswell

cycler.py

@@ -117,14 +117,18 @@ def __init__(self, left, right=None, op=None):
         if isinstance(left, Cycler):
             self._left = Cycler(left._left, left._right, left._op)
         elif left is not None:
-            self._left = list(left)
+            # Need to copy the dictionary or else that will be a residual
+            # mutable that could lead to strange errors
+            self._left = [copy.copy(v) for v in left]
         else:
             self._left = None
 
         if isinstance(right, Cycler):
             self._right = Cycler(right._left, right._right, right._op)
         elif right is not None:
-            self._right = list(right)
+            # Need to copy the dictionary or else that will be a residual
+            # mutable that could lead to strange errors
+            self._right = [copy.copy(v) for v in right]
         else:
             self._right = None
 
@@ -138,6 +142,41 @@ def keys(self):
         """
         return set(self._keys)
 
+    def change_key(self, old, new):
+        """
+        Change a key in this cycler to a new name.
+        Modification is performed in-place.
+
+        Does nothing if the old key is the same as the new key.
+        Raises a ValueError if the new key is already a key.
+        Raises a KeyError if the old key isn't a key.
+
+        """
+        if old == new:
+            return
+        if new in self._keys:
+            raise ValueError("Can't replace %s with %s, %s is already a key" %
+                             (old, new, new))
+        if old not in self._keys:
+            raise KeyError("Can't replace %s with %s, %s is not a key" %
+                           (old, new, old))
+
+        self._keys.remove(old)
+        self._keys.add(new)
+
+        if self._right is not None and old in self._right.keys:
+            self._right.change_key(old, new)
+
+        # self._left should always be non-None
+        # if self._keys is non-empty.
+        elif isinstance(self._left, Cycler):
+            self._left.change_key(old, new)
+        else:
+            # It should be completely safe at this point to
+            # assume that the old key can be found in each
+            # iteration.
+            self._left = [{new: entry[old]} for entry in self._left]
+
     def _compose(self):
         """
         Compose the 'left' and 'right' components of this cycle

test_cycler.py

@@ -216,6 +216,36 @@ def test_copying():
     assert_equal(c3, cycler('foo', [['y', 'g', 'blue'], ['b', 'k']]))
 
 
+def test_keychange():
+    c1 = cycler('c', 'rgb')
+    c2 = cycler('lw', [1, 2, 3])
+    c3 = cycler('ec', 'yk')
+
+    c3.change_key('ec', 'edgecolor')
+    assert_equal(c3, cycler('edgecolor', c3))
+
+    c = c1 + c2
+    c.change_key('lw', 'linewidth')
+    # Changing a key in one cycler should have no
+    # impact in the original cycler.
+    assert_equal(c2, cycler('lw', [1, 2, 3]))
+    assert_equal(c, c1 + cycler('linewidth', c2))
+
+    c = (c1 + c2) * c3
+    c.change_key('c', 'color')
+    assert_equal(c1, cycler('c', 'rgb'))
+    assert_equal(c, (cycler('color', c1) + c2) * c3)
+
+    # Perfectly fine, it is a no-op
+    c.change_key('color', 'color')
+    assert_equal(c, (cycler('color', c1) + c2) * c3)
+
+    # Can't change a key to one that is already in there
+    assert_raises(ValueError, Cycler.change_key, c, 'color', 'lw')
+    # Can't change a key you don't have
+    assert_raises(KeyError, Cycler.change_key, c, 'c', 'foobar')
+
+
 def _eq_test_helper(a, b, res):
     if res:
         assert_equal(a, b)