The gramps.gen.proxy Module

Proxy Base

Proxy class for the Gramps databases. Filter out all data marked private.

class gramps.gen.proxy.proxybase.ProxyCursor(get_raw, get_handles)

Bases: object

A cursor for moving through proxied data.

class gramps.gen.proxy.proxybase.ProxyDbBase(db)

Bases: DbReadBase

ProxyDbBase is a base class for building a proxy to a Gramps database. This class attempts to implement functions that are likely to be common among proxy classes. Functions that are not likely to be common raise a NotImplementedError to remind the developer to implement those functions.

Real database proxy classes can inherit from this class to make sure the database interface is properly implemented.

close()

Close on a proxy closes real database.

find_initial_person()

Find an initial person, given that they might not be available.

get_bookmarks()

returns the list of Person handles in the bookmarks

get_child_reference_types()

returns a list of all child reference types associated with Family instances in the database

get_citation_bookmarks()

returns the list of Citation handles in the bookmarks

get_citation_cursor()

Return a reference to a cursor over Citation objects. Example use:

with get_citation_cursor() as cursor:
    for handle, citation in cursor:
        # process citation object pointed to by the handle

get_citation_from_gramps_id(val)

Finds a Citation in the database from the passed gramps’ ID. If no such Citation exists, None is returned.

get_citation_from_handle(handle)

Finds a Citation in the database from the passed gramps handle. If no such Citation exists, None is returned.

get_citation_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Citation in the database.

get_dbid()

Return the database ID.

get_default_handle()

returns the default Person of the database

get_default_person()

returns the default Person of the database

get_event_attribute_types()

returns a list of all Attribute types associated with Event instances in the database

get_event_bookmarks()

returns the list of Event handles in the bookmarks

get_event_cursor()

Return a reference to a cursor over Family objects. Example use:

with get_event_cursor() as cursor:
    for handle, event in cursor:
        # process event object pointed to by the handle

get_event_from_gramps_id(val)

Finds an Event in the database from the passed Gramps ID. If no such Event exists, None is returned.

get_event_from_handle(handle)

Finds a Event in the database from the passed gramps handle. If no such Event exists, None is returned.

get_event_handles()

Return a list of database handles, one handle for each Event in the database.

get_event_roles()

returns a list of all custom event role names associated with Event instances in the database

get_event_types()

returns a list of all event types in the database

get_family_attribute_types()

returns a list of all Attribute types associated with Family instances in the database

get_family_bookmarks()

returns the list of Family handles in the bookmarks

get_family_cursor()

Return a reference to a cursor over Family objects. Example use:

with get_family_cursor() as cursor:
    for handle, family in cursor:
        # process family object pointed to by the handle

get_family_event_types()

Deprecated: Use get_event_types

get_family_from_gramps_id(val)

Finds a Family in the database from the passed Gramps ID. If no such Family exists, None is returned.

get_family_from_handle(handle)

Finds a Family in the database from the passed gramps handle. If no such Family exists, None is returned.

get_family_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Family in the database. If sort_handles is True, the list is sorted by surnames

get_family_relation_types()

returns a list of all relationship types associated with Family instances in the database

get_media_attribute_types()

returns a list of all Attribute types associated with Media and MediaRef instances in the database

get_media_bookmarks()

returns the list of Media handles in the bookmarks

get_media_cursor()

Return a reference to a cursor over Media objects. Example use:

with get_media_cursor() as cursor:
    for handle, media in cursor:
        # process media object pointed to by the handle

get_media_from_gramps_id(val)

Finds a Media in the database from the passed gramps’ ID. If no such Media exists, None is returned.

get_media_from_handle(handle)

Finds an Object in the database from the passed gramps handle. If no such Object exists, None is returned.

get_media_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Media in the database.

get_mediapath()

returns the default media path of the database

get_name_group_keys()

Return the defined names that have been assigned to a default grouping

get_name_group_mapping(surname)

Return the default grouping name for a surname

get_name_types()

returns a list of all custom names types associated with Person instances in the database

