From 957239950d53dc751e6803014574c7ea259acfae Mon Sep 17 00:00:00 2001 From: Benny Malengier Date: Sun, 9 Mar 2008 18:10:13 +0000 Subject: [PATCH] 2008-03-09 Benny Malengier * src/gen/db/base.py: add docstring to find functions, #1866 * src/gen/db/dbdir.py: add docstring to find functions, #1866 svn: r10236 --- ChangeLog | 4 ++++ src/gen/db/base.py | 41 +++++++++++++++++++++++++++++++++++++++++ src/gen/db/dbdir.py | 9 +++++++++ 3 files changed, 54 insertions(+) diff --git a/ChangeLog b/ChangeLog index 51cfa113b..41020566b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,7 @@ +2008-03-09 Benny Malengier + * src/gen/db/base.py: add docstring to find functions, #1866 + * src/gen/db/dbdir.py: add docstring to find functions, #1866 + 2008-03-08 Brian Matherly * src/docgen/PdfDoc.py: 0001917: UI font gets small when creating PDF documents. diff --git a/src/gen/db/base.py b/src/gen/db/base.py index 31e672280..288b6e041 100644 --- a/src/gen/db/base.py +++ b/src/gen/db/base.py @@ -814,6 +814,15 @@ class GrampsDbBase(Callback): def find_from_handle(self, handle, transaction, class_type, dmap, add_func): + """ + Find a object of class_type in the database from the passed handle. + + If no object exists, a new object is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple + """ obj = class_type() handle = str(handle) new = True @@ -840,6 +849,10 @@ class GrampsDbBase(Callback): Find a Person in the database from the passed handle. If no such Person exists, a new Person is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple """ return self.find_from_handle(handle, transaction, Person, self.person_map, self.add_person) @@ -849,6 +862,10 @@ class GrampsDbBase(Callback): Find a Source in the database from the passed handle. If no such Source exists, a new Source is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple """ return self.find_from_handle(handle, transaction, Source, self.source_map, self.add_source) @@ -858,6 +875,10 @@ class GrampsDbBase(Callback): Find a Event in the database from the passed handle. If no such Event exists, a new Event is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple """ return self.find_from_handle(handle, transaction, Event, self.event_map, self.add_event) @@ -867,6 +888,10 @@ class GrampsDbBase(Callback): Find a MediaObject in the database from the passed handle. If no such MediaObject exists, a new Object is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple """ return self.find_from_handle(handle, transaction, MediaObject, self.media_map, self.add_object) @@ -876,6 +901,10 @@ class GrampsDbBase(Callback): Find a Place in the database from the passed handle. If no such Place exists, a new Place is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple """ return self.find_from_handle(handle, transaction, Place, self.place_map, self.add_place) @@ -885,6 +914,10 @@ class GrampsDbBase(Callback): Find a Family in the database from the passed handle. If no such Family exists, a new Family is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple """ return self.find_from_handle(handle, transaction, Family, self.family_map, self.add_family) @@ -894,6 +927,10 @@ class GrampsDbBase(Callback): Find a Repository in the database from the passed handle. If no such Repository exists, a new Repository is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple """ return self.find_from_handle(handle, transaction, Repository, self.repository_map, self.add_repository) @@ -903,6 +940,10 @@ class GrampsDbBase(Callback): Find a Note in the database from the passed handle. If no such Note exists, a new Note is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple """ return self.find_from_handle(handle, transaction, Note, self.note_map, self.add_note) diff --git a/src/gen/db/dbdir.py b/src/gen/db/dbdir.py index 535c8cac3..0315fb0d8 100644 --- a/src/gen/db/dbdir.py +++ b/src/gen/db/dbdir.py @@ -1493,6 +1493,15 @@ class GrampsDBDir(GrampsDbBase, UpdateCallback): return None def find_from_handle(self, handle, transaction, class_type, dmap, add_func): + """ + Find a object of class_type in the database from the passed handle. + + If no object exists, a new object is added to the database. + + @return: Returns a tuple, first the object, second a bool which is True + if the object is new + @rtype: tuple + """ obj = class_type() handle = str(handle) new = True