A straightforward implementation of #673 : added webarg "name_format"… (#674)

* A straightforward implementation of #673 : added webarg "name_format", a "name_display" field to the person profile, and initialization code using gramps.gen.display.name displayer

* #673 corrected type hint for the name_format argument

* #673 roll back from using default displayer - created a new instance of NameDisplay with locale that comes from request + some code cleanup

* #673 used another style for type hint

* #673 - updated test cases related to profile

* #673 Added name_format webarg to GrampsObject_resource

* #673 added simple test for name_format argument present in the query

* #673 now passing the name_format argument starting from the HTTP GET handlers to all the get_%s_profile_for_object and get_%s_profile_for_handle for %s in "person", "family", "event" and "timeline". Added couple of tests for correct name_display and updated apispec.yaml

* #673 typos corrected

* #673 added name_format argument to some function calls

---------

Co-authored-by: David Straub <[email protected]>

Author: vktimofeev

gramps_webapi/api/resources/base.py

@@ -98,7 +98,10 @@ def full_object(self, obj: T, args: dict, locale: GrampsLocale = glocale) -> T:
                 # create profile if doesn't exist
                 obj.profile = {}
             obj.profile["references"] = get_reference_profile_for_object(
-                self.db_handle, obj, locale=locale
+                self.db_handle,
+                obj,
+                locale=locale,
+                name_format=args.get("name_format"),
             )
         return obj
 
@@ -207,6 +210,7 @@ class GrampsObjectResource(GrampsObjectResourceHelper, Resource):
             "locale": fields.Str(
                 load_default=None, validate=validate.Length(min=1, max=5)
             ),
+            "name_format": fields.Str(validate=validate.Length(min=1)),
             "profile": fields.DelimitedList(
                 fields.Str(validate=validate.Length(min=1)),
                 validate=validate.ContainsOnly(
@@ -373,6 +377,7 @@ class GrampsObjectsResource(GrampsObjectResourceHelper, Resource):
             "soundex": fields.Boolean(load_default=False),
             "strip": fields.Boolean(load_default=False),
             "filemissing": fields.Boolean(load_default=False),
+            "name_format": fields.Str(validate=validate.Length(min=1)),
         },
         location="query",
     )

gramps_webapi/api/resources/events.py

