diff --git a/docs/gedcom/element/element.html b/docs/gedcom/element/element.html index 7d9c271..df41322 100644 --- a/docs/gedcom/element/element.html +++ b/docs/gedcom/element/element.html @@ -3,15 +3,17 @@ - + gedcom.element.element API documentation - - - - - + + + + + + +
@@ -336,7 +338,7 @@

Classes

(level, pointer, tag, value, crlf='\n', multi_line=True)
-

GEDCOM element

+

GEDCOM element

Each line in a GEDCOM file is an element with the format

level [pointer] tag [value]

where level and tag are required, and pointer and value are @@ -356,7 +358,7 @@

Classes

that points to a family record in which the associated person is a child.

See a GEDCOM file for examples of tags and their values.

-

Tags available to an element are seen here: gedcom.tags

+

Tags available to an element are seen here: gedcom.tags

Expand source code @@ -635,8 +637,8 @@

Methods

def add_child_element(self, element)
-

Adds a child element to this element

-

:type element: Element

+

Adds a child element to this element

+

:type element: Element

Expand source code @@ -656,8 +658,8 @@

Methods

def get_child_elements(self)
-

Returns the direct child elements of this element -:rtype: list of Element

+

Returns the direct child elements of this element +:rtype: list of Element

Expand source code @@ -673,9 +675,9 @@

Methods

def get_individual(self)
-

Returns this element and all of its sub-elements represented as a GEDCOM string +

Returns this element and all of its sub-elements represented as a GEDCOM string ::deprecated:: As of version 1.0.0 use to_gedcom_string() method instead -:rtype: str

+:rtype: str

Expand source code @@ -693,8 +695,8 @@

Methods

def get_level(self)
-

Returns the level of this element from within the GEDCOM file -:rtype: int

+

Returns the level of this element from within the GEDCOM file +:rtype: int

Expand source code @@ -710,8 +712,8 @@

Methods

def get_multi_line_value(self)
-

Returns the value of this element including concatenations or continuations -:rtype: str

+

Returns the value of this element including concatenations or continuations +:rtype: str

Expand source code @@ -737,8 +739,8 @@

Methods

def get_parent_element(self)
-

Returns the parent element of this element -:rtype: Element

+

Returns the parent element of this element +:rtype: Element

Expand source code @@ -754,8 +756,8 @@

Methods

def get_pointer(self)
-

Returns the pointer of this element from within the GEDCOM file -:rtype: str

+

Returns the pointer of this element from within the GEDCOM file +:rtype: str

Expand source code @@ -771,8 +773,8 @@

Methods

def get_tag(self)
-

Returns the tag of this element from within the GEDCOM file -:rtype: str

+

Returns the tag of this element from within the GEDCOM file +:rtype: str

Expand source code @@ -788,8 +790,8 @@

Methods

def get_value(self)
-

Return the value of this element from within the GEDCOM file -:rtype: str

+

Return the value of this element from within the GEDCOM file +:rtype: str

Expand source code @@ -805,11 +807,11 @@

Methods

def new_child_element(self, tag, pointer='', value='')
-

Creates and returns a new child element of this element

+

Creates and returns a new child element of this element

:type tag: str :type pointer: str :type value: str -:rtype: Element

+:rtype: Element

Expand source code @@ -848,8 +850,8 @@

Methods

def set_multi_line_value(self, value)
-

Sets the value of this element, adding concatenation and continuation lines when necessary -:type value: str

+

Sets the value of this element, adding concatenation and continuation lines when necessary +:type value: str

Expand source code @@ -877,10 +879,10 @@

Methods

def set_parent_element(self, element)
-

Adds a parent element to this element

+

Adds a parent element to this element

There's usually no need to call this method manually, add_child_element() calls it automatically.

-

:type element: Element

+

:type element: Element

Expand source code @@ -900,8 +902,8 @@

Methods

def set_value(self, value)
-

Sets the value of this element -:type value: str

+

Sets the value of this element +:type value: str

Expand source code @@ -917,9 +919,9 @@

Methods

def to_gedcom_string(self, recursive=False)
-

Formats this element and optionally all of its sub-elements into a GEDCOM string +

Formats this element and optionally all of its sub-elements into a GEDCOM string :type recursive: bool -:rtype: str

+:rtype: str

Expand source code @@ -995,9 +997,7 @@

-

Generated by pdoc 0.7.5.

+

Generated by pdoc 0.8.4.

- - \ No newline at end of file diff --git a/docs/gedcom/element/family.html b/docs/gedcom/element/family.html index ec7d2c6..0c2b782 100644 --- a/docs/gedcom/element/family.html +++ b/docs/gedcom/element/family.html @@ -3,15 +3,17 @@ - + gedcom.element.family API documentation - - - - - + + + + + + +
@@ -20,7 +22,7 @@