get_note_bookmarks()

returns the list of Note handles in the bookmarks

get_note_cursor()

Return a reference to a cursor over Note objects. Example use:

with get_note_cursor() as cursor:
    for handle, note in cursor:
        # process note object pointed to by the handle

get_note_from_gramps_id(val)

Finds a Note in the database from the passed gramps’ ID. If no such Note exists, None is returned.

get_note_from_handle(handle)

Finds a Note in the database from the passed gramps handle. If no such Note exists, None is returned.

get_note_handles()

Return a list of database handles, one handle for each Note in the database.

get_note_types()

returns a list of all custom note types associated with Note instances in the database

get_number_of_citations()

Return the number of Citations currently in the database.

get_number_of_events()

Return the number of events currently in the database.

get_number_of_families()

Return the number of families currently in the database.

get_number_of_media()

Return the number of media objects currently in the database.

get_number_of_notes()

Return the number of notes currently in the database.

get_number_of_people()

Return the number of people currently in the database.

get_number_of_places()

Return the number of places currently in the database.

get_number_of_repositories()

Return the number of source repositories currently in the database.

get_number_of_sources()

Return the number of sources currently in the database.

get_number_of_tags()

Return the number of tags currently in the database.

get_origin_types()

returns a list of all custom origin types associated with Person/Surname instances in the database

get_person_attribute_types()

returns a list of all Attribute types associated with Person instances in the database

get_person_cursor()

Return a reference to a cursor over Person objects. Example use:

with get_person_cursor() as cursor:
    for handle, person in cursor:
        # process person object pointed to by the handle

get_person_event_types()

Deprecated: Use get_event_types

get_person_from_gramps_id(val)

Finds a Person in the database from the passed Gramps ID. If no such Person exists, None is returned.

get_person_from_handle(handle)

Finds a Person in the database from the passed gramps handle. If no such Person exists, None is returned.

get_person_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Person in the database. If sort_handles is True, the list is sorted by surnames

get_place_bookmarks()

returns the list of Place handles in the bookmarks

get_place_cursor()

Return a reference to a cursor over Place objects. Example use:

with get_place_cursor() as cursor:
    for handle, place in cursor:
        # process place object pointed to by the handle

get_place_from_gramps_id(val)

Finds a Place in the database from the passed gramps’ ID. If no such Place exists, None is returned.

get_place_from_handle(handle)

Finds a Place in the database from the passed gramps handle. If no such Place exists, None is returned.

get_place_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Place in the database.

get_raw_citation_data(handle)

Return raw (serialized and pickled) Citation object from handle

get_raw_event_data(handle)

Return raw (serialized and pickled) Event object from handle

get_raw_family_data(handle)

Return raw (serialized and pickled) Family object from handle

get_raw_media_data(handle)

Return raw (serialized and pickled) Family object from handle

get_raw_note_data(handle)

Return raw (serialized and pickled) Note object from handle

get_raw_person_data(handle)

Return raw (serialized and pickled) Person object from handle

get_raw_place_data(handle)

Return raw (serialized and pickled) Place object from handle

get_raw_repository_data(handle)

Return raw (serialized and pickled) Repository object from handle

get_raw_source_data(handle)

Return raw (serialized and pickled) Source object from handle

get_raw_tag_data(handle)

Return raw (serialized and pickled) Tag object from handle

get_repo_bookmarks()

returns the list of Repository handles in the bookmarks

get_repository_cursor()

Return a reference to a cursor over Repository objects. Example use:

with get_repository_cursor() as cursor:
    for handle, repository in cursor:
        # process repository object pointed to by the handle

get_repository_from_gramps_id(val)

Finds a Repository in the database from the passed gramps’ ID. If no such Repository exists, None is returned.

get_repository_from_handle(handle)

Finds a Repository in the database from the passed gramps handle. If no such Repository exists, None is returned.

get_repository_handles()

Return a list of database handles, one handle for each Repository in the database.

get_repository_types()

returns a list of all custom repository types associated with Repository instances in the database

