Add type hints to db methods

Author: stevenyoungs

gramps/gen/db/base.py

@@ -23,6 +23,7 @@
 # Standard Python modules
 #
 # -------------------------------------------------------------------------
+from __future__ import annotations
 from ....const import GRAMPS_LOCALE as glocale
 
 _ = glocale.translation.gettext

gramps/gen/db/dummydb.py

@@ -23,6 +23,7 @@
 # Standard Python modules
 #
 # -------------------------------------------------------------------------
+from __future__ import annotations
 from ....const import GRAMPS_LOCALE as glocale
 
 _ = glocale.translation.gettext

gramps/gen/db/generic.py

@@ -21,7 +21,59 @@
 """
 Proxy class for the Gramps databases. Caches lookups from handles.
 """
+# -------------------------------------------------------------------------
+#
+# Standard python modules
+#
+# -------------------------------------------------------------------------
+from __future__ import annotations
 
+# -------------------------------------------------------------------------
+#
+# Gramps libraries
+#
+# -------------------------------------------------------------------------
+from ..lib import (
+    Date,
+    Person,
+    Name,
+    Surname,
+    NameOriginType,
+    Family,
+    Source,
+    Citation,
+    Event,
+    Media,
+    Place,
+    Repository,
+    Note,
+    Tag,
+)
+from ..types import (
+    AnyHandle,
+    PersonHandle,
+    EventHandle,
+    FamilyHandle,
+    PlaceHandle,
+    PrimaryObject,
+    SourceHandle,
+    RepositoryHandle,
+    CitationHandle,
+    MediaHandle,
+    NoteHandle,
+    TagHandle,
+    PrimaryObjectHandle,
+    TableObjectType,
+    PersonGrampsID,
+    EventGrampsID,
+    FamilyGrampsID,
+    PlaceGrampsID,
+    SourceGrampsID,
+    RepositoryGrampsID,
+    CitationGrampsID,
+    MediaGrampsID,
+    NoteGrampsID,
+)
 from ..utils.lru import LRU
 
 
@@ -57,7 +109,7 @@ def __getattr__(self, attr):
         """
         return getattr(self.db, attr)
 
-    def clear_cache(self, handle=None):
+    def clear_cache(self, handle: PrimaryObjectHandle | None = None):
         """
         Clears all caches if handle is None, or
         specific entry.
@@ -67,7 +119,7 @@ def clear_cache(self, handle=None):
         else:
             self.cache_handle.clear()
 
-    def get_person_from_handle(self, handle):
+    def get_person_from_handle(self, handle: PersonHandle) -> Person:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -76,7 +128,7 @@ def get_person_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_person_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_event_from_handle(self, handle):
+    def get_event_from_handle(self, handle: EventHandle) -> Event:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -85,7 +137,7 @@ def get_event_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_event_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_family_from_handle(self, handle):
+    def get_family_from_handle(self, handle: FamilyHandle) -> Family:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -94,7 +146,7 @@ def get_family_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_family_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_repository_from_handle(self, handle):
+    def get_repository_from_handle(self, handle: RepositoryHandle) -> Repository:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -103,7 +155,7 @@ def get_repository_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_repository_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_place_from_handle(self, handle):
+    def get_place_from_handle(self, handle: PlaceHandle) -> Place:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -112,7 +164,7 @@ def get_place_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_place_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_citation_from_handle(self, handle):
+    def get_citation_from_handle(self, handle: CitationHandle) -> Citation:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -121,7 +173,7 @@ def get_citation_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_citation_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_source_from_handle(self, handle):
+    def get_source_from_handle(self, handle: SourceHandle) -> Source:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -130,7 +182,7 @@ def get_source_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_source_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_note_from_handle(self, handle):
+    def get_note_from_handle(self, handle: NoteHandle) -> Note:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -139,7 +191,7 @@ def get_note_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_note_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_media_from_handle(self, handle):
+    def get_media_from_handle(self, handle: MediaHandle) -> Media:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.
@@ -148,7 +200,7 @@ def get_media_from_handle(self, handle):
             self.cache_handle[handle] = self.db.get_media_from_handle(handle)
         return self.cache_handle[handle]
 
-    def get_tag_from_handle(self, handle):
+    def get_tag_from_handle(self, handle: TagHandle) -> Tag:
         """
         Gets item from cache if it exists. Converts
         handles to string, for uniformity.

gramps/gen/filters/rules/person/_isdefaultperson.py

@@ -30,6 +30,7 @@
 #
 # -------------------------------------------------------------------------
 from __future__ import annotations
+from typing import Generator, List
 
 # -------------------------------------------------------------------------
 #
@@ -123,7 +124,7 @@ def __init__(
                 self.flist.update(person.get_family_handle_list())
                 self.flist.update(person.get_parent_family_handle_list())
 
-    def get_person_from_handle(self, handle):
+    def get_person_from_handle(self, handle: PersonHandle) -> Person | None:
         """
         Finds a Person in the database from the passed Gramps ID.
         If no such Person exists, None is returned.
