More db type hints

Author: stevenyoungs

gramps/gen/db/base.py

@@ -31,7 +31,7 @@
 #
 # -------------------------------------------------------------------------
 from __future__ import annotations
-from typing import NoReturn
+from typing import Dict, Generator, List
 import logging
 
 # -------------------------------------------------------------------------
@@ -117,25 +117,25 @@ def get_feature(self, feature):
         """
         return self.__feature.get(feature, None)  # can also be explicitly None
 
-    def set_feature(self, feature, value):
+    def set_feature(self, feature, value) -> None:
         """
         Databases can implement certain features.
         """
         self.__feature[feature] = value
 
-    def close(self):
+    def close(self) -> None:
         """
         Close the specified database.
         """
         raise NotImplementedError
 
-    def db_has_bm_changes(self):
+    def db_has_bm_changes(self) -> bool:
         """
         Return whether there were bookmark changes during the session.
         """
         raise NotImplementedError
 
-    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.
 
@@ -645,7 +645,9 @@ def get_tag_from_handle(self, handle: TagHandle) -> Tag | None:
         """
         raise NotImplementedError
 
-    def get_citation_handles(self, sort_handles=False, locale=glocale):
+    def get_citation_handles(
+        self, sort_handles: bool = False, locale=glocale
+    ) -> List[CitationHandle]:
         """
         Return a list of database handles, one handle for each Citation in
         the database.
@@ -657,7 +659,7 @@ def get_citation_handles(self, sort_handles=False, locale=glocale):
         """
         raise NotImplementedError
 
-    def get_event_handles(self):
+    def get_event_handles(self) -> List[EventHandle]:
         """
         Return a list of database handles, one handle for each Event in the
         database.
@@ -667,7 +669,9 @@ def get_event_handles(self):
         """
         raise NotImplementedError
 
-    def get_family_handles(self, sort_handles=False, locale=glocale):
+    def get_family_handles(
+        self, sort_handles: bool = False, locale=glocale
+    ) -> List[FamilyHandle]:
         """
         Return a list of database handles, one handle for each Family in
         the database.
@@ -682,7 +686,9 @@ def get_family_handles(self, sort_handles=False, locale=glocale):
         """
         raise NotImplementedError
 
-    def get_media_handles(self, sort_handles=False, locale=glocale):
+    def get_media_handles(
+        self, sort_handles: bool = False, locale=glocale
+    ) -> List[MediaHandle]:
         """
         Return a list of database handles, one handle for each Media in
         the database.
@@ -697,7 +703,7 @@ def get_media_handles(self, sort_handles=False, locale=glocale):
         """
         raise NotImplementedError
 
-    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.
@@ -707,7 +713,9 @@ def get_note_handles(self):
         """
         raise NotImplementedError
 
-    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.
@@ -722,7 +730,9 @@ def get_person_handles(self, sort_handles=False, locale=glocale):
         """
         raise NotImplementedError
 
-    def get_place_handles(self, sort_handles=False, locale=glocale):
+    def get_place_handles(
+        self, sort_handles: bool = False, locale=glocale
+    ) -> List[PlaceHandle]:
         """
         Return a list of database handles, one handle for each Place in
         the database.
@@ -737,7 +747,7 @@ def get_place_handles(self, sort_handles=False, locale=glocale):
         """
         raise NotImplementedError
 
-    def get_repository_handles(self):
+    def get_repository_handles(self) -> List[RepositoryHandle]:
         """
         Return a list of database handles, one handle for each Repository in
         the database.
@@ -747,7 +757,9 @@ def get_repository_handles(self):
         """
         raise NotImplementedError
 
-    def get_source_handles(self, sort_handles=False, locale=glocale):
+    def get_source_handles(
+        self, sort_handles: bool = False, locale=glocale
+    ) -> List[SourceHandle]:
         """
         Return a list of database handles, one handle for each Source in
         the database.
@@ -762,7 +774,9 @@ def get_source_handles(self, sort_handles=False, locale=glocale):
         """
         raise NotImplementedError
 
-    def get_tag_handles(self, sort_handles=False, locale=glocale):
+    def get_tag_handles(
+        self, sort_handles: bool = False, locale=glocale
+    ) -> List[TagHandle]:
         """
         Return a list of database handles, one handle for each Tag in
         the database.
@@ -899,7 +913,7 @@ def get_name_group_keys(self):
         """
         raise NotImplementedError
 
-    def get_name_group_mapping(self, surname):
+    def get_name_group_mapping(self, surname: str) -> str:
         """
         Return the default grouping name for a surname.
         """