Module gedcom.element.family

-

GEDCOM element consisting of tag GEDCOM_TAG_FAMILY

+

GEDCOM element consisting of tag GEDCOM_TAG_FAMILY

Expand source code @@ -82,7 +84,7 @@

Classes

(level, pointer, tag, value, crlf='\n', multi_line=True)
-

GEDCOM element

+

GEDCOM element

Each line in a GEDCOM file is an element with the format

level [pointer] tag [value]

where level and tag are required, and pointer and value are @@ -102,7 +104,7 @@

Classes

that points to a family record in which the associated person is a child.

See a GEDCOM file for examples of tags and their values.

-

Tags available to an element are seen here: gedcom.tags

+

Tags available to an element are seen here: gedcom.tags

Expand source code @@ -143,7 +145,7 @@

Inherited members

(...)
-

Common base class for all non-exit exceptions.

+

Common base class for all non-exit exceptions.

Expand source code @@ -185,9 +187,7 @@

-

Generated by pdoc 0.7.5.

+

Generated by pdoc 0.8.4.

- - \ No newline at end of file diff --git a/docs/gedcom/element/file.html b/docs/gedcom/element/file.html index c0b0cd4..53c99ff 100644 --- a/docs/gedcom/element/file.html +++ b/docs/gedcom/element/file.html @@ -3,15 +3,17 @@ - + gedcom.element.file API documentation - - - - - + + + + + + +
@@ -20,7 +22,7 @@

Module gedcom.element.file

-

GEDCOM element consisting of tag GEDCOM_TAG_FILE

+

GEDCOM element consisting of tag GEDCOM_TAG_FILE

Expand source code @@ -82,7 +84,7 @@

Classes

(level, pointer, tag, value, crlf='\n', multi_line=True)
-

GEDCOM element

+

GEDCOM element

Each line in a GEDCOM file is an element with the format

level [pointer] tag [value]

where level and tag are required, and pointer and value are @@ -102,7 +104,7 @@

Classes

that points to a family record in which the associated person is a child.

See a GEDCOM file for examples of tags and their values.

-

Tags available to an element are seen here: gedcom.tags

+

Tags available to an element are seen here: gedcom.tags

Expand source code @@ -143,7 +145,7 @@

Inherited members

(...)
-

Common base class for all non-exit exceptions.

+

Common base class for all non-exit exceptions.

Expand source code @@ -185,9 +187,7 @@

-

Generated by pdoc 0.7.5.

+

Generated by pdoc 0.8.4.

- - \ No newline at end of file diff --git a/docs/gedcom/element/index.html b/docs/gedcom/element/index.html index dc608ef..2875adf 100644 --- a/docs/gedcom/element/index.html +++ b/docs/gedcom/element/index.html @@ -3,16 +3,18 @@ - + gedcom.element API documentation - - - - - + + + + + + +
@@ -21,7 +23,7 @@

Module gedcom.element

-

Module containing all relevant elements generated by a Parser. +

Module containing all relevant elements generated by a Parser. An element represents a line within GEDCOM data.

@@ -74,27 +76,27 @@

Sub-modules

gedcom.element.element
-

Base GEDCOM element

+

Base GEDCOM element

gedcom.element.family
-

GEDCOM element consisting of tag GEDCOM_TAG_FAMILY

+

GEDCOM element consisting of tag GEDCOM_TAG_FAMILY

gedcom.element.file
-

GEDCOM element consisting of tag GEDCOM_TAG_FILE

+

GEDCOM element consisting of tag GEDCOM_TAG_FILE

gedcom.element.individual
-

GEDCOM element consisting of tag GEDCOM_TAG_INDIVIDUAL

+

GEDCOM element consisting of tag GEDCOM_TAG_INDIVIDUAL

gedcom.element.object
-

GEDCOM element consisting of tag GEDCOM_TAG_OBJECT

+

GEDCOM element consisting of tag GEDCOM_TAG_OBJECT

gedcom.element.root
-

Virtual GEDCOM root element containing all logical records as children

+

Virtual GEDCOM root element containing all logical records as children

@@ -130,9 +132,7 @@

Index

- - \ No newline at end of file diff --git a/docs/gedcom/element/individual.html b/docs/gedcom/element/individual.html index 34421c0..e4db236 100644 --- a/docs/gedcom/element/individual.html +++ b/docs/gedcom/element/individual.html @@ -3,15 +3,17 @@ - + gedcom.element.individual API documentation - - - - - + + + + + + +
@@ -20,7 +22,7 @@