@@ -179,7 +180,7 @@ def include_event(self, handle):
     def include_note(self, handle):
         return handle in self.nlist
 
-    def get_source_from_handle(self, handle):
+    def get_source_from_handle(self, handle: SourceHandle) -> Source | None:
         """
         Finds a Source in the database from the passed Gramps ID.
         If no such Source exists, None is returned.
@@ -203,7 +204,7 @@ def get_source_from_handle(self, handle):
 
         return source
 
-    def get_citation_from_handle(self, handle):
+    def get_citation_from_handle(self, handle: CitationHandle) -> Citation | None:
         """
         Finds a Citation in the database from the passed Gramps ID.
         If no such Citation exists, None is returned.
@@ -213,7 +214,7 @@ def get_citation_from_handle(self, handle):
         self.sanitize_notebase(citation)
         return citation
 
-    def get_media_from_handle(self, handle):
+    def get_media_from_handle(self, handle: MediaHandle) -> Media | None:
         """
         Finds a Media in the database from the passed Gramps handle.
         If no such Object exists, None is returned.
@@ -230,7 +231,7 @@ def get_media_from_handle(self, handle):
 
         return media
 
-    def get_place_from_handle(self, handle):
+    def get_place_from_handle(self, handle: PlaceHandle) -> Place | None:
         """
         Finds a Place in the database from the passed Gramps handle.
         If no such Place exists, None is returned.
@@ -250,7 +251,7 @@ def get_place_from_handle(self, handle):
 
         return place
 
-    def get_event_from_handle(self, handle):
+    def get_event_from_handle(self, handle: EventHandle) -> Event | None:
         """
         Finds a Event in the database from the passed Gramps ID.
         If no such Event exists, None is returned.
@@ -263,7 +264,7 @@ def get_event_from_handle(self, handle):
         else:
             return None
 
-    def get_family_from_handle(self, handle):
+    def get_family_from_handle(self, handle: FamilyHandle) -> Family | None:
         """
         Finds a Family in the database from the passed Gramps ID.
         If no such Family exists, None is returned.
@@ -320,7 +321,7 @@ def get_family_from_handle(self, handle):
         else:
             return None
 
-    def get_repository_from_handle(self, handle):
+    def get_repository_from_handle(self, handle: RepositoryHandle) -> Repository | None:
         """
         Finds a Repository in the database from the passed Gramps ID.
         If no such Repository exists, None is returned.
@@ -331,7 +332,7 @@ def get_repository_from_handle(self, handle):
         self.sanitize_addressbase(repository)
         return repository
 
-    def get_note_from_handle(self, handle):
+    def get_note_from_handle(self, handle: NoteHandle) -> Note | None:
         """
         Finds a Note in the database from the passed Gramps ID.
         If no such Note exists, None is returned.
@@ -444,7 +445,9 @@ def get_note_from_gramps_id(self, gramps_id: NoteGrampsID) -> Note | None:
         else:
             return None
 
-    def get_person_handles(self, sort_handles=False, locale=glocale):
+    def get_person_handles(
+        self, sort_handles: bool = False, locale=glocale
+    ) -> List[PersonHandle]:
         """
         Return a list of database handles, one handle for each Person in
         the database.
@@ -457,7 +460,7 @@ def get_person_handles(self, sort_handles=False, locale=glocale):
         # FIXME: plist is not a sorted list of handles
         return list(self.plist)
 
-    def iter_person_handles(self):
+    def iter_person_handles(self) -> Generator[PersonHandle]:
         """
         Return an iterator over database handles, one handle for each Person in
         the database.
@@ -490,7 +493,7 @@ def iter_events(self):
         """
         return map(self.get_event_from_handle, self.elist)
 
-    def get_family_handles(self, sort_handles=False, locale=glocale):
+    def get_family_handles(self, sort_handles: bool = False, locale=glocale):
         """
         Return a list of database handles, one handle for each Family in
         the database.
@@ -516,7 +519,7 @@ def iter_families(self):
         """
         return map(self.get_family_from_handle, self.flist)
 
-    def get_note_handles(self):
+    def get_note_handles(self) -> List[NoteHandle]:
         """
         Return a list of database handles, one handle for each Note in
         the database.
@@ -576,7 +579,7 @@ def has_note_handle(self, handle):
         """
         return handle in self.nlist
 
-    def find_backlink_handles(self, handle, include_classes=None):
+    def find_backlink_handles(self, handle: AnyHandle, include_classes=None):
         """
         Find all objects that hold a reference to the object handle.
         Returns an iterator over a list of (class_name, handle) tuples.