Make gramps.gen.lib.primaryobj typed

Author: bartfeenstra

.github/workflows/gramps-ci.yml

@@ -54,6 +54,7 @@ jobs:
         sudo apt-get install libxml2-utils
         sudo apt-get install python3-lxml
         sudo apt-get install python3-libxml2
+        sudo apt-get install python3-typing-extensions
         sudo apt-get install zlib1g-dev
         sudo apt-get install python3-setuptools
         python3 -m pip install orjson

gramps/gen/lib/citation.py

@@ -31,6 +31,9 @@
 #
 # -------------------------------------------------------------------------
 import logging
+from collections.abc import Collection
+
+from typing_extensions import override
 
 # -------------------------------------------------------------------------
 #
@@ -197,19 +200,8 @@ def unserialize(self, data):
         SrcAttributeBase.unserialize(self, srcattr_list)
         return self
 
-    def _has_handle_reference(self, classname, handle):
-        """
-        Return True if the object has reference to a given handle of given
-        primary object type.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle: The handle to be checked.
-        :type handle: str
-        :returns: Returns whether the object has reference to this handle of
-                  this object type.
-        :rtype: bool
-        """
+    @override
+    def _has_handle_reference(self, classname: str, handle: str) -> bool:
         if classname == "Note":
             return handle in [ref.ref for ref in self.note_list]
         if classname == "Media":
@@ -218,29 +210,17 @@ def _has_handle_reference(self, classname, handle):
             return handle == self.get_reference_handle()
         return False
 
-    def _remove_handle_references(self, classname, handle_list):
-        """
-        Remove all references in this object to object handles in the list.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle_list: The list of handles to be removed.
-        :type handle_list: str
-        """
+    @override
+    def _remove_handle_references(
+        self, classname: str, handle_list: Collection[str]
+    ) -> None:
         if classname == "Source" and self.get_reference_handle() in handle_list:
             self.set_reference_handle(None)
 
-    def _replace_handle_reference(self, classname, old_handle, new_handle):
-        """
-        Replace all references to old handle with those to the new handle.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param old_handle: The handle to be replaced.
-        :type old_handle: str
-        :param new_handle: The handle to replace the old one with.
-        :type new_handle: str
-        """
+    @override
+    def _replace_handle_reference(
+        self, classname: str, old_handle: str, new_handle: str
+    ) -> None:
         if classname == "Source" and self.get_reference_handle() == old_handle:
             self.set_reference_handle(new_handle)
 

gramps/gen/lib/event.py

@@ -31,6 +31,9 @@
 #
 # -------------------------------------------------------------------------
 import logging
+from collections.abc import Collection
+
+from typing_extensions import override
 
 # -------------------------------------------------------------------------
 #
@@ -255,46 +258,23 @@ def unserialize(self, data):
         TagBase.unserialize(self, tag_list)
         return self
 
-    def _has_handle_reference(self, classname, handle):
-        """
-        Return True if the object has reference to a given handle of given
-        primary object type.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle: The handle to be checked.
-        :type handle: str
-        :returns: Returns whether the object has reference to this handle of
-                  this object type.
-        :rtype: bool
-        """
+    @override
+    def _has_handle_reference(self, classname: str, handle: str) -> bool:
         if classname == "Place":
             return self.place == handle
         return False
 
-    def _remove_handle_references(self, classname, handle_list):
-        """
-        Remove all references in this object to object handles in the list.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle_list: The list of handles to be removed.
-        :type handle_list: str
-        """
+    @override
+    def _remove_handle_references(
+        self, classname: str, handle_list: Collection[str]
+    ) -> None:
         if classname == "Place" and self.place in handle_list:
             self.place = ""
 
-    def _replace_handle_reference(self, classname, old_handle, new_handle):
-        """
-        Replace all references to old handle with those to the new handle.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param old_handle: The handle to be replaced.
-        :type old_handle: str
-        :param new_handle: The handle to replace the old one with.
-        :type new_handle: str
-        """
+    @override
+    def _replace_handle_reference(
+        self, classname: str, old_handle: str, new_handle: str
+    ) -> None:
         if classname == "Place" and self.place == old_handle:
             self.place = new_handle
 

gramps/gen/lib/eventbase.py

@@ -23,6 +23,7 @@
 """
 EventBase class for Gramps.
 """
+from collections.abc import Collection
 
 # -------------------------------------------------------------------------
 #
@@ -135,13 +136,12 @@ def _has_event_reference(self, event_handle):
         """
         return event_handle in [event_ref.ref for event_ref in self.event_ref_list]
 
-    def _remove_event_references(self, handle_list):
+    def _remove_event_references(self, handle_list: Collection[str]):
         """
         Remove any references to the given event handles from the instance's
         :class:`~.eventref.EventRef` list.
 
         :param handle_list: List of valid event handles to remove
