def __init__(self, database, namespace, locale=glocale):
"""Initialize sort class."""
self.database = database
self.locale = locale
self.name_display = NameDisplay(xlocale=self.locale)
self.place_display = PlaceDisplay()
self.namespace = namespace
self.query_method = self.database.method("get_%s_from_handle",
self.namespace)
)
from gramps.gen.lib.primaryobj import BasicPrimaryObject as GrampsObject
from gramps.gen.soundex import soundex
from gramps.gen.utils.db import (
get_birth_or_fallback,
get_death_or_fallback,
get_divorce_or_fallback,
get_marriage_or_fallback,
)
from gramps.gen.utils.grampslocale import GrampsLocale
from gramps.gen.utils.place import conv_lat_lon
from ...const import SEX_FEMALE, SEX_MALE, SEX_UNKNOWN
from ...types import Handle
pd = PlaceDisplay()
def get_person_by_handle(db_handle: DbReadBase,
handle: Handle) -> Union[Person, Dict]:
"""Safe get person by handle."""
try:
return db_handle.get_person_from_handle(handle)
except HandleError:
return {}
def get_place_by_handle(db_handle: DbReadBase,
handle: Handle) -> Union[Place, Dict]:
"""Safe get place by handle."""
try:
class Sort:
"""Class for extracting sort keys."""
def __init__(self, database, namespace, locale=glocale):
"""Initialize sort class."""
self.database = database
self.locale = locale
self.name_display = NameDisplay(xlocale=self.locale)
self.place_display = PlaceDisplay()
self.namespace = namespace
self.query_method = self.database.method("get_%s_from_handle",
self.namespace)
# Generic object key methods
def by_id_key(self, handle):
"""Compare by Gramps Id."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.gramps_id)
def by_change_key(self, handle):
"""Compare by last change."""
obj = self.query_method(handle)
return obj.change
def by_private_key(self, handle):
"""Compare based on private attribute."""
obj = self.query_method(handle)
return int(obj.private)
def by_date_key(self, handle):
"""Compare by date."""
obj = self.query_method(handle)
return obj.get_date_object().get_sort_value()
def by_type_key(self, handle):
"""Compare by type."""
obj = self.query_method(handle)
return self.locale.sort_key(
self.locale.translation.sgettext(str(obj.get_type())))
# Specific object key methods
def by_person_surname_key(self, handle):
"""Compare by surname, if equal uses given name and suffix."""
obj = self.query_method(handle)
name = obj.get_primary_name()
fsn = name.get_surname()
ffn = name.get_first_name()
fsu = name.get_suffix()
return self.locale.sort_key(fsn + ffn + fsu)
def by_person_sorted_name_key(self, handle):
"""Compare by displayed names."""
obj = self.query_method(handle)
return self.locale.sort_key(self.name_display.sorted(obj))
def by_person_soundex_key(self, handle):
"""Compare by soundex."""
obj = self.query_method(handle)
return soundex(obj.get_primary_name().get_surname())
def by_person_birthdate_key(self, handle):
"""Compare by birth date, if equal sorts by name."""
obj = self.query_method(handle)
birth = get_birth_or_fallback(self.database, obj)
if birth:
date = birth.get_date_object()
else:
date = Date()
return "%08d" % date.get_sort_value() + str(
self.by_person_surname_key(handle))
def by_person_deathdate_key(self, handle):
"""Compare by death date, if equal sorts by name."""
obj = self.query_method(handle)
death = get_death_or_fallback(self.database, obj)
if death:
date = death.get_date_object()
else:
date = Date()
return "%08d" % date.get_sort_value() + str(
self.by_person_surname_key(handle))
def by_person_gender_key(self, handle):
"""Compare by gender."""
obj = self.query_method(handle)
return obj.gender
def by_family_surname_key(self, handle):
"""Compare by family surname, if equal uses given and suffix."""
obj = self.query_method(handle)
if obj.father_handle is not None:
person = self.database.get_person_from_handle(obj.father_handle)
elif obj.mother_handle is not None:
person = self.database.get_person_from_handle(obj.mother_handle)
name = person.get_primary_name()
fsn = name.get_surname()
ffn = name.get_first_name()
fsu = name.get_suffix()
return self.locale.sort_key(fsn + ffn + fsu)
def by_family_soundex_key(self, handle):
"""Compare by family soundex."""
obj = self.query_method(handle)
if obj.father_handle is not None:
person = self.database.get_person_from_handle(obj.father_handle)
elif obj.mother_handle is not None:
person = self.database.get_person_from_handle(obj.mother_handle)
return soundex(person.get_primary_name().get_surname())
def by_family_type_key(self, handle):
"""Compare by relationship type."""
obj = self.query_method(handle)
return self.locale.sort_key(
self.locale.translation.sgettext(str(obj.type)))
def by_event_place_key(self, handle):
"""Compare by event place."""
obj = self.query_method(handle)
return self.locale.sort_key(
self.place_display.display_event(self.database, obj))
def by_event_description_key(self, handle):
"""Compare by event description."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.get_description())
def by_place_title_key(self, handle):
"""Compare by place title."""
obj = self.query_method(handle)
return self.locale.sort_key(
self.place_display.display(self.database, obj))
def by_place_latitude_key(self, handle):
"""Compare by place latitude."""
obj = self.query_method(handle)
return obj.lat
def by_place_longitude_key(self, handle):
"""Compare by place longitude."""
obj = self.query_method(handle)
return obj.long
def by_citation_confidence_key(self, handle):
"""Compare by citation confidence."""
obj = self.query_method(handle)
return obj.confidence
def by_source_title_key(self, handle):
"""Compare by source title."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.title)
def by_source_author_key(self, handle):
"""Compare by source title."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.author)
def by_source_pubinfo_key(self, handle):
"""Compare by source publication info."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.pubinfo)
def by_source_abbrev_key(self, handle):
"""Compare by source abbreviation."""
obj = self.query_method(handle)
return obj.abbrev
def by_repository_name_key(self, handle):
"""Compare by repository name."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.name)
def by_media_title_key(self, handle):
"""Compare by media title."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.desc)
def by_media_path_key(self, handle):
"""Compare by media path."""
obj = self.query_method(handle)
return obj.path
def by_media_mimetype_key(self, handle):
"""Compare by media mime type."""
obj = self.query_method(handle)
return obj.mime
def by_note_text_key(self, handle):
"""Compare by note text."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.text.string)
def by_tag_name_key(self, handle):
"""Compare by tag name."""
obj = self.query_method(handle)
return self.locale.sort_key(obj.name)
def by_tag_color_key(self, handle):
"""Compare by tag color."""
obj = self.query_method(handle)
return obj.color
def by_tag_priority_key(self, handle):
"""Compare by tag priority."""
obj = self.query_method(handle)
return obj.priority