[HouseTimelineGramplet]ADD: houses organised by feature (#159)[gramps50]

ADD: houses organised by number/locality, residents with multiple records listed as date range

Author: todef96

HouseTimelineGramplet/housetimeline.py

@@ -23,12 +23,12 @@ class HouseTimelineGramplet(Gramplet):
     def init(self):
         self.house_width = 40
         self.set_tooltip(_("Double-click name for details"))
+        # self.set_text(_("No Family Tree loaded."))
 
     def on_load(self):
         self.no_wrap()
         tag = self.gui.buffer.create_tag("fixed")
         tag.set_property("font", "Courier 8")
-        # set default house icon style.
         if len(self.gui.data) != 1:
             self.gui.data[:] = ["001", None]
 
@@ -38,14 +38,13 @@ def db_changed(self):
         self.connect(self.dbstate.db,'person-delete', self.update)
 
     def save_update_options(self, widget=None):
-        # saves a specific house icon style.
         style = self.get_option(_("House Icon Style"))
         self.gui.data[:] = [style.get_value()]
         self.update()
 
     def build_options(self):
-        # builds a menu dropdown list of options.
         from gramps.gen.plug.menu import EnumeratedListOption
+        # Add types:
         style_list = EnumeratedListOption(_("House Icon Style"), self.gui.data[0])
         for item in [("001", _("Standard")),
                      ("002", _("Small")),
@@ -58,11 +57,10 @@ def build_options(self):
     def main(self):
         self.set_text(_("Processing...") + "\n")
         yield True
-        self.count_dict = defaultdict(int)
-        self.residents = {}
         self.sorted_residents = {}
         self.clear_text()
         address_count = 0
+        self.residents_range = []
         # get details of people dbhandle, name, address
         for p in self.dbstate.db.iter_people():
             person_handle = p.handle
@@ -74,9 +72,9 @@ def main(self):
                 for item in person_addr:
                     # address format from db is:
                     # [0] street, [1] locality, [2] city, [3] pcode, [4] state/county, [5] country, [6] phone
-                    location = item.get_text_data_list()
+                    address = item.get_text_data_list()
                     date = item.get_date_object()
-                    self.build_parent_address_dict(location,date,person_handle,person_name)
+                    self.build_parent_address_dict(address,date,person_handle,person_name)
 
         if address_count == 0:
             self.set_text(_("There are no individuals with Address data. Please add Address data to people."))
@@ -88,17 +86,20 @@ def main(self):
 
     def build_parent_address_dict(self, address, date, person_handle, person_name):
         """
-        Builds self.residents, The address + person_handle object.
-        The collection is Address keyed (distinct)
+        Builds self.sorted_residents, The address + person_handle object.
+        The collection is grouped by locality/city (group_key) and sub key (address_key)
         """
-        # TODO: group addresses by locality or city
+        # group key represents a group of similar locality/city.
+        group_key = address[1] + address[2]
+        # address key is the actual property address.
         address_key = self.format_address_key(address)
-        # set resident to index key
-        if address_key not in self.residents:
-            self.residents[address_key] = {self.count_dict[address_key]: {'address':address,'date':date.get_ymd(),'handle':person_handle,'pname': person_name}}
-        elif address_key in self.residents:
-            self.residents[address_key][self.count_dict[address_key]] = {'address':address,'date':date.get_ymd(),'handle':person_handle,'pname': person_name}
-        self.count_dict[address_key] += 1
+        if group_key not in self.sorted_residents:
+            self.sorted_residents[group_key] = {address_key: [[date.get_ymd(),person_handle,person_name]]}
+        elif group_key in self.sorted_residents:
+            if address_key not in self.sorted_residents[group_key]:
+                self.sorted_residents[group_key][address_key] = [[date.get_ymd(),person_handle,person_name]]
+            elif address_key in self.sorted_residents[group_key]:
+                self.sorted_residents[group_key][address_key] += [[date.get_ymd(),person_handle,person_name]]
 
     def format_address_key(self, address):
         """
@@ -112,7 +113,7 @@ def format_address_key(self, address):
 
     def build_house(self):
         """
-        Outputs sorted details from self.residents.
+        Outputs sorted details from self.sorted_residents.
         """
         gl_location = _("Location")
         gl_time = _("Time In Family")
@@ -121,29 +122,44 @@ def build_house(self):
         gl_timeline = _("Timeline")
         gl_unknown = _("Unknown")
         gl_total_residents = _("Total Known Residents")
-        for resident in self.residents.items():
-            # sort residents by date.
-            sorted_dates = sorted(resident[1].items(),key=lambda k: k[1]['date'])
-            first_year = 0
-            last_year = int(sorted_dates[-1][1]['date'][0])
-            for years in sorted_dates:
-                date = years[1]['date'][0]
-                first_year = date if date != 0 and first_year == 0 else first_year
-            time_in_family = last_year - first_year if first_year != 0 else gl_unknown
-            self.append_text("=========================\n")
-            self.render_house(self.gui.data[0])
-            self.append_text("{0}: {1}\n".format(gl_location,resident[0]) +
-            ("{0}: {1} years\n".format(gl_time,time_in_family)) +
-            ("{0}: {1} - {2}\n".format(gl_first_resident,sorted_dates[0][1]['date'][0],sorted_dates[0][1]['pname'])) +
-            ("{0}: {1} - {2}\n".format(gl_last_resident,sorted_dates[-1][1]['date'][0],sorted_dates[-1][1]['pname'])) +
-            ("{0}: {1}\n".format(gl_total_residents,len(sorted_dates))) +
-            "                        \n")
-            self.append_text("{0}:\n".format(gl_timeline))
-            # TODO: if duplicate person handles exist, denote as time period of person.
-            for item in sorted_dates:
-                self.append_text("{0} - ".format(item[1]['date'][0]))
-                self.link(item[1]['pname'],"Person",item[1]['handle'])
-                self.append_text("\n")
+
+        for resident in self.sorted_residents.items():
+            # sort by house number
+            for item in sorted(resident[1].items()):
+                # sort residents of an address by date.
+                sorted_dates = sorted(item[1],key=lambda k: k[0][0])
+                residents_reversed = sorted(sorted_dates, reverse=True)
+                # we need a list of distinct handles to get the correct resident count per address.
+                distinct_handles = []
+                for h in sorted_dates:
+                    if h[1] not in distinct_handles:
+                        distinct_handles.append(h[1])
+                first_year = int(sorted_dates[0][0][0])
+                last_year = int(sorted_dates[-1][0][0])
+                time_in_family = last_year - first_year if first_year != 0 else gl_unknown
+                self.append_text("=========================\n")
+                self.render_house(self.gui.data[0])
+                self.append_text("{0}: {1}\n".format(gl_location,item[0]) +
+                ("{0}: {1} years\n".format(gl_time,time_in_family)) +
+                ("{0}: {1} - {2}\n".format(gl_first_resident,sorted_dates[0][0][0],sorted_dates[0][2])) +
+                ("{0}: {1} - {2}\n".format(gl_last_resident,sorted_dates[-1][0][0],sorted_dates[-1][2])) +
+                ("{0}: {1}\n".format(gl_total_residents,len(distinct_handles))) +
+                "                        \n")
+                self.append_text("{0}:\n".format(gl_timeline))
+                # for each person that is a resident, display the date and name with link.
+                for detail in sorted_dates:
+                    # if a person has two address details, display the person living there as a range between two dates.
+                    first_handle = detail
+                    last_handle = next(handle for handle in residents_reversed if handle[1] == first_handle[1])
+                    if (detail[0][0] != last_handle[0][0] and detail[1] not in self.residents_range):
+                        self.append_text("{0} -> {1} - ".format(first_handle[0][0],last_handle[0][0]))
+                        self.link(detail[2],"Person",detail[1])
+                        self.append_text("\n")
+                        self.residents_range.append(first_handle[1])
+                    elif detail[1] not in self.residents_range:
+                        self.append_text("{0} - ".format(detail[0][0]))
+                        self.link(detail[2],"Person",detail[1])
+                        self.append_text("\n")
 
     def render_house(self,house_type):
         """