get_researcher()

returns the Researcher instance, providing information about the owner of the database

get_save_path()

returns the save path of the file, or “” if one does not exist

get_source_attribute_types()

returns a list of all Attribute types associated with Source/Citation instances in the database

get_source_bookmarks()

returns the list of Source handles in the bookmarks

get_source_cursor()

Return a reference to a cursor over Source objects. Example use:

with get_source_cursor() as cursor:
    for handle, source in cursor:
        # process source object pointed to by the handle

get_source_from_gramps_id(val)

Finds a Source in the database from the passed gramps’ ID. If no such Source exists, None is returned.

get_source_from_handle(handle)

Finds a Source in the database from the passed gramps handle. If no such Source exists, None is returned.

get_source_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Source in the database.

get_source_media_types()

returns a list of all custom source media types associated with Source instances in the database

get_tag_cursor()

Return a reference to a cursor over Tag objects. Example use:

with get_tag_cursor() as cursor:
    for handle, tag in cursor:
        # process tag object pointed to by the handle

get_tag_from_handle(handle)

Finds a Tag in the database from the passed gramps handle. If no such Tag exists, None is returned.

get_tag_from_name(val)

Finds a Tag in the database from the passed tag name. If no such Tag exists, None is returned.

get_tag_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Tag in the database.

get_url_types()

returns a list of all custom names types associated with Url instances in the database

static gfilter(predicate, obj)

Returns obj if predicate is True or not callable, else returns None

has_citation_handle(handle)

returns True if the handle exists in the current Citation database.

has_event_handle(handle)

returns True if the handle exists in the current Event database.

has_family_handle(handle)

Returns True if the handle exists in the current Family database.

has_media_handle(handle)

returns True if the handle exists in the current Mediadatabase.

has_name_group_key(name)

Return if a key exists in the name_group table

has_note_handle(handle)

returns True if the handle exists in the current Note database.

has_person_handle(handle)

Returns True if the handle exists in the current Person database.

has_place_handle(handle)

returns True if the handle exists in the current Place database.

has_repository_handle(handle)

returns True if the handle exists in the current Repository database.

has_source_handle(handle)

returns True if the handle exists in the current Source database.

has_tag_handle(handle)

returns True if the handle exists in the current Tag database.

include_citation = None

include_event = None

include_family = None

include_media = None

include_note = None

include_person = None

include_place = None

include_repository = None

include_something(handle, obj=None)

Model predicate. Returns True if object referred to by handle is to be included, otherwise returns False.

include_source = None

include_tag = None

is_open()

Return True if the database has been opened.

iter_citation_handles()

Return an iterator over database handles, one handle for each Citation in the database.

iter_citations()

Return an iterator over Citation objects in the database

iter_event_handles()

Return an iterator over database handles, one handle for each Event in the database.

iter_events()

Return an iterator over Event objects in the database

iter_families()

Return an iterator over Family objects in the database

iter_family_handles()

Return an iterator over database handles, one handle for each Family in the database.

iter_media()

Return an iterator over Media objects in the database

iter_media_handles()

Return an iterator over database handles, one handle for each Media Object in the database.

iter_note_handles()

Return an iterator over database handles, one handle for each Note in the database.

iter_notes()

Return an iterator over Note objects in the database

iter_people()

Return an iterator over Person objects in the database

iter_person_handles()

Return an iterator over database handles, one handle for each Person in the database.

iter_place_handles()

Return an iterator over database handles, one handle for each Place in the database.

iter_places()

Return an iterator over Place objects in the database

iter_repositories()

Return an iterator over Repositories objects in the database

iter_repository_handles()

Return an iterator over database handles, one handle for each Repository in the database.

iter_source_handles()

Return an iterator over database handles, one handle for each Source in the database.

iter_sources()

Return an iterator over Source objects in the database

iter_tag_handles()

Return an iterator over database handles, one handle for each Tag in the database.

iter_tags()

Return an iterator over Tag objects in the database