@@ -64,7 +64,11 @@ def object_extend(
             if "families" in args["profile"] or "events" in args["profile"]:
                 abort_with_message(422, "profile contains invalid keys")
             obj.profile = get_event_profile_for_object(
-                db_handle, obj, args["profile"], locale=locale
+                db_handle,
+                obj,
+                args["profile"],
+                locale=locale,
+                name_format=args.get("name_format"),
             )
         return obj
 

gramps_webapi/api/resources/families.py

@@ -54,7 +54,11 @@ def object_extend(
         db_handle = self.db_handle
         if "profile" in args:
             obj.profile = get_family_profile_for_object(
-                db_handle, obj, args["profile"], locale=locale
+                db_handle,
+                obj,
+                args["profile"],
+                locale=locale,
+                name_format=args.get("name_format"),
             )
         if "extend" in args:
             obj.extended = get_extended_attributes(db_handle, obj, args)

gramps_webapi/api/resources/people.py

@@ -50,7 +50,11 @@ def object_extend(
         db_handle = self.db_handle
         if "profile" in args:
             obj.profile = get_person_profile_for_object(
-                db_handle, obj, args["profile"], locale=locale
+                db_handle,
+                obj,
+                args["profile"],
+                locale=locale,
+                name_format=args.get("name_format"),
             )
         if "extend" in args:
             obj.extended = get_extended_attributes(db_handle, obj, args)

gramps_webapi/api/resources/search.py

@@ -87,15 +87,27 @@ def get_object_from_handle(
         if "profile" in args:
             if class_name == "person":
                 obj.profile = get_person_profile_for_object(
-                    self.db_handle, obj, args["profile"], locale=locale
+                    self.db_handle,
+                    obj,
+                    args["profile"],
+                    locale=locale,
+                    name_format=args.get("name_format"),
                 )
             elif class_name == "family":
                 obj.profile = get_family_profile_for_object(
-                    self.db_handle, obj, args["profile"], locale=locale
+                    self.db_handle,
+                    obj,
+                    args["profile"],
+                    locale=locale,
+                    name_format=args.get("name_format"),
                 )
             elif class_name == "event":
                 obj.profile = get_event_profile_for_object(
-                    self.db_handle, obj, args["profile"], locale=locale
+                    self.db_handle,
+                    obj,
+                    args["profile"],
+                    locale=locale,
+                    name_format=args.get("name_format"),
                 )
             elif class_name == "citation":
                 obj.profile = get_citation_profile_for_object(

gramps_webapi/api/resources/timeline.py

@@ -109,6 +109,7 @@ def __init__(
         omit_anchor: bool = True,
         precision: int = 1,
         locale: GrampsLocale = glocale,
+        name_format: Optional[str] = None,
     ):
         """Initialize timeline."""
         self.db_handle = db_handle
@@ -131,6 +132,7 @@ def __init__(
         self.set_event_filters(self.event_filters)
         self.set_relative_event_filters(self.relative_event_filters)
         self.birth_dates: Dict[str, Date] = {}
+        self.name_format = name_format
 
         if dates and "-" in dates:
             start, end = dates.split("-")
@@ -465,7 +467,11 @@ def profile(self, page=0, pagesize=20):
                             get_person = False
                 if get_person:
                     person = get_person_profile_for_object(
-                        self.db_handle, person_object, {}, locale=self.locale
+                        self.db_handle,
+                        person_object,
+                        [],
+                        locale=self.locale,
+                        name_format=self.name_format,
                     )
                     if not person_age and person_object.handle in self.birth_dates:
                         person_age = self.get_age(
@@ -534,6 +540,7 @@ class PersonTimelineResource(ProtectedResource, GrampsJSONEncoder):
             "keys": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
             "last": fields.Boolean(load_default=True),
             "locale": fields.Str(load_default=None),
+            "name_format": fields.Str(validate=validate.Length(min=1)),
             "offspring": fields.Integer(
                 load_default=1, validate=validate.Range(min=1, max=5)
             ),
@@ -626,12 +633,14 @@ class FamilyTimelineResource(ProtectedResource, GrampsJSONEncoder):
             "events": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
             "keys": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
             "locale": fields.Str(load_default=None),
+            "name_format": fields.Str(validate=validate.Length(min=1)),
             "page": fields.Integer(load_default=0, validate=validate.Range(min=1)),
             "pagesize": fields.Integer(load_default=20, validate=validate.Range(min=1)),
             "ratings": fields.Boolean(load_default=False),
             "skipkeys": fields.DelimitedList(
                 fields.Str(validate=validate.Length(min=1))
             ),
+            "keys": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
             "strip": fields.Boolean(load_default=False),
         },
         location="query",
@@ -648,6 +657,7 @@ def get(self, args: Dict, handle: str):
                 ratings=args["ratings"],
                 discard_empty=args["discard_empty"],
                 locale=locale,
+                name_format=args.get("name_format"),
             )
             timeline.add_family(Handle(handle))
         except ValueError:
@@ -720,6 +730,7 @@ def get(self, args: Dict):
                 omit_anchor=args["omit_anchor"],
                 precision=args["precision"],
                 locale=locale,
+                name_format=args.get("name_format"),
             )
             if "anchor" in args:
                 timeline.add_person(
@@ -801,6 +812,7 @@ def get(self, args: Dict):
                 ratings=args["ratings"],
                 discard_empty=args["discard_empty"],
                 locale=locale,
+                name_format=args.get("name_format"),
             )
         except ValueError:
             abort(422)