@@ -971,55 +985,55 @@ def get_person_event_types(self):
         """
         raise NotImplementedError
 
-    def get_raw_citation_data(self, handle: CitationHandle) -> Citation:
+    def get_raw_citation_data(self, handle: CitationHandle) -> Citation | None:
         """
         Return raw (serialized and pickled) Citation object from handle
         """
         raise NotImplementedError
 
-    def get_raw_event_data(self, handle: EventHandle) -> Event:
+    def get_raw_event_data(self, handle: EventHandle) -> Event | None:
         """
         Return raw (serialized and pickled) Event object from handle
         """
         raise NotImplementedError
 
-    def get_raw_family_data(self, handle: FamilyHandle) -> Family:
+    def get_raw_family_data(self, handle: FamilyHandle) -> Family | None:
         """
         Return raw (serialized and pickled) Family object from handle
         """
         raise NotImplementedError
 
-    def get_raw_media_data(self, handle: MediaHandle) -> Media:
+    def get_raw_media_data(self, handle: MediaHandle) -> Media | None:
         """
         Return raw (serialized and pickled) Family object from handle
         """
         raise NotImplementedError
 
-    def get_raw_note_data(self, handle: NoteHandle) -> Note:
+    def get_raw_note_data(self, handle: NoteHandle) -> Note | None:
         """
         Return raw (serialized and pickled) Note object from handle
         """
         raise NotImplementedError
 
-    def get_raw_person_data(self, handle: PersonHandle) -> Person:
+    def get_raw_person_data(self, handle: PersonHandle) -> Person | None:
         """
         Return raw (serialized and pickled) Person object from handle
         """
         raise NotImplementedError
 
-    def get_raw_place_data(self, handle: PlaceHandle) -> Place:
+    def get_raw_place_data(self, handle: PlaceHandle) -> Place | None:
         """
         Return raw (serialized and pickled) Place object from handle
         """
         raise NotImplementedError
 
-    def get_raw_repository_data(self, handle: RepositoryHandle) -> Repository:
+    def get_raw_repository_data(self, handle: RepositoryHandle) -> Repository | None:
         """
         Return raw (serialized and pickled) Repository object from handle
         """
         raise NotImplementedError
 
-    def get_raw_source_data(self, handle: SourceHandle) -> Source:
+    def get_raw_source_data(self, handle: SourceHandle) -> Source | None:
         """
         Return raw (serialized and pickled) Source object from handle
         """
@@ -1184,121 +1198,121 @@ def is_open(self) -> bool:
         """
         raise NotImplementedError
 
-    def iter_citations(self):
+    def iter_citations(self) -> Generator[Citation]:
         """
         Return an iterator over objects for Citations in the database
         """
         raise NotImplementedError
 
-    def iter_events(self):
+    def iter_events(self) -> Generator[Event]:
         """
         Return an iterator over objects for Events in the database
         """
         raise NotImplementedError
 
-    def iter_families(self):
+    def iter_families(self) -> Generator[Family]:
         """
         Return an iterator over objects for Families in the database
         """
         raise NotImplementedError
 
-    def iter_media(self):
+    def iter_media(self) -> Generator[Media]:
         """
         Return an iterator over objects for Medias in the database
         """
         raise NotImplementedError
 
-    def iter_notes(self):
+    def iter_notes(self) -> Generator[Note]:
         """
         Return an iterator over objects for Notes in the database
         """
         raise NotImplementedError
 
-    def iter_people(self):
+    def iter_people(self) -> Generator[Person]:
         """
         Return an iterator over objects for Persons in the database
         """
         raise NotImplementedError
 
-    def iter_places(self):
+    def iter_places(self) -> Generator[Place]:
         """
         Return an iterator over objects for Places in the database
         """
         raise NotImplementedError
 
-    def iter_repositories(self):
+    def iter_repositories(self) -> Generator[Repository]:
         """
         Return an iterator over objects for Repositories in the database
         """
         raise NotImplementedError
 
-    def iter_sources(self):
+    def iter_sources(self) -> Generator[Source]:
         """
         Return an iterator over objects for Sources in the database
         """
         raise NotImplementedError
 
-    def iter_tags(self):
+    def iter_tags(self) -> Generator[Tag]:
         """
         Return an iterator over objects for Tags in the database
         """
         raise NotImplementedError
 
-    def iter_citation_handles(self):
+    def iter_citation_handles(self) -> Generator[CitationHandle]:
         """
         Return an iterator over handles for Citations in the database
         """
         raise NotImplementedError
 
-    def iter_event_handles(self):
+    def iter_event_handles(self) -> Generator[EventHandle]:
         """
         Return an iterator over handles for Events in the database
         """
         raise NotImplementedError
 
-    def iter_family_handles(self):
+    def iter_family_handles(self) -> Generator[FamilyHandle]:
         """
         Return an iterator over handles for Families in the database
         """
         raise NotImplementedError
 
-    def iter_media_handles(self):
+    def iter_media_handles(self) -> Generator[MediaHandle]:
         """
         Return an iterator over handles for Media in the database
         """
         raise NotImplementedError
 
-    def iter_note_handles(self):
+    def iter_note_handles(self) -> Generator[NoteHandle]:
         """
         Return an iterator over handles for Notes in the database
         """
         raise NotImplementedError
 
-    def iter_person_handles(self):
+    def iter_person_handles(self) -> Generator[PersonHandle]:
         """
         Return an iterator over handles for Persons in the database
         """
         raise NotImplementedError
 
-    def iter_place_handles(self):
+    def iter_place_handles(self) -> Generator[PlaceHandle]:
         """
         Return an iterator over handles for Places in the database
         """
         raise NotImplementedError
 
-    def iter_repository_handles(self):
+    def iter_repository_handles(self) -> Generator[RepositoryHandle]:
         """
         Return an iterator over handles for Repositories in the database
         """
         raise NotImplementedError
 
-    def iter_source_handles(self):
+    def iter_source_handles(self) -> Generator[SourceHandle]:
         """
         Return an iterator over handles for Sources in the database
         """
         raise NotImplementedError
 
-    def iter_tag_handles(self):
+    def iter_tag_handles(self) -> Generator[TagHandle]:
         """
         Return an iterator over handles for Tags in the database
         """
@@ -1317,7 +1331,7 @@ def load(
         """
         raise NotImplementedError
 
-    def report_bm_change(self):
+    def report_bm_change(self) -> None:
         """
         Add 1 to the number of bookmark changes during this session.
         """
@@ -1463,7 +1477,7 @@ def get_dbname(self):
         """
         raise NotImplementedError
 
-    def get_summary(self):
+    def get_summary(self) -> Dict[str, int | str]:
         """
         Returns dictionary of summary item.
         Should include, if possible: