Refactor extend to accept keyword list, fix emit bug (Closes Issue #33) (#50)

* Refactor extend to accept keyword list, fix emit bug

* Modify extend to require at least one key

Author: cdhorn

gramps_webapi/api/resources/base.py

@@ -28,7 +28,7 @@ def gramps_class_name(self):
     def object_extend(self, obj: GrampsObject, args: Dict) -> GrampsObject:
         """Extend the base object attributes as needed."""
         if "extend" in args:
-            obj.extended = get_extended_attributes(self.db_handle, obj)
+            obj.extended = get_extended_attributes(self.db_handle, obj, args)
         return obj
 
     @property
@@ -60,7 +60,7 @@ class GrampsObjectResource(GrampsObjectResourceHelper, Resource):
             "keys": fields.DelimitedList(fields.Str(), missing=[]),
             "skipkeys": fields.DelimitedList(fields.Str(), missing=[]),
             "profile": fields.Str(validate=validate.Length(equal=0)),
-            "extend": fields.Str(validate=validate.Length(equal=0)),
+            "extend": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
         },
         location="query",
     )
@@ -79,12 +79,11 @@ class GrampsObjectsResource(GrampsObjectResourceHelper, Resource):
     @use_args(
         {
             "gramps_id": fields.Str(validate=validate.Length(min=1)),
-            "handle": fields.Str(validate=validate.Length(min=1)),
             "strip": fields.Str(validate=validate.Length(equal=0)),
             "keys": fields.DelimitedList(fields.Str(), missing=[]),
             "skipkeys": fields.DelimitedList(fields.Str(), missing=[]),
             "profile": fields.Str(validate=validate.Length(equal=0)),
-            "extend": fields.Str(validate=validate.Length(equal=0)),
+            "extend": fields.DelimitedList(fields.Str(validate=validate.Length(min=1))),
             "filter": fields.Str(validate=validate.Length(min=1)),
             "rules": fields.Str(validate=validate.Length(min=1)),
         },

gramps_webapi/api/resources/citation.py

@@ -21,8 +21,11 @@ def object_extend(self, obj: Citation, args: Dict) -> Citation:
         """Extend citation attributes as needed."""
         if "extend" in args:
             db_handle = self.db_handle
-            obj.extended = get_extended_attributes(db_handle, obj)
-            obj.extended["source"] = get_source_by_handle(db_handle, obj.source_handle)
+            obj.extended = get_extended_attributes(db_handle, obj, args)
+            if "all" in args["extend"] or "source" in args["extend"]:
+                obj.extended["source"] = get_source_by_handle(
+                    db_handle, obj.source_handle, args
+                )
         return obj
 
 

gramps_webapi/api/resources/emit.py

@@ -27,18 +27,26 @@ def __init__(self):
         ]
 
     def response(
-        self, status: int = 200, payload: Any = {}, args: Optional[Dict] = None
+        self,
+        status: int = 200,
+        payload: Optional[Any] = None,
+        args: Optional[Dict] = None,
     ) -> Response:
         """Prepare response."""
+        payload = payload or {}
         args = args or {}
         if "strip" in args:
             self.strip_empty_keys = True
         else:
             self.strip_empty_keys = False
         if "keys" in args:
             self.filter_only_keys = args["keys"]
+        else:
+            self.filter_only_keys = []
         if "skipkeys" in args:
             self.filter_skip_keys = args["skipkeys"]
+        else:
+            self.filter_skip_keys = []
 
         return Response(
             response=self.encode(payload),
@@ -68,6 +76,11 @@ def is_null(value: Any) -> bool:
         ):
             apply_filter = True
         for key, value in obj.__class__.__dict__.items():
+            if apply_filter:
+                if self.filter_only_keys and key not in self.filter_only_keys:
+                    continue
+                if self.filter_skip_keys and key in self.filter_skip_keys:
+                    continue
             if isinstance(value, property):
                 data[key] = getattr(obj, key)
         for key, value in obj.__dict__.items():