class gramps.gen.proxy.proxybase.ProxyMap(db, get_raw, get_keys)

Bases: object

A dictionary-like object for accessing “raw” proxied data. Of course, proxied data may have been changed by the proxy.

keys()

return the keys

Filter

Proxy class for the Gramps databases. Apply filter

class gramps.gen.proxy.filter.FilterProxyDb(db, person_filter=None, event_filter=None, note_filter=None, user=None)

Bases: ProxyDbBase

A proxy to a Gramps database. This proxy will act like a Gramps database, but all data that does not match the provided filters will be hidden from the user.

find_backlink_handles(handle, include_classes=None)

Find all objects that hold a reference to the object handle. Returns an iterator over a list of (class_name, handle) tuples.

Parameters:

• handle (database handle) – handle of the object to search for.

• include_classes (list of class names) – list of class names to include in the results. Default: None means include all classes.

This default implementation does a sequential scan through all the primary object databases and is very slow. Backends can override this method to provide much faster implementations that make use of additional capabilities of the backend.

Note that this is a generator function, it returns a iterator for use in loops. If you want a list of the results use:

>    result_list = list(find_backlink_handles(handle))

get_citation_from_gramps_id(val)

Finds a Citation in the database from the passed Gramps ID. If no such Citation exists, None is returned.

get_citation_from_handle(handle)

Finds a Citation in the database from the passed Gramps ID. If no such Citation exists, None is returned.

get_default_handle()

returns the default Person of the database

get_default_person()

returns the default Person of the database

get_event_from_gramps_id(val)

Finds an Event in the database from the passed Gramps ID. If no such Event exists, None is returned.

get_event_from_handle(handle)

Finds a Event in the database from the passed Gramps ID. If no such Event exists, None is returned.

get_event_handles()

Return a list of database handles, one handle for each Event in the database.

get_family_from_gramps_id(val)

Finds a Family in the database from the passed Gramps ID. If no such Family exists, None is returned.

get_family_from_handle(handle)

Finds a Family in the database from the passed Gramps ID. If no such Family exists, None is returned.

get_family_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Family in the database.

Parameters:

• sort_handles (bool) – If True, the list is sorted by surnames.

• locale (A GrampsLocale object.) – The locale to use for collation.

get_media_from_gramps_id(val)

Finds a Media in the database from the passed Gramps ID. If no such Media exists, None is returned.

get_media_from_handle(handle)

Finds a Media in the database from the passed Gramps handle. If no such Object exists, None is returned.

get_note_from_gramps_id(val)

Finds a Note in the database from the passed Gramps ID. If no such Note exists, None is returned.

get_note_from_handle(handle)

Finds a Note in the database from the passed Gramps ID. If no such Note exists, None is returned.

get_note_handles()

Return a list of database handles, one handle for each Note in the database.

get_person_from_gramps_id(val)

Finds a Person in the database from the passed Gramps ID. If no such Person exists, None is returned.

get_person_from_handle(handle)

Finds a Person in the database from the passed Gramps ID. If no such Person exists, None is returned.

