MAINT: rename filter to filter_by_identity

Summary

Rename the filter function to prevent confusion that it does not behave like standard filter functions

Test Environment

pipelines

Check List for the Author

Please, prepare your MR for a review. Be sure to write a summary and a focus and create gitlab comments for the reviewer. They should guide the reviewer through the changes, explain your changes and also point out open questions. For further good practices have a look at our review guidelines

• All automated tests pass
• Reference related issues
• Up-to-date CHANGELOG.md (or not necessary)
• Up-to-date JSON schema (or not necessary)
• Appropriate user and developer documentation (or not necessary)
  • How do I use the software? Assume "stupid" users.
  • How do I develop or debug the software? Assume novice developers.
• Annotations in code (Gitlab comments)
  • Intent of new code
  • Problems with old code
  • Why this implementation?

Check List for the Reviewer

• I understand the intent of this MR
• All automated tests pass
• Up-to-date CHANGELOG.md (or not necessary)
• Appropriate user and developer documentation (or not necessary)
• The test environment setup works and the intended behavior is reproducible in the test environment
• In-code documentation and comments are up-to-date.
• Check: Are there specifications? Are they satisfied?

For further good practices have a look at our review guidelines.

src/linkahead/common/models.py

@@ -2572,7 +2572,11 @@ class PropertyList(list):
 
         return xml2str(xml)
 
-    def filter(self, prop: Optional[Property] = None,
+    def filter(self, *args, **kwargs):
+        warnings.warn(DeprecationWarning("This function was renamed to filter_by_identity."))
+        return self.filter_by_identity(*args, **kwargs)
+
+    def filter_by_identity(self, prop: Optional[Property] = None,
                pid: Union[None, str, int] = None,
                name: Optional[str] = None,
                conjunction: bool = False) -> list:
@@ -2580,7 +2584,7 @@ class PropertyList(list):
         Return all Properties from the given PropertyList that match the
         selection criteria.
 
-        Please refer to the documentation of _filter_entity_list for a detailed
+        Please refer to the documentation of _filter_entity_list_by_identity for a detailed
         description of behaviour.
 
         Params
@@ -2601,7 +2605,7 @@ class PropertyList(list):
         matches          : list
                            List containing all matching Properties
         """
-        return _filter_entity_list(self, pid=pid, name=name, entity=prop,
+        return _filter_entity_list_by_identity(self, pid=pid, name=name, entity=prop,
                                    conjunction=conjunction)
 
     def _get_entity_by_cuid(self, cuid: str):
@@ -2739,7 +2743,11 @@ class ParentList(list):
 
         return xml2str(xml)
 
-    def filter(self, parent: Optional[Parent] = None,
+    def filter(self, *args, **kwargs):
+        warnings.warn(DeprecationWarning("This function was renamed to filter_by_identity."))
+        return self.filter_by_identity(*args, **kwargs)
+
+    def filter_by_identity(self, parent: Optional[Parent] = None,
                pid: Union[None, str, int] = None,
                name: Optional[str] = None,
                conjunction: bool = False) -> list:
@@ -2747,7 +2755,7 @@ class ParentList(list):
         Return all Parents from the given ParentList that match the selection
         criteria.
 
-        Please refer to the documentation of _filter_entity_list for a detailed
+        Please refer to the documentation of _filter_entity_list_by_identity for a detailed
         description of behaviour.
 
         Params
@@ -2770,7 +2778,7 @@ class ParentList(list):
         matches          : list
                            List containing all matching Parents
         """
-        return _filter_entity_list(self, pid=pid, name=name, entity=parent,
+        return _filter_entity_list_by_identity(self, pid=pid, name=name, entity=parent,
                                    conjunction=conjunction)
 
     def remove(self, parent: Union[Entity, int, str]):
@@ -3738,21 +3746,21 @@ class Container(list):
 
         return sync_dict
 
-    def filter(self, entity: Optional[Entity] = None,
-               pid: Union[None, str, int] = None,
+    def filter_by_identity(self, entity: Optional[Entity] = None,
+               entity_id: Union[None, str, int] = None,
                name: Optional[str] = None,
                conjunction: bool = False) -> list:
         """
         Return all Entities from this Container that match the selection criteria.
 
-        Please refer to the documentation of _filter_entity_list for a detailed
+        Please refer to the documentation of _filter_entity_list_by_identity for a detailed
         description of behaviour.
 
         Params
         ------
         entity            : Entity
                             Entity to match name and ID with
-        pid               : str, int
+        entity_id         : str, int
                             Parent ID to match
         name              : str
                             Parent name to match
@@ -3766,7 +3774,7 @@ class Container(list):
         matches          : list
                            List containing all matching Entities
         """
-        return _filter_entity_list(self, pid=pid, name=name, entity=entity,
+        return _filter_entity_list_by_identity(self, pid=entity_id, name=name, entity=entity,
                                    conjunction=conjunction)
 
     @staticmethod
@@ -5576,7 +5584,7 @@ def delete(ids: Union[list[int], range], raise_exception_on_error: bool = True):
     return c.delete(raise_exception_on_error=raise_exception_on_error)
 
 
-def _filter_entity_list(listobject: list[Entity],
+def _filter_entity_list_by_identity(listobject: list[Entity],
                         entity: Optional[Entity] = None,
                         pid: Union[None, str, int] = None,
                         name: Optional[str] = None,