Merge pull request #445 from valory-xyz/fix/data_types__eq__

Updates `__eq__` implementation on the data types

aea/cli/check_packages.py

@@ -112,12 +112,12 @@ def __init__(
 
     def print_error(self) -> None:
         """Print the error message."""
-        sorted_expected = list(map(str, sorted(self.expected_dependencies)))
-        sorted_missing = list(map(str, sorted(self.missing_dependencies)))
+        expected = list(map(str, self.expected_dependencies))
+        missing = list(map(str, self.missing_dependencies))
         print("=" * 50)
         print(f"Package {self.configuration_file}:")
-        print(f"Expected: {pprint.pformat(sorted_expected)}")
-        print(f"Missing: {pprint.pformat(sorted_missing)}")
+        print(f"Expected: {pprint.pformat(expected)}")
+        print(f"Missing: {pprint.pformat(missing)}")
         print("=" * 50)
 
 

aea/configurations/data_types.py

@@ -48,7 +48,6 @@
     SERVICE,
     SKILL,
 )
-from aea.exceptions import enforce
 from aea.helpers.base import (
     IPFSHash,
     IPFSHashOrStr,
@@ -86,6 +85,8 @@ class PackageVersion:
 
     _version: PackageVersionLike
 
+    __slots__ = ("_version",)
+
     def __init__(self, version_like: PackageVersionLike) -> None:
         """
         Initialize a package version.
@@ -114,18 +115,15 @@ def __str__(self) -> str:
 
     def __eq__(self, other: Any) -> bool:
         """Check equality."""
-        return isinstance(other, PackageVersion) and self._version == other._version
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance's __eq__.
+        return all(getattr(self, s) == getattr(other, s) for s in self.__slots__)
 
     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
-        return str(self) < str(other)
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance.
+        return self._version < other._version
 
 
 class PackageType(Enum):
@@ -211,6 +209,7 @@ def __str__(self) -> str:
 PackageIdPrefix = Tuple[ComponentType, str, str]
 
 
+@functools.total_ordering
 class PublicId(JSONSerializable):
     """This class implement a public identifier.
 
@@ -451,46 +450,20 @@ def __repr__(self) -> str:
         return f"<{self}>"
 
     def __eq__(self, other: Any) -> bool:
-        """Compare with another object."""
-        return (
-            isinstance(other, PublicId)
-            and self.author == other.author
-            and self.name == other.name
-            and self.version == other.version
-        )
+        """Check equality."""
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance's __eq__.
+        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,
@@ -517,6 +490,7 @@ def __str__(self) -> str:
         )
 
 
+@functools.total_ordering
 class PackageId:
     """A package identifier."""
 
@@ -647,16 +621,20 @@ def __repr__(self) -> str:
         return f"PackageId{self.__str__()}"
 
     def __eq__(self, other: Any) -> bool:
-        """Compare with another object."""
-        return (
-            isinstance(other, PackageId)
-            and self.package_type == other.package_type
-            and self.public_id == other.public_id
-        )
+        """Check equality."""
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance's __eq__.
+        return all(getattr(self, s) == getattr(other, s) for s in self.__slots__)
 
     def __lt__(self, other: Any) -> bool:
         """Compare two public ids."""
-        return str(self) < str(other)
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance.
+        if not self.package_type == other.package_type:
+            raise TypeError(
+                f"The package IDs {self} and {other} cannot be compared. Their package_type is different."
+            )
+        return self.public_id < other.public_id
 
 
 class ComponentId(PackageId):
@@ -874,15 +852,10 @@ def __str__(self) -> str:
         return f"{self.__class__.__name__}(name='{self.name}', version='{self.version}', index='{self.index}', git='{self.git}', ref='{self.ref}')"
 
     def __eq__(self, other: Any) -> bool:
-        """Compare with another object."""
-        return (
-            isinstance(other, Dependency)
-            and self._name == other._name
-            and self._version == other._version
-            and self._index == other._index
-            and self._git == other._git
-            and self._ref == other._ref
-        )
+        """Check equality."""
+        if not isinstance(other, self.__class__):
+            return NotImplemented  # Delegate comparison to the other instance's __eq__.
+        return all(getattr(self, s) == getattr(other, s) for s in self.__slots__)
 
 
 Dependencies = Dict[str, Dependency]

aea/helpers/base.py

@@ -563,7 +563,7 @@ def find_topological_order(adjacency_list: Dict[T, Set[T]]) -> List[T]:
     # compute the topological order
     queue: Deque[T] = deque()
     order = []
-    queue.extendleft(sorted(roots))  # type: ignore
+    queue.extendleft(sorted(roots, key=str))  # type: ignore
     while len(queue) > 0:
         current = queue.pop()
         order.append(current)

aea/helpers/dependency_tree.py

