Rename CyclicInt to SymmetricInt

Author: moomoohk

dpath/segments.py

@@ -4,7 +4,7 @@
 
 from dpath import options
 from dpath.exceptions import InvalidGlob, InvalidKeyName, PathNotFound
-from dpath.types import PathSegment, Creator, Hints, Glob, Path, CyclicInt
+from dpath.types import PathSegment, Creator, Hints, Glob, Path, SymmetricInt
 
 
 def make_walkable(node) -> Iterator[Tuple[PathSegment, Any]]:
@@ -22,8 +22,8 @@ def make_walkable(node) -> Iterator[Tuple[PathSegment, Any]]:
     except AttributeError:
         try:
             indices = range(len(node))
-            # Make all list indices cyclic so negative (wraparound) indexes are supported
-            indices = map(lambda i: CyclicInt(i, len(node)), indices)
+            # Convert all list indices to object so negative indexes are supported.
+            indices = map(lambda i: SymmetricInt(i, len(node)), indices)
             return zip(indices, node)
         except TypeError:
             # This can happen in cases where the node isn't leaf(node) == True,
@@ -217,7 +217,6 @@ def match(segments: Path, glob: Glob):
     # If we were successful in matching up the lengths, then we can
     # compare them using fnmatch.
     if path_len == len(ss_glob):
-        # TODO: Delete if not needed (previous code) - i = zip(map(int_str, segments), map(int_str, ss_glob))
         i = zip(segments, ss_glob)
         for s, g in i:
             # Match the stars we added to the glob to the type of the

dpath/types.py

@@ -2,13 +2,13 @@
 from typing import Union, Any, Callable, Sequence, Tuple, List, Optional, MutableMapping
 
 
-class CyclicInt(int):
+class SymmetricInt(int):
     """Same as a normal int but mimicks the behavior of list indexes (can be compared to a negative number)."""
 
     def __new__(cls, value: int, max_value: int, *args, **kwargs):
         if value >= max_value:
             raise TypeError(
-                f"Tried to initiate a CyclicInt with a value ({value}) "
+                f"Tried to initiate a {cls.__name__} with a value ({value}) "
                 f"greater than the provided max value ({max_value})"
             )
 
@@ -21,10 +21,13 @@ def __eq__(self, other):
         if not isinstance(other, int):
             return False
 
+        if other >= self.max_value or other >= -self.max_value:
+            return False
+
         return int(self) == (self.max_value + other) % self.max_value
 
     def __repr__(self):
-        return f"<CyclicInt {int(self)}%{self.max_value}>"
+        return f"<{self.__class__.__name__} {int(self)}%{self.max_value}>"
 
     def __str__(self):
         return str(int(self))