Add deflection to custom __lt__ and add functools.total_ordering

aea/configurations/data_types.py

@@ -48,7 +48,6 @@
     SERVICE,
     SKILL,
 )
-from aea.exceptions import enforce
 from aea.helpers.base import (
     IPFSHash,
     IPFSHashOrStr,
@@ -122,13 +121,8 @@ def __eq__(self, other: Any) -> bool:
 
     def __lt__(self, other: Any) -> bool:
         """Compare with another object."""
-        enforce(
-            isinstance(other, PackageVersion),
-            f"Cannot compare {type(self)} with type {type(other)}.",
-        )
-        other = cast(PackageVersion, other)
-        if self.is_latest or other.is_latest:
-            return self.is_latest < other.is_latest
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance.
         return str(self) < str(other)
 
 
@@ -215,6 +209,7 @@ def __str__(self) -> str:
 PackageIdPrefix = Tuple[ComponentType, str, str]
 
 
+@functools.total_ordering
 class PublicId(JSONSerializable):
     """This class implement a public identifier.
 
@@ -461,37 +456,14 @@ def __eq__(self, other: Any) -> bool:
         return all(getattr(self, s) == getattr(other, s) for s in self.__slots__[:-1])
 
     def __lt__(self, other: Any) -> bool:
-        """
-        Compare two public ids.
-
-        >>> public_id_1 = PublicId("author_1", "name_1", "0.1.0")
-        >>> public_id_2 = PublicId("author_1", "name_1", "0.1.1")
-        >>> public_id_3 = PublicId("author_1", "name_2", "0.1.0")
-        >>> public_id_1 > public_id_2
-        False
-        >>> public_id_1 < public_id_2
-        True
-
-        >>> public_id_1 < public_id_3
-        Traceback (most recent call last):
-        ...
-        ValueError: The public IDs author_1/name_1:0.1.0 and author_1/name_2:0.1.0 cannot be compared. Their author or name attributes are different.
-
-        :param other: the object to compate to
-        :raises ValueError: if the public ids cannot be confirmed
-        :return: whether or not the inequality is satisfied
-        """
-        if (
-            isinstance(other, PublicId)
-            and self.author == other.author
-            and self.name == other.name
-        ):
-            return self.package_version < other.package_version
-        raise ValueError(
-            "The public IDs {} and {} cannot be compared. Their author or name attributes are different.".format(
-                self, other
+        """Compare with another object."""
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance.
+        if not (self.author == other.author and self.name == other.name):
+            raise TypeError(
+                f"The public IDs {self} and {other} cannot be compared. Their author or name attributes are different."
             )
-        )
+        return self.package_version < other.package_version
 
     def without_hash(
         self,
@@ -518,6 +490,7 @@ def __str__(self) -> str:
         )
 
 
+@functools.total_ordering
 class PackageId:
     """A package identifier."""
 
@@ -655,6 +628,8 @@ def __eq__(self, other: Any) -> bool:
 
     def __lt__(self, other: Any) -> bool:
         """Compare two public ids."""
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance.
         return str(self) < str(other)
 
 

docs/api/configurations/data_types.md

@@ -224,6 +224,7 @@ Get the string representation.
 ## PublicId Objects
 
 ```python
+@functools.total_ordering
 class PublicId(JSONSerializable)
 ```
 
@@ -531,32 +532,7 @@ Check equality.
 def __lt__(other: Any) -> bool
 ```
 
-Compare two public ids.
-
->>> public_id_1 = PublicId("author_1", "name_1", "0.1.0")
->>> public_id_2 = PublicId("author_1", "name_1", "0.1.1")
->>> public_id_3 = PublicId("author_1", "name_2", "0.1.0")
->>> public_id_1 > public_id_2
-False
->>> public_id_1 < public_id_2
-True
-
->>> public_id_1 < public_id_3
-Traceback (most recent call last):
-...
-ValueError: The public IDs author_1/name_1:0.1.0 and author_1/name_2:0.1.0 cannot be compared. Their author or name attributes are different.
-
-**Arguments**:
-
-- `other`: the object to compate to
-
-**Raises**:
-
-- `ValueError`: if the public ids cannot be confirmed
-
-**Returns**:
-
-whether or not the inequality is satisfied
+Compare with another object.
 
 <a id="aea.configurations.data_types.PublicId.without_hash"></a>
 
@@ -593,6 +569,7 @@ Get the string representation.
 ## PackageId Objects
 
 ```python
+@functools.total_ordering
 class PackageId()
 ```
 

tests/strategies/data_types.py

@@ -33,6 +33,7 @@
     GitRef,
     PackageId,
     PackageType,
+    PackageVersion,
     PublicId,
     PyPIPackageName,
 )
@@ -70,6 +71,13 @@
 st.register_type_strategy(semver.VersionInfo, version_info_strategy)
 
 
+package_version_strategy = st.builds(
+    lambda kwargs: PackageVersion(**kwargs),
+    st.fixed_dictionaries(dict(version_like=version_info_strategy)),
+)
+st.register_type_strategy(PackageVersion, package_version_strategy)
+
+
 s = st.fixed_dictionaries(
     dict(
         author=st.from_type(SimpleId),

tests/test_configurations/test_base.py

@@ -707,7 +707,7 @@ def test_public_id_comparator_when_author_is_different():
     pid1 = PublicId("author_1", "name", "0.1.0")
     pid2 = PublicId("author_2", "name", "0.1.0")
     with pytest.raises(
-        ValueError,
+        TypeError,
         match="The public IDs .* and .* cannot be compared. Their author or name attributes are different.",
     ):
         assert pid1 < pid2
@@ -718,7 +718,7 @@ def test_public_id_comparator_when_name_is_different():
     pid1 = PublicId("author", "name_1", "0.1.0")
     pid2 = PublicId("author", "name_2", "0.1.0")
     with pytest.raises(
-        ValueError,
+        TypeError,
         match="The public IDs .* and .* cannot be compared. Their author or name attributes are different.",
     ):
         assert pid1 < pid2

tests/test_configurations/test_data_types.py

@@ -61,14 +61,12 @@ def all_comparisons_operations_equal(pair_a, pair_b) -> bool:
     return version_comparison == package_comparison
 
 
-@pytest.mark.parametrize("self_type", [PublicId, PackageId, Dependency])
+@pytest.mark.parametrize("self_type", [PackageVersion, PublicId, PackageId])
 def test_self_type_comparison(self_type):
     """Test comparison to self"""
 
     self = st.from_type(self_type).example()
-    copy_self = copy.deepcopy(self)
-    other = st.from_type(self_type).example()
-    assert self == copy_self
+    other = copy.deepcopy(self)
     for f in COMPARISON_OPERATORS:
         assert isinstance(f(self, other), bool)
         assert isinstance(f(other, self), bool)