gedcom.element.individual module

GEDCOM element consisting of tag gedcom.tags.GEDCOM_TAG_INDIVIDUAL

class gedcom.element.individual.IndividualElement(level, pointer, tag, value, crlf='\n', multi_line=True)

Bases: gedcom.element.element.Element

birth_range_match(from_year, to_year)

Checks if the birth year of a person lies within the given range

Return type

bool

birth_year_match(year)

Returns True if the given year matches the birth year of this person

Return type

bool

criteria_match(criteria)

Checks if this individual matches all of the given criteria criteria is a colon-separated list, where each item in the list has the form [name]=[value]. The following criteria are supported:

surname=[name] - Match a person with [name] in any part of the surname.

given_name=[given_name] - Match a person with [given_name] in any part of the given given_name.

birth=[year] - Match a person whose birth year is a four-digit [year].

birth_range=[from_year-to_year] - Match a person whose birth year is in the range of years from [from_year] to [to_year], including both [from_year] and [to_year].

death=[year] - Match a person whose death year is a four-digit [year].

death_range=[from_year-to_year] - Match a person whose death year is in the range of years from [from_year] to [to_year], including both [from_year] and [to_year].

Return type

bool

death_range_match(from_year, to_year)

Checks if the death year of a person lies within the given range

Return type

bool

death_year_match(year)

Returns True if the given year matches the death year of this person

Return type

bool

get_all_names()

Returns list of individual’s names

Return type

list

get_birth_data()

Returns the birth data of a person formatted as a tuple: (str date, str place, list sources)

Return type

tuple

get_birth_date()

Returns the birth date of a person as a str

Return type

str

get_birth_place()

Returns the birth date of a person as a str

Return type

str

get_birth_year()

Returns the birth year of a person in integer format

Return type

int

get_burial()

Returns the burial data of a person formatted as a tuple: (str date, str´ place, `list sources) ::deprecated:: As of version 1.0.0 use get_burial_data() method instead :rtype: tuple

get_burial_data()

Returns the burial data of a person formatted as a tuple: (str date, str´ place, `list sources)

Return type

tuple

get_census()

Returns a list of censuses of an individual formatted as tuples: (str date, str´ place, `list sources) ::deprecated:: As of version 1.0.0 use get_census_data() method instead :rtype: list of tuple

get_census_data()

Returns a list of censuses of an individual formatted as tuples: (str date, str´ place, `list sources)

Return type

list of tuple

get_death_data()

Returns the death data of a person formatted as a tuple: (str date, str place, list sources)

Return type

tuple

get_death_date()

Returns the birth date of a person as a str

Return type

str

get_death_place()

Returns the birth date of a person as a str

Return type

str

get_death_year()

Returns the death year of a person in integer format

Return type

int

get_event_by_tag(tag='BIRT')

Returns the data of a person formatted as a tuple: (str date, str place, list sources)

Return type

tuple

get_event_year_by_tag(tag='BIRT')

Returns the year for the tag of a person in integer format

Return type

int

get_first_name()

Returns an individual’s first name

Return type

str

get_gender()

Returns the gender of a person in string format

Return type

str

get_last_change_date()

Returns the date of when the person data was last changed formatted as a string

Return type

str

get_name()

Returns an individual’s names as a tuple: (str given_name, str surname)

Return type

tuple

get_name_data()

Returns an individual’s name data including sources as a tuple: (str given_name, str surname, str suffix, list sources)

Return type

tuple

get_occupation()

Returns the occupation of a person

Return type

str

get_sources_by_tag_and_date(tag, date)

Returns the sources for a tag and date

Return type

list

get_sources_by_tag_and_place(tag, place)

Returns the sources for a tag and place

Return type

list

get_sources_by_tag_and_values(tag, date=None, place=None)

Returns the sources for a tag, date and place. Set date or place to None if this value should be ignored

Return type

list

get_tag()

Returns the tag of this element from within the GEDCOM file

Return type

str

given_match(name)

Matches a string with the given name of an individual

::deprecated:: As of version 1.0.0 use given_name_match() method instead

Return type

bool

given_name_match(given_name_to_match)

Matches a string with the given name of an individual

Return type

bool

is_child()

Checks if this element is a child of a family

Return type

bool

is_deceased()

Checks if this individual is deceased

Return type

bool

is_private()

Checks if this individual is marked private

Return type

bool

surname_match(surname_to_match)

Matches a string with the surname of an individual

Return type

bool

exception gedcom.element.individual.NotAnActualIndividualError

Bases: Exception