Library Reference
=================

.. toctree::
   :hidden:
   :maxdepth: 2

   doc
   abc
   header
   term
   typedef
   instance
   id
   pv
   syn
   xref
   exceptions


.. currentmodule:: fastobo
.. automodule:: fastobo


Functions
---------

``fastobo.dump_graph``
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: fastobo.dump_graph


``fastobo.dump_owl``
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: fastobo.dump_owl


``fastobo.iter``
^^^^^^^^^^^^^^^^

.. autofunction:: fastobo.iter


``fastobo.load``
^^^^^^^^^^^^^^^^

.. autofunction:: fastobo.load


``fastobo.loads``
^^^^^^^^^^^^^^^^^

.. autofunction:: fastobo.loads


``fastobo.load_graph``
^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: fastobo.load_graph


``fastobo.id.is_valid``
^^^^^^^^^^^^^^^^^^^^^^^

.. autofunction:: fastobo.id.is_valid


``fastobo.id.parse``
^^^^^^^^^^^^^^^^^^^^

.. autofunction:: fastobo.id.parse


Data structures
---------------

Document (`fastobo.doc`)
^^^^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.doc
.. autosummary::
    :nosignatures:

    fastobo.doc.OboDoc


Abstract Base Classes (`fastobo.abc`)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.abc
.. autosummary::
    :nosignatures:

    fastobo.abc.AbstractClause
    fastobo.abc.AbstractEntityClause
    fastobo.abc.AbstractFrame
    fastobo.abc.AbstractEntityFrame



Identifier (`fastobo.id`)
^^^^^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.id
.. autosummary::
    :nosignatures:

    fastobo.id.BaseIdent
    fastobo.id.PrefixedIdent
    fastobo.id.UnprefixedIdent
    fastobo.id.Url


Header (`fastobo.header`)
^^^^^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.header
.. autosummary::
   :nosignatures:

   fastobo.header.HeaderFrame
   fastobo.header.BaseHeaderClause

   fastobo.header.FormatVersionClause
   fastobo.header.DataVersionClause
   fastobo.header.DateClause
   fastobo.header.SavedByClause
   fastobo.header.AutoGeneratedByClause
   fastobo.header.ImportClause
   fastobo.header.SubsetdefClause
   fastobo.header.SynonymTypedefClause
   fastobo.header.DefaultNamespaceClause
   fastobo.header.IdspaceClause
   fastobo.header.TreatXrefsAsEquivalentClause
   fastobo.header.TreatXrefsAsGenusDifferentiaClause
   fastobo.header.TreatXrefsAsReverseGenusDifferentiaClause
   fastobo.header.TreatXrefsAsRelationshipClause
   fastobo.header.TreatXrefsAsIsAClause
   fastobo.header.TreatXrefsAsHasSubclassClause
   fastobo.header.PropertyValueClause
   fastobo.header.RemarkClause
   fastobo.header.OntologyClause
   fastobo.header.OwlAxiomsClause
   fastobo.header.UnreservedClause


Term (`fastobo.term`)
^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.term
.. autosummary::
   :nosignatures:

   fastobo.term.TermFrame
   fastobo.term.BaseTermClause

   fastobo.term.AltIdClause
   fastobo.term.BuiltinClause
   fastobo.term.CommentClause
   fastobo.term.ConsiderClause
   fastobo.term.CreatedByClause
   fastobo.term.CreationDateClause
   fastobo.term.DefClause
   fastobo.term.DisjointFromClause
   fastobo.term.EquivalentToClause
   fastobo.term.IntersectionOfClause
   fastobo.term.IsAClause
   fastobo.term.IsAnonymousClause
   fastobo.term.IsObsoleteClause
   fastobo.term.NameClause
   fastobo.term.NamespaceClause
   fastobo.term.PropertyValueClause
   fastobo.term.RelationshipClause
   fastobo.term.ReplacedByClause
   fastobo.term.SubsetClause
   fastobo.term.SynonymClause
   fastobo.term.UnionOfClause
   fastobo.term.XrefClause


Typedef (`fastobo.typedef`)
^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.typedef
.. autosummary::
   :nosignatures:

   fastobo.typedef.TypedefFrame
   fastobo.typedef.BaseTypedefClause

   fastobo.typedef.AltIdClause
   fastobo.typedef.BuiltinClause
   fastobo.typedef.CommentClause
   fastobo.typedef.ConsiderClause
   fastobo.typedef.CreatedByClause
   fastobo.typedef.CreationDateClause
   fastobo.typedef.DefClause
   fastobo.typedef.DisjointFromClause
   fastobo.typedef.DisjointOverClause
   fastobo.typedef.DomainClause
   fastobo.typedef.EquivalentToChainClause
   fastobo.typedef.EquivalentToClause
   fastobo.typedef.ExpandAssertionToClause
   fastobo.typedef.ExpandExpressionToClause
   fastobo.typedef.HoldsOverChainClause
   fastobo.typedef.IntersectionOfClause
   fastobo.typedef.InverseOfClause
   fastobo.typedef.IsAClause
   fastobo.typedef.IsAnonymousClause
   fastobo.typedef.IsAntiSymmetricClause
   fastobo.typedef.IsAsymmetricClause
   fastobo.typedef.IsClassLevelClause
   fastobo.typedef.IsCyclicClause
   fastobo.typedef.IsFunctionalClause
   fastobo.typedef.IsInverseFunctionalClause
   fastobo.typedef.IsMetadataTagClause
   fastobo.typedef.IsObsoleteClause
   fastobo.typedef.IsReflexiveClause
   fastobo.typedef.IsSymmetricClause
   fastobo.typedef.IsTransitiveClause
   fastobo.typedef.NameClause
   fastobo.typedef.NamespaceClause
   fastobo.typedef.PropertyValueClause
   fastobo.typedef.RangeClause
   fastobo.typedef.RelationshipClause
   fastobo.typedef.ReplacedByClause
   fastobo.typedef.SubsetClause
   fastobo.typedef.SynonymClause
   fastobo.typedef.TransitiveOverClause
   fastobo.typedef.UnionOfClause
   fastobo.typedef.XrefClause


Property Value (`fastobo.pv`)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.pv
.. autosummary::
   :nosignatures:

   fastobo.pv.AbstractPropertyValue
   fastobo.pv.LiteralPropertyValue
   fastobo.pv.ResourcePropertyValue


Synonym (`fastobo.syn`)
^^^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.syn
.. autosummary::
   :nosignatures:

   fastobo.syn.Synonym
   fastobo.syn.SynonymScope


Xref (`fastobo.xref`)
^^^^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.xref
.. autosummary::
    :nosignatures:

    fastobo.xref.Xref
    fastobo.xref.XrefList



Exceptions
----------

Cardinality Errors
^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.exceptions
.. autosummary::
   :nosignatures:

   fastobo.exceptions.MissingClauseError
   fastobo.exceptions.DuplicateClausesError
   fastobo.exceptions.SingleClauseError


Threading Errors
^^^^^^^^^^^^^^^^^^

.. currentmodule:: fastobo.exceptions
.. autosummary::
   :nosignatures:

   fastobo.exceptions.DisconnectedChannelError