Merge pull request #629 from wenh06/master

Add ReprMixin for more easy enhancement for the __repr__ and __str__ methods of a class

textattack/constraints/constraint.py

@@ -7,10 +7,10 @@
 from abc import ABC, abstractmethod
 
 import textattack
-from textattack.shared.utils import default_class_repr
+from textattack.shared.utils import ReprMixin
 
 
-class Constraint(ABC):
+class Constraint(ReprMixin, ABC):
     """An abstract class that represents constraints on adversial text
     examples. Constraints evaluate whether transformations from a
     ``AttackedText`` to another ``AttackedText`` meet certain conditions.
@@ -123,5 +123,3 @@ def extra_repr_keys(self):
         line strings are acceptable.
         """
         return ["compare_against_original"]
-
-    __str__ = __repr__ = default_class_repr

textattack/constraints/pre_transformation/max_word_index_modification.py

@@ -6,8 +6,6 @@
 """
 from textattack.constraints import PreTransformationConstraint
 
-# from textattack.shared.utils import default_class_repr
-
 
 class MaxWordIndexModification(PreTransformationConstraint):
     """A constraint disallowing the modification of words which are past some

textattack/constraints/pre_transformation/repeat_modification.py

@@ -6,8 +6,6 @@
 
 from textattack.constraints import PreTransformationConstraint
 
-# from textattack.shared.utils import default_class_repr
-
 
 class RepeatModification(PreTransformationConstraint):
     """A constraint disallowing the modification of words which have already

textattack/constraints/pre_transformation_constraint.py

@@ -5,10 +5,10 @@
 
 from abc import ABC, abstractmethod
 
-from textattack.shared.utils import default_class_repr
+from textattack.shared.utils import ReprMixin
 
 
-class PreTransformationConstraint(ABC):
+class PreTransformationConstraint(ReprMixin, ABC):
     """An abstract class that represents constraints which are applied before
     the transformation.
 
@@ -62,5 +62,3 @@ def extra_repr_keys(self):
         line strings are acceptable.
         """
         return []
-
-    __str__ = __repr__ = default_class_repr

textattack/goal_functions/goal_function.py

@@ -15,10 +15,10 @@
     GoalFunctionResultStatus,
 )
 from textattack.shared import validators
-from textattack.shared.utils import default_class_repr
+from textattack.shared.utils import ReprMixin
 
 
-class GoalFunction(ABC):
+class GoalFunction(ReprMixin, ABC):
     """Evaluates how well a perturbed attacked_text object is achieving a
     specified goal.
 
@@ -237,5 +237,3 @@ def __setstate__(self, state):
         self.__dict__ = state
         if self.use_cache:
             self._call_model_cache = lru.LRU(state["_call_model_cache"])
-
-    __repr__ = __str__ = default_class_repr

textattack/search_methods/search_method.py

@@ -6,10 +6,10 @@
 
 from abc import ABC, abstractmethod
 
-from textattack.shared.utils import default_class_repr
+from textattack.shared.utils import ReprMixin
 
 
-class SearchMethod(ABC):
+class SearchMethod(ReprMixin, ABC):
     """This is an abstract class that contains main helper functionality for
     search methods.
 
@@ -65,8 +65,3 @@ def get_victim_model(self):
             )
         else:
             return self.goal_function.model
-
-    def extra_repr_keys(self):
-        return []
-
-    __repr__ = __str__ = default_class_repr

textattack/shared/utils/strings.py

@@ -73,6 +73,19 @@ def default_class_repr(self):
     return f"{self.__class__.__name__}{extra_str}"
 
 
+class ReprMixin(object):
+    """Mixin for enhanced __repr__ and __str__."""
+
+    def __repr__(self):
+        return default_class_repr(self)
+
+    __str__ = __repr__
+
+    def extra_repr_keys(self):
+        """extra fields to be included in the representation of a class"""
+        return []
+
+
 LABEL_COLORS = [
     "red",
     "green",

textattack/shared/word_embeddings.py

@@ -14,7 +14,7 @@
 from textattack.shared import utils
 
 
-class AbstractWordEmbedding(ABC):
+class AbstractWordEmbedding(utils.ReprMixin, ABC):
     """Abstract class representing word embedding used by TextAttack.
 
     This class specifies all the methods that is required to be defined
@@ -97,8 +97,6 @@ def nearest_neighbours(self, index, topn):
         """
         raise NotImplementedError()
 
-    __repr__ = __str__ = utils.default_class_repr
-
 
 class WordEmbedding(AbstractWordEmbedding):
     """Object for loading word embeddings and related distances for TextAttack.

textattack/transformations/transformation.py

@@ -6,10 +6,10 @@
 
 from abc import ABC, abstractmethod
 
-from textattack.shared.utils import default_class_repr
+from textattack.shared.utils import ReprMixin
 
 
-class Transformation(ABC):
+class Transformation(ReprMixin, ABC):
     """An abstract class for transforming a sequence of text to produce a
     potential adversarial example."""
 
@@ -67,8 +67,3 @@ def _get_transformations(self, current_text, indices_to_modify):
     @property
     def deterministic(self):
         return True
-
-    def extra_repr_keys(self):
-        return []
-
-    __repr__ = __str__ = default_class_repr