gramps_webapi/api/resources/event.py

@@ -27,8 +27,9 @@ def object_extend(self, obj: Event, args: Dict) -> Event:
         if "profile" in args:
             obj.profile = get_event_profile_for_object(db_handle, obj)
         if "extend" in args:
-            obj.extended = get_extended_attributes(db_handle, obj)
-            obj.extended["place"] = get_place_by_handle(db_handle, obj.place)
+            obj.extended = get_extended_attributes(db_handle, obj, args)
+            if "all" in args["extend"] or "place" in args["extend"]:
+                obj.extended["place"] = get_place_by_handle(db_handle, obj.place)
         return obj
 
 

gramps_webapi/api/resources/family.py

@@ -29,9 +29,15 @@ def object_extend(self, obj: Family, args: Dict) -> Family:
                 db_handle, obj, with_events=True
             )
         if "extend" in args:
-            obj.extended = get_extended_attributes(db_handle, obj)
-            obj.extended["father"] = get_person_by_handle(db_handle, obj.father_handle)
-            obj.extended["mother"] = get_person_by_handle(db_handle, obj.mother_handle)
+            obj.extended = get_extended_attributes(db_handle, obj, args)
+            if "all" in args["extend"] or "father" in args["extend"]:
+                obj.extended["father"] = get_person_by_handle(
+                    db_handle, obj.father_handle
+                )
+            if "all" in args["extend"] or "mother" in args["extend"]:
+                obj.extended["mother"] = get_person_by_handle(
+                    db_handle, obj.mother_handle
+                )
         return obj
 
 

gramps_webapi/api/resources/person.py

@@ -29,22 +29,21 @@ def object_extend(self, obj: Person, args: Dict) -> Person:
                 db_handle, obj, with_family=True, with_events=True
             )
         if "extend" in args:
-            obj.extended = get_extended_attributes(db_handle, obj)
-            obj.extended.update(
-                {
-                    "families": [
-                        get_family_by_handle(db_handle, handle)
-                        for handle in obj.family_list
-                    ],
-                    "parent_families": [
-                        get_family_by_handle(db_handle, handle)
-                        for handle in obj.parent_family_list
-                    ],
-                    "primary_parent_family": get_family_by_handle(
-                        db_handle, obj.get_main_parents_family_handle()
-                    ),
-                }
-            )
+            obj.extended = get_extended_attributes(db_handle, obj, args)
+            if "all" in args["extend"] or "families" in args["extend"]:
+                obj.extended["families"] = [
+                    get_family_by_handle(db_handle, handle)
+                    for handle in obj.family_list
+                ]
+            if "all" in args["extend"] or "parent_families" in args["extend"]:
+                obj.extended["parent_families"] = [
+                    get_family_by_handle(db_handle, handle)
+                    for handle in obj.parent_family_list
+                ]
+            if "all" in args["extend"] or "primary_parent_family" in args["extend"]:
+                obj.extended["primary_parent_family"] = get_family_by_handle(
+                    db_handle, obj.get_main_parents_family_handle()
+                )
         return obj
 
 

gramps_webapi/api/resources/util.py