Module gedcom.element.individual

-

GEDCOM element consisting of tag GEDCOM_TAG_INDIVIDUAL

+

GEDCOM element consisting of tag GEDCOM_TAG_INDIVIDUAL

Expand source code @@ -494,7 +496,7 @@

Classes

(level, pointer, tag, value, crlf='\n', multi_line=True)
-

GEDCOM element

+

GEDCOM element

Each line in a GEDCOM file is an element with the format

level [pointer] tag [value]

where level and tag are required, and pointer and value are @@ -514,7 +516,7 @@

Classes

that points to a family record in which the associated person is a child.

See a GEDCOM file for examples of tags and their values.

-

Tags available to an element are seen here: gedcom.tags

+

Tags available to an element are seen here: gedcom.tags

Expand source code @@ -944,10 +946,10 @@

Methods

def birth_range_match(self, from_year, to_year)
-

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

Checks if the birth year of a person lies within the given range :type from_year: int :type to_year: int -:rtype: bool

+:rtype: bool

Expand source code @@ -970,9 +972,9 @@

Methods

def birth_year_match(self, year)
-

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

Returns True if the given year matches the birth year of this person :type year: int -:rtype: bool

+:rtype: bool

Expand source code @@ -989,7 +991,7 @@

Methods

def criteria_match(self, criteria)
-

Checks if this individual matches all of the given 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] @@ -1002,7 +1004,7 @@

Methods

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].

:type criteria: str -:rtype: bool

+:rtype: bool

Expand source code @@ -1090,10 +1092,10 @@

Methods

def death_range_match(self, from_year, to_year)
-

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

Checks if the death year of a person lies within the given range :type from_year: int :type to_year: int -:rtype: bool

+:rtype: bool

Expand source code @@ -1116,9 +1118,9 @@

Methods

def death_year_match(self, year)
-

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

Returns True if the given year matches the death year of this person :type year: int -:rtype: bool

+:rtype: bool

Expand source code @@ -1135,7 +1137,7 @@

Methods

def get_all_names(self)
-
+
Expand source code @@ -1148,8 +1150,8 @@

Methods

def get_birth_data(self)
-

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

+

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

Expand source code @@ -1182,8 +1184,8 @@

Methods

def get_birth_year(self)
-

Returns the birth year of a person in integer format -:rtype: int

+

Returns the birth year of a person in integer format +:rtype: int

Expand source code @@ -1213,9 +1215,9 @@

Methods

def get_burial(self)
-