get_person_handles(sort_handles=False, locale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Return a list of database handles, one handle for each Person in the database.

Parameters:

• sort_handles (bool) – If True, the list is sorted by surnames.

• locale (A GrampsLocale object.) – The locale to use for collation.

get_place_from_gramps_id(val)

Finds a Place in the database from the passed Gramps ID. If no such Place exists, None is returned.

get_place_from_handle(handle)

Finds a Place in the database from the passed Gramps handle. If no such Place exists, None is returned.

get_repository_from_gramps_id(val)

Finds a Repository in the database from the passed Gramps ID. If no such Repository exists, None is returned.

get_repository_from_handle(handle)

Finds a Repository in the database from the passed Gramps ID. If no such Repository exists, None is returned.

get_source_from_gramps_id(val)

Finds a Source in the database from the passed Gramps ID. If no such Source exists, None is returned.

get_source_from_handle(handle)

Finds a Source in the database from the passed Gramps ID. If no such Source exists, None is returned.

has_event_handle(handle)

returns True if the handle exists in the current Event database.

has_family_handle(handle)

returns True if the handle exists in the current Family database.

has_note_handle(handle)

returns True if the handle exists in the current Note database.

has_person_handle(handle)

returns True if the handle exists in the current Person database.

include_event(handle)

include_family(handle)

include_note(handle)

include_person(handle)

iter_event_handles()

Return an iterator over database handles, one handle for each Event in the database.

iter_events()

Return an iterator over objects for Events in the database

iter_families()

Return an iterator over objects for Families in the database

iter_family_handles()

Return an iterator over database handles, one handle for each Family in the database.

iter_note_handles()

Return an iterator over database handles, one handle for each Note in the database.

iter_notes()

Return an iterator over objects for Notes in the database

iter_people()

Return an iterator over objects for Persons in the database

iter_person_handles()

Return an iterator over database handles, one handle for each Person in the database.

sanitize_addressbase(addressbase)

sanitize_notebase(notebase)

Filters notes out of the passed notebase object according to the Note Filter.

Parameters:

notebase – NoteBase object to clean

sanitize_person(person)

Cleans filtered notes out of the passed person

Parameters:

event (Person) – Person object to clean

Living

Proxy class for the Gramps databases. Filter out all living people.

class gramps.gen.proxy.living.LivingProxyDb(dbase, mode, current_year=None, years_after_death=0, llocale=<gramps.gen.utils.grampslocale.GrampsLocale object>)

Bases: ProxyDbBase

A proxy to a Gramps database. This proxy will act like a Gramps database, but all living people will be hidden from the user.

MODE_EXCLUDE_ALL = 0

MODE_INCLUDE_ALL = 99

MODE_INCLUDE_FULL_NAME_ONLY = 2

MODE_INCLUDE_LAST_NAME_ONLY = 1

MODE_REPLACE_COMPLETE_NAME = 3

find_backlink_handles(handle, include_classes=None)

Find all objects that hold a reference to the object handle. Returns an iterator over a list of (class_name, handle) tuples.

Parameters:

• handle (database handle) – handle of the object to search for.

• include_classes (list of class names) – list of class names to include in the results. Default: None means include all classes.

This default implementation does a sequential scan through all the primary object databases and is very slow. Backends can override this method to provide much faster implementations that make use of additional capabilities of the backend.

Note that this is a generator function, it returns a iterator for use in loops. If you want a list of the results use:

>    result_list = list(find_backlink_handles(handle))

get_default_handle()

returns the default Person of the database

get_default_person()

returns the default Person of the database

get_family_from_gramps_id(val)

Finds a Family in the database from the passed Gramps ID. If no such Family exists, None is returned.

get_family_from_handle(handle)

Finds a Family in the database from the passed handle. If no such Family exists, None is returned.

get_person_from_gramps_id(val)

Finds a Person in the database from the passed Gramps ID. If no such Person exists, None is returned.

get_person_from_handle(handle)

Finds a Person in the database from the passed Gramps ID. If no such Person exists, None is returned.

has_person_handle(handle)

returns True if the handle exists in the current Person database.

include_person(handle)

iter_people()

Protected version of iter_people

Private

Proxy class for the Gramps databases. Filter out all data marked private.

class gramps.gen.proxy.private.PrivateProxyDb(db)

Bases: ProxyDbBase

A proxy to a Gramps database. This proxy will act like a Gramps database, but all data marked private will be hidden from the user.

find_backlink_handles(handle, include_classes=None)

Find all objects that hold a reference to the object handle. Returns an iterator over a list of (class_name, handle) tuples.

Parameters:

• handle (database handle) – handle of the object to search for.

• include_classes (list of class names) – list of class names to include in the results. Default: None means include all classes.

This default implementation does a sequential scan through all the primary object databases and is very slow. Backends can override this method to provide much faster implementations that make use of additional capabilities of the backend.

Note that this is a generator function, it returns a iterator for use in loops. If you want a list of the results use:

>    result_list = list(find_backlink_handles(handle))

get_citation_from_gramps_id(val)

Finds a Citation in the database from the passed Gramps ID. If no such Citation exists, None is returned.

get_citation_from_handle(handle)

Finds a Citation in the database from the passed Gramps ID. If no such Citation exists, None is returned.

get_default_handle()

returns the default Person of the database

get_default_person()

returns the default Person of the database

get_event_from_gramps_id(val)

Finds an Event in the database from the passed Gramps ID. If no such Event exists, None is returned.

get_event_from_handle(handle)

Finds a Event in the database from the passed Gramps ID. If no such Event exists, None is returned.

get_family_from_gramps_id(val)

Finds a Family in the database from the passed Gramps ID. If no such Family exists, None is returned.

get_family_from_handle(handle)

Finds a Family in the database from the passed Gramps ID. If no such Family exists, None is returned.

get_media_from_gramps_id(val)

Finds a Media in the database from the passed Gramps ID. If no such Media exists, None is returned.

get_media_from_handle(handle)

Finds an Object in the database from the passed Gramps ID. If no such Object exists, None is returned.

get_note_from_gramps_id(val)

Finds a Note in the database from the passed Gramps ID. If no such Note exists, None is returned.

get_note_from_handle(handle)

Finds a Note in the database from the passed Gramps ID. If no such Note exists, None is returned.

get_person_from_gramps_id(val)

Finds a Person in the database from the passed Gramps ID. If no such Person exists, None is returned.

get_person_from_handle(handle)

Finds a Person in the database from the passed Gramps ID. If no such Person exists, None is returned.

get_place_from_gramps_id(val)

Finds a Place in the database from the passed Gramps ID. If no such Place exists, None is returned.

get_place_from_handle(handle)

Finds a Place in the database from the passed Gramps ID. If no such Place exists, None is returned.

get_repository_from_gramps_id(val)

Finds a Repository in the database from the passed Gramps ID. If no such Repository exists, None is returned.

get_repository_from_handle(handle)

Finds a Repository in the database from the passed Gramps ID. If no such Repository exists, None is returned.

get_source_from_gramps_id(val)

Finds a Source in the database from the passed Gramps ID. If no such Source exists, None is returned.

get_source_from_handle(handle)

Finds a Source in the database from the passed Gramps ID. If no such Source exists, None is returned.

has_citation_handle(handle)

returns True if the handle exists in the current Citation database.

has_event_handle(handle)

returns True if the handle exists in the current Event database.

has_family_handle(handle)

Return True if the handle exists in the current Family database.

has_note_handle(handle)

Return True if the handle exists in the current Note database.

has_object_handle(handle)

Return True if the handle exists in the current Mediadatabase.

has_person_handle(handle)

returns True if the handle exists in the current Person database.

has_place_handle(handle)

returns True if the handle exists in the current Place database.

has_repository_handle(handle)

Return True if the handle exists in the current Repository database.

has_source_handle(handle)

returns True if the handle exists in the current Source database.

include_citation(handle)

Predicate returning True if object is to be included, else False

include_event(handle)

Predicate returning True if object is to be included, else False

include_family(handle)

Predicate returning True if object is to be included, else False

include_media(handle)

Predicate returning True if object is to be included, else False

include_note(handle)

Predicate returning True if object is to be included, else False

include_person(handle)

Predicate returning True if object is to be included, else False

include_place(handle)

Predicate returning True if object is to be included, else False

include_repository(handle)

Predicate returning True if object is to be included, else False

include_source(handle)

Predicate returning True if object is to be included, else False

gramps.gen.proxy.private.copy_addresses(db, original_obj, clean_obj)

Copies addresses from one object to another - excluding references to private addresses.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (AddressBase) – Object that may have addresses

• clean_obj – Object that will have only non-private addresses

Returns:

Nothing

gramps.gen.proxy.private.copy_associations(db, original_obj, clean_obj)

Copies associations from one object to another - excluding references to private notes.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (Base) – Object that may have private references

• clean_obj – Object that will have only non-private references

Returns:

Nothing

gramps.gen.proxy.private.copy_attributes(db, original_obj, clean_obj)

Copies attributes from one object to another - excluding references to private attributes.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (AttributeBase) – Object that may have private references

• clean_obj – Object that will have only non-private references

Returns:

Nothing

gramps.gen.proxy.private.copy_citation_ref_list(db, original_obj, clean_obj)

Copies citation references from one object to another - excluding references to private citations, and references to citations that refer to private sources.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (CitationBase) – Object that may have private references

• clean_obj – Object that will have only non-private references

Returns:

Nothing

gramps.gen.proxy.private.copy_lds_ords(db, original_obj, clean_obj)

Copies LDS ORDs from one object to another - excluding references to private LDS ORDs.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (LdsOrdBase) – Object that may have LDS ORDs

• clean_obj – Object that will have only non-private LDS ORDs

Returns:

Nothing

gramps.gen.proxy.private.copy_media_ref_list(db, original_obj, clean_obj)

Copies media references from one object to another - excluding private references and references to private objects.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (MediaBase) – Object that may have private references

• clean_obj – Object that will have only non-private references

Returns:

Nothing

gramps.gen.proxy.private.copy_notes(db, original_obj, clean_obj)

Copies notes from one object to another - excluding references to private notes.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (NoteBase) – Object that may have private references

• clean_obj – Object that will have only non-private references

Returns:

Nothing

gramps.gen.proxy.private.copy_srcattributes(db, original_obj, clean_obj)

Copies srcattributes from one object to another - excluding references to private srcattributes.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (SrcAttributeBase) – Object that may have private references

• clean_obj – Object that will have only non-private references

Returns:

Nothing

gramps.gen.proxy.private.copy_urls(db, original_obj, clean_obj)

Copies urls from one object to another - excluding references to private urls.

Parameters:

• db (DbBase) – Gramps database to which the references belongs

• original_obj (UrlBase) – Object that may have urls

• clean_obj – Object that will have only non-private urls

Returns:

Nothing

gramps.gen.proxy.private.sanitize_address(db, address)

Create a new Address instance based off the passed Address instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• name (Address) – source Address object that will be copied with privacy records removed

Returns:

‘cleansed’ Address object

Return type:

Address

gramps.gen.proxy.private.sanitize_citation(db, citation)

Create a new Citation instance based off the passed Citation instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• citation (Citation) – source Citation object that will be copied with privacy records removed

Returns:

‘cleansed’ Citation object

Return type:

Citation

gramps.gen.proxy.private.sanitize_event(db, event)

Create a new Event instance based off the passed Event instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• event (Event) – source Event object that will be copied with privacy records removed

Returns:

‘cleansed’ Event object

Return type:

Event

gramps.gen.proxy.private.sanitize_event_ref(db, event_ref)

Create a new EventRef instance based off the passed EventRef instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• event_ref (EventRef) – source EventRef object that will be copied with privacy records removed

Returns:

‘cleansed’ EventRef object

Return type:

EventRef

gramps.gen.proxy.private.sanitize_family(db, family)

Create a new Family instance based off the passed Family instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• family (Family) – source Family object that will be copied with privacy records removed

Returns:

‘cleansed’ Family object

Return type:

Family

gramps.gen.proxy.private.sanitize_lds_ord(db, lds_ord)

Create a new LdsOrd instance based off the passed LdsOrd instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the LdsOrd object belongs

• name (LdsOrd) – source LdsOrd object that will be copied with privacy records removed

Returns:

‘cleansed’ LdsOrd object

Return type:

LdsOrd

gramps.gen.proxy.private.sanitize_media(db, media)

Create a new Media instance based off the passed Media instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• media (Media) – source Media object that will be copied with privacy records removed

Returns:

‘cleansed’ Media object

Return type:

Media

gramps.gen.proxy.private.sanitize_media_ref(db, media_ref)

Create a new MediaRef instance based off the passed MediaRef instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the MediaRef object belongs

• source_ref (MediaRef) – source MediaRef object that will be copied with privacy records removed

Returns:

‘cleansed’ MediaRef object

Return type:

MediaRef

gramps.gen.proxy.private.sanitize_name(db, name)

Create a new Name instance based off the passed Name instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• name (Name) – source Name object that will be copied with privacy records removed

Returns:

‘cleansed’ Name object

Return type:

Name

gramps.gen.proxy.private.sanitize_person(db, person)

Create a new Person instance based off the passed Person instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• person (Person) – source Person object that will be copied with privacy records removed

Returns:

‘cleansed’ Person object

Return type:

Person

gramps.gen.proxy.private.sanitize_place(db, place)

Create a new Place instance based off the passed Place instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• place (Place) – source Place object that will be copied with privacy records removed

Returns:

‘cleansed’ Place object

Return type:

Place

gramps.gen.proxy.private.sanitize_repository(db, repository)

Create a new Repository instance based off the passed Repository instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• repository (Repository) – source Repository object that will be copied with privacy records removed

Returns:

‘cleansed’ Repository object

Return type:

Repository

gramps.gen.proxy.private.sanitize_source(db, source)

Create a new Source instance based off the passed Source instance. The returned instance has all private records removed from it.

Parameters:

• db (DbBase) – Gramps database to which the Person object belongs

• source (Source) – source Source object that will be copied with privacy records removed

Returns:

‘cleansed’ Source object

Return type:

Source

References

Proxy class for the Gramps databases. Returns objects which are referenced by a person, or through a chain of references starting with a person.

class gramps.gen.proxy.referencedbyselection.ReferencedBySelectionProxyDb(dbase, all_people=False)

Bases: ProxyDbBase

A proxy to a Gramps database. This proxy will act like a Gramps database, but returning all objects which are referenced by a selection, or by an object that is referenced by an object which is eventually referenced by one of the selected objects.

find_backlink_handles(handle, include_classes=None)

Return appropriate backlink handles for this proxy.

include_citation(handle)

Filter for citations

include_event(handle)

Filter for events

include_family(handle)

Filter for families

include_media(handle)

Filter for media objects

include_note(handle)

Filter for notes

include_person(handle)

Filter for person

include_place(handle)

Filter for places

include_repository(handle)

Filter for repositories

include_source(handle)

Filter for sources

include_tag(handle)

Filter for tags

process_address(address)

Find all of the primary objects referred to

process_addresses(original_obj)

Find all of the primary objects referred to

process_associations(original_obj)

Find all of the primary objects referred to

process_attributes(original_obj)

Find all of the primary objects referred to

process_citation(citation)

Follow the citation object and find all of the primary objects that it references.

process_citation_ref_list(original_obj)

Find all of the primary objects referred to

process_event(event)

Follow the event object and find all of the primary objects that it references.

process_event_ref(event_ref)

Find all of the primary objects referred to

process_family(family)

Follow the family object and find all of the primary objects that it references.

process_lds_ord(lds_ord)

Find all of the primary objects referred to

process_lds_ords(original_obj)

Find all of the primary objects referred to

process_media(media)

Follow the media object and find all of the primary objects that it references.

process_media_ref_list(original_obj)

Find all of the primary objects referred to

process_name(name)

Find all of the primary objects referred to

process_note(note)

Follow the note object and find all of the primary objects that it references.

process_notes(original_obj)

Find all of the primary objects referred to

process_object(class_name, handle, reference=True)

process_person(person, reference=True)

Follow the person object and find all of the primary objects that it references.

process_place(place)

Follow the place object and find all of the primary objects that it references.

process_repository(repository)

Follow the repository object and find all of the primary objects that it references.

process_source(source)

Follow the source object and find all of the primary objects that it references.

process_tags(original_obj)

Record the tags referenced by the primary object.

process_urls(original_obj)

Find all of the primary objects referred to

queue_object(obj_type, handle, reference=True)

reset_references()