@@ -41,24 +41,31 @@ def get_place_by_handle(db_handle: DbReadBase, handle: Handle) -> Optional[Place
 
 
 def get_family_by_handle(
-    db_handle: DbReadBase, handle: Handle, extended: bool = False
+    db_handle: DbReadBase, handle: Handle, args: Optional[Dict] = None
 ) -> Optional[Family]:
-    """Get a family and all extended attributes."""
+    """Get a family and optional extended attributes."""
     try:
         obj = db_handle.get_family_from_handle(handle)
     except HandleError:
         return None
-    if extended:
-        obj.extended = get_extended_attributes(db_handle, obj)
-        obj.extended["father"] = get_person_by_handle(db_handle, obj.father_handle)
-        obj.extended["mother"] = get_person_by_handle(db_handle, obj.mother_handle)
+    args = args or {}
+    if "extend" in args:
+        obj.extended = get_extended_attributes(db_handle, obj, args)
+        if "all" in args["extend"] or "father" in args["extend"]:
+            obj.extended["father"] = get_person_by_handle(db_handle, obj.father_handle)
+        if "all" in args["extend"] or "mother" in args["extend"]:
+            obj.extended["mother"] = get_person_by_handle(db_handle, obj.mother_handle)
     return obj
 
 
-def get_source_by_handle(db_handle: DbReadBase, handle: Handle) -> Source:
-    """Get a source and all extended attributes."""
+def get_source_by_handle(
+    db_handle: DbReadBase, handle: Handle, args: Optional[Dict] = None
+) -> Source:
+    """Get a source and optional extended attributes."""
+    args = args or {}
     obj = db_handle.get_source_from_handle(handle)
-    obj.extended = get_extended_attributes(db_handle, obj)
+    if "extend" in args:
+        obj.extended = get_extended_attributes(db_handle, obj, args)
     return obj
 
 
@@ -216,43 +223,55 @@ def get_family_profile_for_handle(
     return get_family_profile_for_object(db_handle, obj, with_events)
 
 
-def get_extended_attributes(db_handle: DbReadBase, obj: GrampsObject) -> Dict:
+def get_extended_attributes(
+    db_handle: DbReadBase, obj: GrampsObject, args: Optional[Dict] = None
+) -> Dict:
     """Get extended attributes for a GrampsObject."""
+    args = args or {}
     result = {}
-    if hasattr(obj, "child_ref_list"):
+    do_all = False
+    if "all" in args["extend"]:
+        do_all = True
+    if (do_all or "child_ref_list" in args["extend"]) and hasattr(
+        obj, "child_ref_list"
+    ):
         result["children"] = [
             db_handle.get_person_from_handle(child_ref.ref)
             for child_ref in obj.child_ref_list
         ]
-    if hasattr(obj, "citation_list"):
+    if (do_all or "citation_list" in args["extend"]) and hasattr(obj, "citation_list"):
         result["citations"] = [
             db_handle.get_citation_from_handle(handle) for handle in obj.citation_list
         ]
-    if hasattr(obj, "event_ref_list"):
+    if (do_all or "event_ref_list" in args["extend"]) and hasattr(
+        obj, "event_ref_list"
+    ):
         result["events"] = [
             db_handle.get_event_from_handle(event_ref.ref)
             for event_ref in obj.event_ref_list
         ]
-    if hasattr(obj, "media_list"):
+    if (do_all or "media_list" in args["extend"]) and hasattr(obj, "media_list"):
         result["media"] = [
             db_handle.get_media_from_handle(media_ref.ref)
             for media_ref in obj.media_list
         ]
-    if hasattr(obj, "note_list"):
+    if (do_all or "note_list" in args["extend"]) and hasattr(obj, "note_list"):
         result["notes"] = [
             db_handle.get_note_from_handle(handle) for handle in obj.note_list
         ]
-    if hasattr(obj, "person_ref_list"):
+    if (do_all or "person_ref_list" in args["extend"]) and hasattr(
+        obj, "person_ref_list"
+    ):
         result["people"] = [
             db_handle.get_person_from_handle(person_ref.ref)
             for person_ref in obj.person_ref_list
         ]
-    if hasattr(obj, "reporef_list"):
+    if (do_all or "reporef_list" in args["extend"]) and hasattr(obj, "reporef_list"):
         result["repositories"] = [
             db_handle.get_repository_from_handle(repo_ref.ref)
             for repo_ref in obj.reporef_list
         ]
-    if hasattr(obj, "tag_list"):
+    if (do_all or "tag_list" in args["extend"]) and hasattr(obj, "tag_list"):
         result["tags"] = [
             db_handle.get_tag_from_handle(handle) for handle in obj.tag_list
         ]