Add to surname list

SteveY · April 11, 2026, 4:04pm

Currently we have incompatible signatures for the DB method add_to_surname_list

gramps/gen/db/base.py

3eda7b1e4


      
              """
              raise NotImplementedError
          
          def add_tag(self, tag, transaction):
              """
              Add a Tag to the database, assigning a handle if it has not already
              been defined.
              """
              raise NotImplementedError
          
          def add_to_surname_list(self, person, batch_transaction, name):
              """
              Add surname from given person to list of surnames
              """
              raise NotImplementedError
          
          def commit_citation(self, citation, transaction, change_time=None):
              """
              Commit the specified Event to the database, storing the changes as
              part of the transaction.
              """

and

github.com/gramps-project/gramps

gramps/gen/db/generic.py

3eda7b1e4


      
          
          def set_mediapath(self, mediapath):
              return self._set_metadata("media-path", mediapath)
          
          def get_surname_list(self):
              """
              Return the list of locale-sorted surnames contained in the database.
              """
              return self.surname_list
          
          def add_to_surname_list(self, person, batch_transaction):
              """
              Add surname to surname list
              """
              if batch_transaction:
                  return
              name = None
              primary_name = person.get_primary_name()
              if primary_name:
                  surname_list = primary_name.get_surname_list()
                  if len(surname_list) > 0:

This looks like it could be a mistake. The name parameter is not used in core code. Is anyone aware of any add-ons using this parameter?

dsblank · April 11, 2026, 7:10pm

Looks like a bug. It is going to be so great to have all of the function signatures checked (and corrected)! Great work!

SteveY · April 11, 2026, 10:16pm

Proposed fix include in Additional Type Hinting for DB Related Classes by stevenyoungs · Pull Request #2232 · gramps-project/gramps

Topic		Replies	Views
Surnames list handling Development	1	50	June 24, 2025
Programatic add of Note and Citation to Association Development	4	76	October 15, 2024
Export Gramps to Myheritage with married surname Development uuid	4	86	November 22, 2024
Autoadding some entities for new created person Feature Ideas	7	99	October 8, 2024
When Gramps will build the surnames list on the first time? Development	2	96	April 21, 2025

Add to surname list

Related topics