Module gedcom.element.object

GEDCOM element consisting of tag GEDCOM_TAG_OBJECT

Expand source code 
# -*- coding: utf-8 -*-

# Python GEDCOM Parser
#
# Copyright (C) 2018 Damon Brodie (damon.brodie at gmail.com)
# Copyright (C) 2018-2019 Nicklas Reincke (contact at reynke.com)
# Copyright (C) 2016 Andreas Oberritter
# Copyright (C) 2012 Madeleine Price Ball
# Copyright (C) 2005 Daniel Zappala (zappala at cs.byu.edu)
# Copyright (C) 2005 Brigham Young University
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Further information about the license: http://www.gnu.org/licenses/gpl-2.0.html

"""GEDCOM element consisting of tag `gedcom.tags.GEDCOM_TAG_OBJECT`"""

from gedcom.element.element import Element
import gedcom.tags


class NotAnActualObjectError(Exception):
    pass


class ObjectElement(Element):

    def is_object(self):
        """Checks if this element is an actual object
        :rtype: bool
        """
        return self.get_tag() == gedcom.tags.GEDCOM_TAG_OBJECT

Classes

class NotAnActualObjectError (...)

Common base class for all non-exit exceptions.

Expand source code 
class NotAnActualObjectError(Exception):
    pass

Ancestors

  • builtins.Exception
  • builtins.BaseException
class ObjectElement (level, pointer, tag, value, crlf='\n', multi_line=True)

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 optional. Elements are arranged hierarchically according to their level, and elements with a level of zero are at the top level. Elements with a level greater than zero are children of their parent.

A pointer has the format @pname@, where pname is any sequence of characters and numbers. The pointer identifies the object being pointed to, so that any pointer included as the value of any element points back to the original object. For example, an element may have a FAMS tag whose value is @F1@, meaning that this element points to the family record in which the associated person is a spouse. Likewise, an element with a tag of FAMC has a value 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

Expand source code 
class ObjectElement(Element):

    def is_object(self):
        """Checks if this element is an actual object
        :rtype: bool
        """
        return self.get_tag() == gedcom.tags.GEDCOM_TAG_OBJECT

Ancestors

Methods

def is_object(self)

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

Expand source code 
def is_object(self):
    """Checks if this element is an actual object
    :rtype: bool
    """
    return self.get_tag() == gedcom.tags.GEDCOM_TAG_OBJECT

Inherited members