The way FormActions dynamically identified action classes gave no control over the order in which actions were added to the UI. Rather than make an already complex solution more complex, take a different, simpler, approach. The form action module now provides a standalone get_actions function which returns a list of all available actions the module can provide for the given citation and form event.

As an additional benefit this gives a natural point to optimise the get_actions functions in the future, should this become necessary. For example, by pre-loading all Person records and attributes prior to calling the class.get_action functions.

Author: stevenyoungs

Form/UK1841.py

@@ -51,11 +51,21 @@
 
 _ = _trans.gettext
 
-class PrimaryNameCitation(ActionBase):
-    def __init__(self):
-        ActionBase.__init__(self)
-
-    def get_actions(self, dbstate, citation, form_event):
+def get_actions(dbstate, citation, form_event):
+    """
+    return a list of all actions that this module can provide for the given citation and form
+    each list entry is a string, describing the action category, and a list of actions that can be performed.
+    """
+    actions = []
+    actions.append(PrimaryNameCitation.get_actions(dbstate, citation, form_event))
+    actions.append(AlternateName.get_actions(dbstate, citation, form_event))
+    actions.append(BirthEvent.get_actions(dbstate, citation, form_event))
+    actions.append(OccupationEvent.get_actions(dbstate, citation, form_event))
+    actions.append(ResidenceEvent.get_actions(dbstate, citation, form_event))
+    return actions
+
+class PrimaryNameCitation:
+    def get_actions(dbstate, citation, form_event):
         db = dbstate.db
         actions = []
         for (person, attr) in ActionBase.get_form_person_attr(db, form_event.get_handle(), 'Name'):
@@ -70,11 +80,8 @@ def command(dbstate, uistate, track, citation_handle, person_handle):
         with DbTxn(_("Add Person (%s)") % name_displayer.display(person), db) as trans:
             db.commit_person(person, trans)
 
-class AlternateName(ActionBase):
-    def __init__(self):
-        ActionBase.__init__(self)
-
-    def get_actions(self, dbstate, citation, form_event):
+class AlternateName:
+    def get_actions(dbstate, citation, form_event):
         db = dbstate.db
         actions = []
         for (person, attr) in ActionBase.get_form_person_attr(db, form_event.get_handle(), 'Name'):
@@ -92,11 +99,8 @@ def command(dbstate, uistate, track, person_handle, alternate):
         with DbTxn(_("Add Person (%s)") % name_displayer.display(person), db) as trans:
             db.commit_person(person, trans)
 
-class BirthEvent(ActionBase):
-    def __init__(self):
-        ActionBase.__init__(self)
-
-    def get_actions(self, dbstate, citation, form_event):
+class BirthEvent:
+    def get_actions(dbstate, citation, form_event):
         db = dbstate.db
         actions = []
         # if there is no date on the form, no actions can be performed
@@ -124,11 +128,8 @@ def get_actions(self, dbstate, citation, form_event):
                                         lambda dbstate, uistate, track, citation_handle = citation.handle, person_handle = person.handle, birth_date_ = birth_date: ActionBase.add_event_to_person(dbstate, uistate, track, person_handle, EventType.BIRTH, birth_date_, None, citation_handle, EventRoleType.PRIMARY)))
         return (_("Add Birth event"), actions)
 
-class OccupationEvent(ActionBase):
-    def __init__(self):
-        ActionBase.__init__(self)
-
-    def get_actions(self, dbstate, citation, form_event):
+class OccupationEvent:
+    def get_actions(dbstate, citation, form_event):
         db = dbstate.db
         actions = []
         for (person, attr) in ActionBase.get_form_person_attr(db, form_event.get_handle(), 'Occupation'):
@@ -138,11 +139,8 @@ def get_actions(self, dbstate, citation, form_event):
                          lambda dbstate, uistate, track, citation_handle = citation.handle, person_handle = person.handle, occupation_ = occupation: ActionBase.add_event_to_person(dbstate, uistate, track, person_handle, EventType.OCCUPATION, form_event.get_date_object(), occupation_, citation_handle, EventRoleType.PRIMARY)))
         return (_("Add Occupation event"), actions)
 
-class ResidenceEvent(ActionBase):
-    def __init__(self):
-        ActionBase.__init__(self)
-
-    def get_actions(self, dbstate, citation, form_event):
+class ResidenceEvent:
+    def get_actions(dbstate, citation, form_event):
         db = dbstate.db
         # build a list of all the people referenced in the form. For 1841, all people have a PRIMARY event role
         people = []

Form/formactions.py

@@ -58,7 +58,6 @@
 #------------------------------------------------------------------------
 from editform import find_form_event
 from form import (get_form_id, get_form_type)
-from actionbase import ActionBase
 
 #------------------------------------------------------------------------
 #
@@ -209,16 +208,14 @@ def all_children_consistent(model, parent, col):
     def _populate_model(self):
         form_id = get_form_id(self.source)
         if self.actions_module:
-            # get all classes defined in actions_module which are a subclass of ActionBase (but exclude ActionBase itself)
-            action_classes = inspect.getmembers(self.actions_module, lambda obj: inspect.isclass(obj) and obj is not ActionBase and issubclass(obj, ActionBase))
-
-            for action_class in action_classes:
-                action = (action_class[1])()
-                (title, action_details) = action.get_actions(self.dbstate, self.citation, self.event)
-                if action_details:
+            # get the all actions that the actions module can provide for the form
+            # because the module is dynamically loaded, use getattr to retrieve the actual function to call
+            all_actions = getattr(self.actions_module, 'get_actions')(self.dbstate, self.citation, self.event)
+            for (title, actions) in all_actions:
+                if actions:
                     # add the action category
                     parent = self.model.append(None, (False, False, title, None, None))
-                    for action_detail in action_details:
+                    for action_detail in actions:
                         # add available actions within this category
                         self.model.append(parent, (False, False) + action_detail)