Returns the burial data of a person formatted as a tuple: (str date, str´ place,listsources) -::deprecated:: As of version 1.0.0 useget_burial_data()` method instead -:rtype: tuple

+

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

Expand source code @@ -1233,8 +1235,8 @@

Methods

def get_burial_data(self)
-

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

+

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

Expand source code @@ -1267,9 +1269,9 @@

Methods

def get_census(self)
-

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

+

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

Expand source code @@ -1287,8 +1289,8 @@

Methods

def get_census_data(self)
-

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

+

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

Expand source code @@ -1326,8 +1328,8 @@

Methods

def get_death_data(self)
-

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

+

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

Expand source code @@ -1357,8 +1359,8 @@

Methods

def get_death_year(self)
-

Returns the death year of a person in integer format -:rtype: int

+

Returns the death year of a person in integer format +:rtype: int

Expand source code @@ -1388,8 +1390,8 @@

Methods

def get_gender(self)
-

Returns the gender of a person in string format -:rtype: str

+

Returns the gender of a person in string format +:rtype: str

Expand source code @@ -1411,8 +1413,8 @@

Methods

def get_last_change_date(self)
-

Returns the date of when the person data was last changed formatted as a string -:rtype: str

+

Returns the date of when the person data was last changed formatted as a string +:rtype: str

Expand source code @@ -1436,8 +1438,8 @@

Methods

def get_name(self)
-

Returns an individual's names as a tuple: (str given_name, str surname) -:rtype: tuple

+

Returns an individual's names as a tuple: (str given_name, str surname) +:rtype: tuple

Expand source code @@ -1489,8 +1491,8 @@

Methods

def get_occupation(self)
-

Returns the occupation of a person -:rtype: str

+

Returns the occupation of a person +:rtype: str

Expand source code @@ -1512,10 +1514,10 @@

Methods

def given_match(self, name)
-

Matches a string with the given name of an individual +

Matches a string with the given name of an individual ::deprecated:: As of version 1.0.0 use given_name_match() method instead :type name: str -:rtype: bool

+:rtype: bool

Expand source code @@ -1534,9 +1536,9 @@

Methods

def given_name_match(self, given_name_to_match)
-

Matches a string with the given name of an individual +

Matches a string with the given name of an individual :type given_name_to_match: str -:rtype: bool

+:rtype: bool

Expand source code @@ -1554,8 +1556,8 @@

Methods

def is_child(self)
-

Checks if this element is a child of a family -:rtype: bool

+

Checks if this element is a child of a family +:rtype: bool

Expand source code @@ -1577,8 +1579,8 @@

Methods

def is_deceased(self)
-

Checks if this individual is deceased -:rtype: bool

+

Checks if this individual is deceased +:rtype: bool

Expand source code @@ -1598,8 +1600,8 @@

Methods

def is_private(self)
-

Checks if this individual is marked private -:rtype: bool

+

Checks if this individual is marked private +:rtype: bool

Expand source code @@ -1621,9 +1623,9 @@

Methods

def surname_match(self, surname_to_match)
-

Matches a string with the surname of an individual +

Matches a string with the surname of an individual :type surname_to_match: str -:rtype: bool

+:rtype: bool

Expand source code @@ -1665,7 +1667,7 @@

Inherited members

(...)
-

Common base class for all non-exit exceptions.

+

Common base class for all non-exit exceptions.

Expand source code @@ -1733,9 +1735,7 @@

-

Generated by pdoc 0.7.5.

+

Generated by pdoc 0.8.4.

- - \ No newline at end of file diff --git a/docs/gedcom/element/object.html b/docs/gedcom/element/object.html index 6897dfc..adc6c3f 100644 --- a/docs/gedcom/element/object.html +++ b/docs/gedcom/element/object.html @@ -3,15 +3,17 @@ - + gedcom.element.object API documentation - - - - - + + + + + + +
@@ -20,7 +22,7 @@

Module gedcom.element.object

-

GEDCOM element consisting of tag GEDCOM_TAG_OBJECT

+

GEDCOM element consisting of tag GEDCOM_TAG_OBJECT

Expand source code @@ -85,7 +87,7 @@

Classes

(...)
-

Common base class for all non-exit exceptions.

+

Common base class for all non-exit exceptions.

Expand source code @@ -104,7 +106,7 @@

Ancestors

(level, pointer, tag, value, crlf='\n', multi_line=True)
-

GEDCOM element

+

GEDCOM element

Each line in a GEDCOM file is an element with the format

level [pointer] tag [value]

where level and tag are required, and pointer and value are @@ -124,7 +126,7 @@

Ancestors

that points to a family record in which the associated person is a child.

See a GEDCOM file for examples of tags and their values.

-

Tags available to an element are seen here: gedcom.tags

+

Tags available to an element are seen here: gedcom.tags

Expand source code @@ -147,8 +149,8 @@

Methods

def is_object(self)
-

Checks if this element is an actual object -:rtype: bool

+

Checks if this element is an actual object +:rtype: bool

Expand source code @@ -214,9 +216,7 @@

-

Generated by pdoc 0.7.5.

+

Generated by pdoc 0.8.4.

- - \ No newline at end of file diff --git a/docs/gedcom/element/root.html b/docs/gedcom/element/root.html index 11b2efd..8eabb78 100644 --- a/docs/gedcom/element/root.html +++ b/docs/gedcom/element/root.html @@ -3,15 +3,17 @@ - + gedcom.element.root API documentation - - - - - + + + + + + +
@@ -78,7 +80,7 @@

Classes

(level=-1, pointer='', tag='ROOT', value='', crlf='\n', multi_line=True)
-

Virtual GEDCOM root element containing all logical records as children

+

Virtual GEDCOM root element containing all logical records as children

Expand source code @@ -140,9 +142,7 @@

-

Generated by pdoc 0.7.5.

+

Generated by pdoc 0.8.4.

- - \ No newline at end of file diff --git a/docs/gedcom/helpers.html b/docs/gedcom/helpers.html index 783b4cd..d633974 100644 --- a/docs/gedcom/helpers.html +++ b/docs/gedcom/helpers.html @@ -3,15 +3,17 @@ - + gedcom.helpers API documentation - - - - - + + + + + + +
@@ -90,9 +92,9 @@

Functions

def deprecated(func)
-

This is a decorator which can be used to mark functions +

This is a decorator which can be used to mark functions as deprecated. It will result in a warning being emitted -when the function is used.

+when the function is used.

Expand source code @@ -141,9 +143,7 @@

Index

- - \ No newline at end of file diff --git a/docs/gedcom/index.html b/docs/gedcom/index.html index 389005e..f947549 100644 --- a/docs/gedcom/index.html +++ b/docs/gedcom/index.html @@ -3,21 +3,23 @@ - + gedcom API documentation - - - - - + + + + + + +
-

Module gedcom

+

Package gedcom

A Python module for parsing, analyzing, and manipulating GEDCOM files.

@@ -34,12 +36,12 @@

Pre-releases

simply append the --pre option to pip3: pip3 install python-gedcom --pre

Important classes and modules

Example usage

-

When successfully installed you may import the gedcom package and use it like so:

+

When successfully installed you may import the gedcom package and use it like so:

from gedcom.element.individual import IndividualElement
 from gedcom.parser import Parser
 
@@ -162,21 +164,21 @@ 
Sub-modules

 

 
gedcom.element

 

-
Module containing all relevant elements generated by a Parser.
-An element represents a line within GEDCOM data.

+
Module containing all relevant elements generated by a Parser.
+An element represents a line within GEDCOM data.

 

 
gedcom.helpers

 

-
Helper methods.

+
Helper methods.

 

 
gedcom.parser

 

-
Module containing the actual Parser used to generate elements - out of each line -
-which can in return be manipulated.

+
Module containing the actual Parser used to generate elements - out of each line -
+which can in return be manipulated.

 

 
gedcom.tags

 

-
GEDCOM tags.

+
GEDCOM tags.
@@ -214,9 +216,7 @@

Index

- - \ No newline at end of file diff --git a/docs/gedcom/parser.html b/docs/gedcom/parser.html index 1e6d4aa..8694989 100644 --- a/docs/gedcom/parser.html +++ b/docs/gedcom/parser.html @@ -3,16 +3,18 @@ - + gedcom.parser API documentation - - - - - + + + + + + +
@@ -21,7 +23,7 @@

Module gedcom.parser

-

Module containing the actual Parser used to generate elements - out of each line - +

Module containing the actual Parser used to generate elements - out of each line - which can in return be manipulated.

@@ -588,7 +590,7 @@

Classes

(...)
-

Common base class for all non-exit exceptions.

+

Common base class for all non-exit exceptions.

Expand source code @@ -606,14 +608,14 @@

Ancestors

class Parser
-

Parses and manipulates GEDCOM 5.5 format data

+

Parses and manipulates GEDCOM 5.5 format data

For documentation of the GEDCOM 5.5 format, see: http://homepages.rootsweb.ancestry.com/~pmcbride/gedcom/55gctoc.htm

This parser reads and parses a GEDCOM file.

Elements may be accessed via:

+
  • a list through Parser.get_element_list()
    • +
  • a dict through Parser.get_element_dictionary()
    • +
    Expand source code @@ -1117,8 +1119,8 @@

    Methods

    def find_path_to_ancestor(self, descendant, ancestor, path=None)
    -

    Return path from descendant to ancestor -:rtype: object

    +

    Return path from descendant to ancestor +:rtype: object

    Expand source code @@ -1151,12 +1153,12 @@

    Methods

    def get_ancestors(self, individual, ancestor_type='ALL')
    -

    Return elements corresponding to ancestors of an individual

    +

    Return elements corresponding to ancestors of an individual

    Optional ancestor_type. Default "ALL" returns all ancestors, "NAT" can be used to specify only natural (genetic) ancestors.

    :type individual: IndividualElement :type ancestor_type: str -:rtype: list of Element

    +:rtype: list of Element

    Expand source code @@ -1190,13 +1192,13 @@

    Methods

    def get_element_dictionary(self)
    -

    Returns a dictionary containing all elements, identified by a pointer, from within the GEDCOM file

    +

    Returns a dictionary containing all elements, identified by a pointer, from within the GEDCOM file

    Only elements identified by a pointer are listed in the dictionary. The keys for the dictionary are the pointers.

    This dictionary gets generated on-the-fly, but gets cached. If the database was modified, you should call invalidate_cache() once to let this method return updated data.

    -

    :rtype: dict of Element

    +

    :rtype: dict of Element

    Expand source code @@ -1225,14 +1227,14 @@

    Methods

    def get_element_list(self)
    -

    Returns a list containing all elements from within the GEDCOM file

    +

    Returns a list containing all elements from within the GEDCOM file

    By default elements are in the same order as they appeared in the file.

    This list gets generated on-the-fly, but gets cached. If the database -was modified, you should call Parser.invalidate_cache() once to let this +was modified, you should call Parser.invalidate_cache() once to let this method return updated data.

    -

    Consider using Parser.get_root_element() or Parser.get_root_child_elements() to access +

    Consider using Parser.get_root_element() or Parser.get_root_child_elements() to access the hierarchical GEDCOM tree, unless you rarely modify the database.

    -

    :rtype: list of Element

    +

    :rtype: list of Element

    Expand source code @@ -1261,13 +1263,13 @@

    Methods

    def get_families(self, individual, family_type='FAMS')
    -

    Return family elements listed for an individual

    -

    family_type can be GEDCOM_TAG_FAMILY_SPOUSE (families where the individual is a spouse) or -GEDCOM_TAG_FAMILY_CHILD (families where the individual is a child). If a value is not -provided, GEDCOM_TAG_FAMILY_SPOUSE is default value.

    +

    Return family elements listed for an individual

    +

    family_type can be GEDCOM_TAG_FAMILY_SPOUSE (families where the individual is a spouse) or +GEDCOM_TAG_FAMILY_CHILD (families where the individual is a child). If a value is not +provided, GEDCOM_TAG_FAMILY_SPOUSE is default value.

    :type individual: IndividualElement :type family_type: str -:rtype: list of FamilyElement

    +:rtype: list of FamilyElement

    Expand source code @@ -1305,7 +1307,7 @@

    Methods

    def get_family_members(self, family, members_type='ALL')
    -

    Return array of family members: individual, spouse, and children

    +

    Return array of family members: individual, spouse, and children

    Optional argument members_type can be used to return specific subsets:

    "FAMILY_MEMBERS_TYPE_ALL": Default, return all members of the family "FAMILY_MEMBERS_TYPE_PARENTS": Return individuals with "HUSB" and "WIFE" tags (parents) @@ -1314,7 +1316,7 @@

    Methods

    "FAMILY_MEMBERS_TYPE_CHILDREN": Return individuals with "CHIL" tags (children)

    :type family: FamilyElement :type members_type: str -:rtype: list of IndividualElement

    +:rtype: list of IndividualElement

    Expand source code @@ -1368,9 +1370,9 @@

    Methods

    def get_marriage_years(self, individual)
    -

    Returns a list of marriage years (as integers) for an individual +

    Returns a list of marriage years (as integers) for an individual :type individual: IndividualElement -:rtype: list of int

    +:rtype: list of int

    Expand source code @@ -1406,9 +1408,9 @@

    Methods

    def get_marriages(self, individual)
    -

    Returns a list of marriages of an individual formatted as a tuple (str date, str place) +

    Returns a list of marriages of an individual formatted as a tuple (str date, str place) :type individual: IndividualElement -:rtype: tuple

    +:rtype: tuple

    Expand source code @@ -1443,12 +1445,12 @@

    Methods

    def get_parents(self, individual, parent_type='ALL')
    -

    Return elements corresponding to parents of an individual

    +

    Return elements corresponding to parents of an individual

    Optional parent_type. Default "ALL" returns all parents. "NAT" can be used to specify only natural (genetic) parents.

    :type individual: IndividualElement :type parent_type: str -:rtype: list of IndividualElement

    +:rtype: list of IndividualElement

    Expand source code @@ -1494,9 +1496,9 @@

    Methods

    def get_root_child_elements(self)
    -

    Returns a list of logical records in the GEDCOM file

    +

    Returns a list of logical records in the GEDCOM file

    By default, elements are in the same order as they appeared in the file.

    -

    :rtype: list of Element

    +

    :rtype: list of Element

    Expand source code @@ -1515,9 +1517,9 @@

    Methods

    def get_root_element(self)
    -

    Returns a virtual root element containing all logical records as children

    +

    Returns a virtual root element containing all logical records as children

    When printed, this element converts to an empty string.

    -

    :rtype: RootElement

    +

    :rtype: RootElement

    Expand source code @@ -1536,9 +1538,9 @@

    Methods

    def invalidate_cache(self)
    -

    Empties the element list and dictionary to cause Parser.get_element_list() -and Parser.get_element_dictionary() to return updated data.

    -

    The update gets deferred until each of the methods actually gets called.

    +

    Empties the element list and dictionary to cause Parser.get_element_list() +and Parser.get_element_dictionary() to return updated data.

    +

    The update gets deferred until each of the methods actually gets called.

    Expand source code @@ -1557,11 +1559,11 @@

    Methods

    def marriage_range_match(self, individual, from_year, to_year)
    -

    Check if one of the marriage years of an individual is in a given range. Years are integers. +

    Check if one of the marriage years of an individual is in a given range. Years are integers. :type individual: IndividualElement :type from_year: int :type to_year: int -:rtype: bool

    +:rtype: bool

    Expand source code @@ -1589,10 +1591,10 @@

    Methods

    def marriage_year_match(self, individual, year)
    -

    Checks if one of the marriage years of an individual matches the supplied year. Year is an integer. +

    Checks if one of the marriage years of an individual matches the supplied year. Year is an integer. :type individual: IndividualElement :type year: int -:rtype: bool

    +:rtype: bool

    Expand source code @@ -1616,9 +1618,9 @@

    Methods

    def parse(self, gedcom_stream, strict=True)
    -

    Parses a stream, or an array of lines, as GEDCOM 5.5 formatted data +

    Parses a stream, or an array of lines, as GEDCOM 5.5 formatted data :type gedcom_stream: a file stream, or str array of lines with new line at the end -:type strict: bool

    +:type strict: bool

    Expand source code @@ -1643,9 +1645,9 @@

    Methods

    def parse_file(self, file_path, strict=True)
    -

    Opens and parses a file, from the given file path, as GEDCOM 5.5 formatted data +

    Opens and parses a file, from the given file path, as GEDCOM 5.5 formatted data :type file_path: str -:type strict: bool

    +:type strict: bool

    Expand source code @@ -1663,7 +1665,7 @@

    Methods

    def print_gedcom(self)
    -

    Write GEDCOM data to stdout

    +

    Write GEDCOM data to stdout

    Expand source code @@ -1678,9 +1680,9 @@

    Methods

    def save_gedcom(self, open_file, recursive=True)
    -

    Save GEDCOM data to a file +

    Save GEDCOM data to a file :type open_file: file -:type recursive: bool

    +:type recursive: bool

    Expand source code @@ -1697,8 +1699,8 @@

    Methods

    def to_gedcom_string(self, recursive=False)
    -

    Formats all elements and optionally all of the sub-elements into a GEDCOM string -:type recursive: bool

    +

    Formats all elements and optionally all of the sub-elements into a GEDCOM string +:type recursive: bool

    Expand source code @@ -1770,9 +1772,7 @@

    Parser

    - - \ No newline at end of file diff --git a/docs/gedcom/tags.html b/docs/gedcom/tags.html index f1c5491..9adbfd8 100644 --- a/docs/gedcom/tags.html +++ b/docs/gedcom/tags.html @@ -3,15 +3,17 @@ - + gedcom.tags API documentation - - - - - + + + + + + +
    @@ -217,156 +219,156 @@

    Global variables

    var GEDCOM_PROGRAM_DEFINED_TAG_FREL
    -

    Value: _FREL

    -

    Relationship to a father.

    +

    Value: _FREL

    +

    Relationship to a father.

    var GEDCOM_PROGRAM_DEFINED_TAG_MREL
    -

    Value: _MREL

    -

    Relationship to a mother.

    +

    Value: _MREL

    +

    Relationship to a mother.

    var GEDCOM_TAG_BIRTH
    -

    Value: BIRT

    -

    The event of entering into life.

    +

    Value: BIRT

    +

    The event of entering into life.

    var GEDCOM_TAG_BURIAL
    -

    Value: BURI

    -

    The event of the proper disposing of the mortal remains of a deceased person.

    +

    Value: BURI

    +

    The event of the proper disposing of the mortal remains of a deceased person.

    var GEDCOM_TAG_CENSUS
    -

    Value: CENS.

    -

    The event of the periodic count of the population for a designated locality, such as a national or state Census.

    +

    Value: CENS.

    +

    The event of the periodic count of the population for a designated locality, such as a national or state Census.

    var GEDCOM_TAG_CHANGE
    -

    Value: CHAN

    +

    Value: CHAN

    Indicates a change, correction, or modification. Typically used in connection -with a GEDCOM_TAG_DATE to specify when a change in information occurred.

    +with a GEDCOM_TAG_DATE to specify when a change in information occurred.

    var GEDCOM_TAG_CHILD
    -

    Value: CHIL

    -

    The natural, adopted, or sealed (LDS) child of a father and a mother.

    +

    Value: CHIL

    +

    The natural, adopted, or sealed (LDS) child of a father and a mother.

    var GEDCOM_TAG_CONCATENATION
    -

    Value: CONC

    +

    Value: CONC

    An indicator that additional data belongs to the superior value. The information from the CONC value is to be connected to the value of the superior preceding line without a space and without a carriage return and/or new line character. Values that are split for a CONC tag must always be split at a non-space. If the value is split on a space the space will be lost when concatenation takes place. This is because of the treatment that spaces get as a GEDCOM delimiter, many GEDCOM values are trimmed of trailing spaces and some systems look for -the first non-space starting after the tag to determine the beginning of the value.

    +the first non-space starting after the tag to determine the beginning of the value.

    var GEDCOM_TAG_CONTINUED
    -

    Value: CONT

    +

    Value: CONT

    An indicator that additional data belongs to the superior value. The information from the CONT value is to be connected to the value of the superior preceding line with a carriage return and/or new line character. Leading spaces could be important to the formatting of the resultant text. When importing values from CONT lines the reader should assume only one delimiter character following the CONT tag. Assume that the rest of the leading -spaces are to be a part of the value.

    +spaces are to be a part of the value.

    var GEDCOM_TAG_DATE
    -

    Value: DATE

    -

    The time of an event in a calendar format.

    +

    Value: DATE

    +

    The time of an event in a calendar format.

    var GEDCOM_TAG_DEATH
    -

    Value: DEAT

    -

    The event when mortal life terminates.

    +

    Value: DEAT

    +

    The event when mortal life terminates.

    var GEDCOM_TAG_FAMILY
    -

    Value: FAM.

    +

    Value: FAM.

    Identifies a legal, common law, or other customary relationship of man and woman and their children, -if any, or a family created by virtue of the birth of a child to its biological father and mother.

    +if any, or a family created by virtue of the birth of a child to its biological father and mother.

    var GEDCOM_TAG_FAMILY_CHILD
    -

    Value: FAMC

    -

    Identifies the family in which an individual appears as a child.

    +

    Value: FAMC

    +

    Identifies the family in which an individual appears as a child.

    var GEDCOM_TAG_FAMILY_SPOUSE
    -

    Value: FAMS

    -

    Identifies the family in which an individual appears as a spouse.

    +

    Value: FAMS

    +

    Identifies the family in which an individual appears as a spouse.

    var GEDCOM_TAG_FILE
    -

    Value: FILE

    -

    An information storage place that is ordered and arranged for preservation and reference.

    +

    Value: FILE

    +

    An information storage place that is ordered and arranged for preservation and reference.

    var GEDCOM_TAG_GIVEN_NAME
    -

    Value: GIVN

    -

    A given or earned name used for official identification of a person.

    +

    Value: GIVN

    +

    A given or earned name used for official identification of a person.

    var GEDCOM_TAG_HUSBAND
    -

    Value: HUSB

    -

    An individual in the family role of a married man or father.

    +

    Value: HUSB

    +

    An individual in the family role of a married man or father.

    var GEDCOM_TAG_INDIVIDUAL
    -

    Value: INDI

    -

    A person.

    +

    Value: INDI

    +

    A person.

    var GEDCOM_TAG_MARRIAGE
    -

    Value: MARR.

    -

    A legal, common-law, or customary event of creating a family unit of a man and a woman as husband and wife.

    +

    Value: MARR.

    +

    A legal, common-law, or customary event of creating a family unit of a man and a woman as husband and wife.

    var GEDCOM_TAG_NAME
    -

    Value: NAME.

    +

    Value: NAME.

    A word or combination of words used to help identify an individual, title, or other item. -More than one NAME line should be used for people who were known by multiple names.

    +More than one NAME line should be used for people who were known by multiple names.

    var GEDCOM_TAG_OBJECT
    -

    Value: OBJE

    +

    Value: OBJE

    Pertaining to a grouping of attributes used in describing something. Usually referring to the data required -to represent a multimedia object, such an audio recording, a photograph of a person, or an image of a document.

    +to represent a multimedia object, such an audio recording, a photograph of a person, or an image of a document.

    var GEDCOM_TAG_OCCUPATION
    -

    Value: OCCU

    -

    The type of work or profession of an individual.

    +

    Value: OCCU

    +

    The type of work or profession of an individual.

    var GEDCOM_TAG_PLACE
    -

    Value: PLAC

    -

    A jurisdictional name to identify the place or location of an event.

    +

    Value: PLAC

    +

    A jurisdictional name to identify the place or location of an event.

    var GEDCOM_TAG_PRIVATE
    -

    Value: PRIV

    -

    Flag for private address or event.

    +

    Value: PRIV

    +

    Flag for private address or event.

    var GEDCOM_TAG_SEX
    -

    Value: SEX

    -

    Indicates the sex of an individual–male or female.

    +

    Value: SEX

    +

    Indicates the sex of an individual–male or female.

    var GEDCOM_TAG_SOURCE
    -

    Value: SOUR

    -

    The initial or original material from which information was obtained.

    +

    Value: SOUR

    +

    The initial or original material from which information was obtained.

    var GEDCOM_TAG_SURNAME
    -

    Value: SURN

    -

    A family name passed on or used by members of a family.

    +

    Value: SURN

    +

    A family name passed on or used by members of a family.

    var GEDCOM_TAG_WIFE
    -

    Value: WIFE

    -

    An individual in the role as a mother and/or married woman.

    +

    Value: WIFE

    +

    An individual in the role as a mother and/or married woman.

    @@ -422,9 +424,7 @@

    Index

    - - \ No newline at end of file