-        :type handle_list: list
         """
         new_list = [
             event_ref

gramps/gen/lib/family.py

@@ -31,6 +31,8 @@
 #
 # -------------------------------------------------------------------------
 import logging
+from collections.abc import Collection
+from typing_extensions import override
 
 # -------------------------------------------------------------------------
 #
@@ -254,19 +256,8 @@ def unserialize(self, data):
         TagBase.unserialize(self, tag_list)
         return self
 
-    def _has_handle_reference(self, classname, handle):
-        """
-        Return True if the object has reference to a given handle of given
-        primary object type.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle: The handle to be checked.
-        :type handle: str
-        :returns: Returns whether the object has reference to this handle of
-                  this object type.
-        :rtype: bool
-        """
+    @override
+    def _has_handle_reference(self, classname: str, handle: str) -> bool:
         if classname == "Event":
             return self._has_event_reference(handle)
         if classname == "Person":
@@ -278,15 +269,10 @@ def _has_handle_reference(self, classname, handle):
             return handle in [x.place for x in self.lds_ord_list]
         return False
 
-    def _remove_handle_references(self, classname, handle_list):
-        """
-        Remove all references in this object to object handles in the list.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle_list: The list of handles to be removed.
-        :type handle_list: str
-        """
+    @override
+    def _remove_handle_references(
+        self, classname: str, handle_list: Collection[str]
+    ) -> None:
         if classname == "Event":
             self._remove_event_references(handle_list)
         elif classname == "Person":
@@ -303,17 +289,10 @@ def _remove_handle_references(self, classname, handle_list):
                 if lds_ord.place in handle_list:
                     lds_ord.place = None
 
-    def _replace_handle_reference(self, classname, old_handle, new_handle):
-        """
-        Replace all references to old handle with those to the new handle.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param old_handle: The handle to be replaced.
-        :type old_handle: str
-        :param new_handle: The handle to replace the old one with.
-        :type new_handle: str
-        """
+    @override
+    def _replace_handle_reference(
+        self, classname: str, old_handle: str, new_handle: str
+    ) -> None:
         if classname == "Event":
             self._replace_event_references(old_handle, new_handle)
         elif classname == "Person":

gramps/gen/lib/note.py

@@ -24,6 +24,9 @@
 """
 Note class for Gramps.
 """
+from collections.abc import Collection
+
+from typing_extensions import override
 
 # -------------------------------------------------------------------------
 #
@@ -172,22 +175,8 @@ def get_referenced_handles(self):
         reflist.extend(self.get_referenced_tag_handles())
         return reflist
 
-    def has_handle_reference(self, classname, handle):
-        """
-        Return True if the object has reference to a given handle of given
-        primary object type.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle: The handle to be checked.
-        :type handle: str
-
-        :returns:
-          Returns whether the object has reference to this handle of
-          this object type.
-
-        :rtype: bool
-        """
+    @override
+    def has_handle_reference(self, classname: str, handle: str) -> bool:
         for dom, obj, prop, hndl in self.get_links():
             if (
                 dom == "gramps"
@@ -198,18 +187,10 @@ def has_handle_reference(self, classname, handle):
                 return True
         return False
 
-    def remove_handle_references(self, classname, handle_list):
-        """
-        Remove all references in this object to object handles in the list.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle_list: The list of handles to be removed.
-        :type handle_list: str
-
-        If the link is in the styled text, we just remove the style for that
-        link.
-        """
+    @override
+    def remove_handle_references(
+        self, classname: str, handle_list: Collection[str]
+    ) -> None:
         tags = []
         for styledtext_tag in self.text.get_tags():
             if (
@@ -222,17 +203,10 @@ def remove_handle_references(self, classname, handle_list):
             tags.append(styledtext_tag)
         self.text.set_tags(tags)
 
-    def replace_handle_reference(self, classname, old_handle, new_handle):
-        """
-        Replace all references to old handle with those to the new handle.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param old_handle: The handle to be replaced.
-        :type old_handle: str
-        :param new_handle: The handle to replace the old one with.
-        :type new_handle: str
-        """
+    @override
+    def replace_handle_reference(
+        self, classname: str, old_handle: str, new_handle: str
+    ) -> None:
         for styledtext_tag in self.text.get_tags():
             if (
                 styledtext_tag.name == StyledTextTagType.LINK

gramps/gen/lib/person.py

@@ -24,6 +24,8 @@
 """
 Person object for Gramps.
 """
+from collections.abc import Collection
+from typing_extensions import override
 
 # -------------------------------------------------------------------------
 #
@@ -342,19 +344,8 @@ def set_object_state(self, attr_dict):
         self.__gender = attr_dict.pop("gender")
         super().set_object_state(attr_dict)
 
-    def _has_handle_reference(self, classname, handle):
-        """
-        Return True if the object has reference to a given handle of given
-        primary object type.
-
-        :param classname: The name of the primary object class.
-        :type classname: str
-        :param handle: The handle to be checked.
-        :type handle: str
-        :returns: Returns whether the object has reference to this handle of
-                  this object type.
-        :rtype: bool
-        """
+    @override
+    def _has_handle_reference(self, classname: str, handle: str) -> bool:
         if classname == "Event":
             return self._has_event_reference(handle)
         if classname == "Person":
@@ -370,7 +361,10 @@ def _has_handle_reference(self, classname, handle):
             return any(ordinance.place == handle for ordinance in self.lds_ord_list)
         return False
 
-    def _remove_handle_references(self, classname, handle_list):
+    @override
+    def _remove_handle_references(
+        self, classname: str, handle_list: Collection[str]
+    ) -> None:
         if classname == "Event":
             # Keep a copy of the birth and death references
             birth_ref = self.get_birth_ref()
@@ -422,7 +416,10 @@ def _remove_handle_references(self, classname, handle_list):
                 if ordinance.place in handle_list:
                     ordinance.place = None
 
-    def _replace_handle_reference(self, classname, old_handle, new_handle):
+    @override
+    def _replace_handle_reference(
+        self, classname: str, old_handle: str, new_handle: str
+    ) -> None:
         if classname == "Event":
             refs_list = [ref.ref for ref in self.event_ref_list]
             new_ref = None