fix #479 : renamed Axis.translate to Axis.index

Author: alixdamman

doc/source/api.rst

@@ -42,7 +42,7 @@ Searching
 .. autosummary::
    :toctree: _generated/
 
-   Axis.translate
+   Axis.index
    Axis.containing
    Axis.startingwith
    Axis.endingwith

doc/source/changes/version_0_27.rst.inc

@@ -1,4 +1,10 @@
-Backward incompatible changes
+Syntax changes
+--------------
+
+* renamed `Axis.translate` to `Axis.index` (closes :issue:`479`).
+
+
+Backward incompatible changes
 -----------------------------
 
 * labels are checked during array subset assignement (closes :issue:`269`):

larray/core/array.py

@@ -1754,7 +1754,7 @@ def _translate_axis_key_chunk(self, axis_key, bool_passthrough=True):
         if isinstance(axis_key, LGroup) and axis_key.axis is not None:
             real_axis = self.axes[axis_key.axis]
             try:
-                axis_pos_key = real_axis.translate(axis_key, bool_passthrough)
+                axis_pos_key = real_axis.index(axis_key, bool_passthrough)
             except KeyError:
                 raise ValueError("%r is not a valid label for any axis" % axis_key)
             return real_axis.i[axis_pos_key]
@@ -1768,7 +1768,7 @@ def _translate_axis_key_chunk(self, axis_key, bool_passthrough=True):
         # TODO: use axis_key dtype to only check compatible axes
         for axis in self.axes:
             try:
-                axis_pos_key = axis.translate(axis_key, bool_passthrough)
+                axis_pos_key = axis.index(axis_key, bool_passthrough)
                 valid_axes.append(axis)
             except KeyError:
                 continue
@@ -1856,7 +1856,7 @@ def _guess_axis(self, axis_key):
         valid_axes = []
         for axis in self.axes:
             try:
-                axis.translate(axis_key)
+                axis.index(axis_key)
                 valid_axes.append(axis)
             except KeyError:
                 continue
@@ -1954,7 +1954,7 @@ def _translated_key(self, key, bool_stuff=False):
                for axis in self.axes]
 
         # IGroup -> raw positional
-        return tuple(axis.translate(axis_key, bool_passthrough=not bool_stuff)
+        return tuple(axis.index(axis_key, bool_passthrough=not bool_stuff)
                      for axis, axis_key in zip(self.axes, key))
 
     # TODO: we only need axes length => move this to AxisCollection

larray/core/axis.py

@@ -675,7 +675,7 @@ def _is_key_type_compatible(self, key):
         # object kind can match anything
         return key_kind == label_kind or key_kind == 'O' or label_kind == 'O' or py2_str_match
 
-    def translate(self, key, bool_passthrough=True):
+    def index(self, key, bool_passthrough=True):
         """
         Translates a label key to its numerical index counterpart.
 
@@ -698,9 +698,9 @@ def translate(self, key, bool_passthrough=True):
         Examples
         --------
         >>> people = Axis(['John Doe', 'Bruce Wayne', 'Bruce Willis', 'Waldo', 'Arthur Dent', 'Harvey Dent'], 'people')
-        >>> people.translate('Waldo')
+        >>> people.index('Waldo')
         3
-        >>> people.translate(people.matching('Bruce'))
+        >>> people.index(people.matching('Bruce'))
         array([1, 2])
         """
         mapping = self._mapping
@@ -784,7 +784,7 @@ def translate(self, key, bool_passthrough=True):
                 return array_lookup2(key, self._sorted_keys, self._sorted_values)
         elif isinstance(key, ABCLArray):
             from .array import LArray
-            return LArray(self.translate(key.data), key.axes)
+            return LArray(self.index(key.data), key.axes)
         else:
             # the first mapping[key] above will cover most cases.
             # This code path is only used if the key was given in "non normalized form"
@@ -796,6 +796,8 @@ def translate(self, key, bool_passthrough=True):
                 # print("diff dtype", )
                 raise KeyError(key)
 
+    translate = renamed_to(index, 'translate')
+
     # FIXME: remove id
     @property
     def id(self):
@@ -946,7 +948,7 @@ def replace(self, old, new=None):
             assert len(old) == len(new)
         # using object dtype because new labels length can be larger than the fixed str length in the self.labels array
         labels = self.labels.astype(object)
-        indices = self.translate(old)
+        indices = self.index(old)
         labels[indices] = new
         return Axis(labels, self.name)
 
@@ -1993,7 +1995,7 @@ def translate_full_key(self, key):
         (slice(None, None, None), 1, 2)
         """
         assert len(key) == len(self)
-        return tuple(axis.translate(axis_key) for axis_key, axis in zip(key, self))
+        return tuple(axis.index(axis_key) for axis_key, axis in zip(key, self))
 
     @property
     def labels(self):
@@ -2515,7 +2517,7 @@ def __init__(self, name):
         self._labels = None
         self._iswildcard = False
 
-    def translate(self, key):
+    def index(self, key):
         raise NotImplementedError("an AxisReference (X.) cannot translate labels")
 
     def __repr__(self):

larray/tests/test_axis.py

@@ -106,8 +106,8 @@ def test_translate(self):
         # an axis with labels having the object dtype
         a = Axis(np.array(["a0", "a1"], dtype=object), 'a')
 
-        self.assertEqual(a.translate('a1'), 1)
-        self.assertEqual(a.translate('a1 >> A1'), 1)
+        self.assertEqual(a.index('a1'), 1)
+        self.assertEqual(a.index('a1 >> A1'), 1)
 
     def test_getitem_lgroup_keys(self):
         def group_equal(g1, g2):