@@ -246,11 +246,10 @@ def generate(
         cls.flatten_tree(dep_tree, flat_tree_dirty, 0)
 
         for tree_level in reversed(flat_tree_dirty[:-1]):
-            flat_tree.append(
-                sorted(
-                    {package for package in tree_level if package not in dirty_packages}
-                )
-            )
+            flat_tree.append([])
+            for package in tree_level:
+                if package not in dirty_packages and package not in flat_tree[-1]:
+                    flat_tree[-1].append(package)
             dirty_packages += tree_level
 
         return flat_tree

docs/api/configurations/data_types.md

@@ -224,6 +224,7 @@ Get the string representation.
 ## PublicId Objects
 
 ```python
+@functools.total_ordering
 class PublicId(JSONSerializable)
 ```
 
@@ -521,7 +522,7 @@ Get the representation.
 def __eq__(other: Any) -> bool
 ```
 
-Compare with another object.
+Check equality.
 
 <a id="aea.configurations.data_types.PublicId.__lt__"></a>
 
@@ -531,32 +532,7 @@ Compare with another object.
 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()
 ```
 
@@ -795,7 +772,7 @@ Get the object representation in string.
 def __eq__(other: Any) -> bool
 ```
 
-Compare with another object.
+Check equality.
 
 <a id="aea.configurations.data_types.PackageId.__lt__"></a>
 
@@ -1080,7 +1057,7 @@ Get the string representation.
 def __eq__(other: Any) -> bool
 ```
 
-Compare with another object.
+Check equality.
 
 <a id="aea.configurations.data_types.Dependencies"></a>
 

docs/api/package_manager/base.md

@@ -73,6 +73,16 @@ def check_dependencies(configuration: PackageConfiguration) -> List[Tuple[Packag
 
 Verify hashes for package dependecies againts the available hashes.
 
+<a id="aea.package_manager.base.BasePackageManager.get_package_dependencies"></a>
+
+#### get`_`package`_`dependencies
+
+```python
+def get_package_dependencies(package_id: PackageId) -> List[PackageId]
+```
+
+Get package dependencies by package_id.
+
 <a id="aea.package_manager.base.BasePackageManager.update_public_id_hash"></a>
 
 #### update`_`public`_`id`_`hash
@@ -93,6 +103,16 @@ def update_dependencies(package_id: PackageId) -> None
 
 Update dependency hashes to latest for a package.
 
+<a id="aea.package_manager.base.BasePackageManager.get_package_config_file"></a>
+
+#### get`_`package`_`config`_`file
+
+```python
+def get_package_config_file(package_id: PackageId) -> Path
+```
+
+Get package config file path.
+
 <a id="aea.package_manager.base.BasePackageManager.update_fingerprints"></a>
 
 #### update`_`fingerprints
@@ -108,10 +128,40 @@ Update fingerprints for a package.
 #### add`_`package
 
 ```python
-def add_package(package_id: PackageId) -> "BasePackageManager"
+def add_package(package_id: PackageId, with_dependencies: bool = False, allow_update: bool = False) -> "BasePackageManager"
+```
+
+Add package.
+
+<a id="aea.package_manager.base.BasePackageManager.add_dependencies_for_package"></a>
+
+#### add`_`dependencies`_`for`_`package
+
+```python
+def add_dependencies_for_package(package_id: PackageId, allow_update: bool = False) -> None
+```
+
+Add dependencies for the package specified.
+
+<a id="aea.package_manager.base.BasePackageManager.get_package_version_with_hash"></a>
+
+#### get`_`package`_`version`_`with`_`hash
+
+```python
+def get_package_version_with_hash(package_id: PackageId) -> PackageId
+```
+
+Add package_id with hash for the package presents in registry.
+
+<a id="aea.package_manager.base.BasePackageManager.is_package_files_exist"></a>
+
+#### is`_`package`_`files`_`exist
+
+```python
+def is_package_files_exist(package_id: PackageId) -> bool
 ```
 
-Add packages.
+Check package exists in the filesystem by checking it's config file exists.
 
 <a id="aea.package_manager.base.BasePackageManager.package_path_from_package_id"></a>
 

docs/api/package_manager/v0.md

@@ -65,6 +65,16 @@ def update_package_hashes() -> "BasePackageManager"
 
 Update packages.json file.
 
+<a id="aea.package_manager.v0.PackageManagerV0.add_package"></a>
+
+#### add`_`package
+
+```python
+def add_package(package_id: PackageId, with_dependencies: bool = False, allow_update: bool = False) -> "BasePackageManager"
+```
+
+Add package.
+
 <a id="aea.package_manager.v0.PackageManagerV0.verify"></a>
 
 #### verify

docs/api/package_manager/v1.md

@@ -76,6 +76,16 @@ def is_dev_package(package_id: PackageId) -> bool
 
 Check if a package is third party package.
 
+<a id="aea.package_manager.v1.PackageManagerV1.add_package"></a>
+
+#### add`_`package
+
+```python
+def add_package(package_id: PackageId, with_dependencies: bool = False, allow_update: bool = False) -> "PackageManagerV1"
+```
+
+Add package.
+
 <a id="aea.package_manager.v1.PackageManagerV1.sync"></a>
 
 #### sync