semantic_html.models
====================

.. py:module:: semantic_html.models


Attributes
----------

.. autoapisummary::

   semantic_html.models.DEFAULT_CONTEXT
   semantic_html.models.WADM_CONTEXT


Classes
-------

.. autoapisummary::

   semantic_html.models.BaseGraphItem
   semantic_html.models.NoteItem
   semantic_html.models.StructureItem
   semantic_html.models.LocatorItem
   semantic_html.models.DocItem
   semantic_html.models.AnnotationItem
   semantic_html.models.QuotationItem
   semantic_html.models.RegexWrapper


Functions
---------

.. autoapisummary::

   semantic_html.models.generate_wadm_annotation


Module Contents
---------------

.. py:data:: DEFAULT_CONTEXT

.. py:data:: WADM_CONTEXT
   :value: 'https://www.w3.org/ns/anno.jsonld'


.. py:class:: BaseGraphItem(type_, text=None, metadata=None, selector=None, **kwargs)

   Base class for all graph items with standardized fields.


   .. py:attribute:: data


   .. py:attribute:: selector


   .. py:attribute:: wadm_metadata


   .. py:method:: to_dict()

      Return the graph item as a dictionary.



   .. py:method:: to_wadm()

      Return a WADM-conformant dictionary representation.



.. py:class:: NoteItem(text, **kwargs)

   Bases: :py:obj:`BaseGraphItem`


   Base class for all graph items with standardized fields.


.. py:class:: StructureItem(text, level, **kwargs)

   Bases: :py:obj:`BaseGraphItem`


   Base class for all graph items with standardized fields.


.. py:class:: LocatorItem(text, **kwargs)

   Bases: :py:obj:`BaseGraphItem`


   Base class for all graph items with standardized fields.


.. py:class:: DocItem(text, **kwargs)

   Bases: :py:obj:`BaseGraphItem`


   Base class for all graph items with standardized fields.


.. py:class:: AnnotationItem(text, **kwargs)

   Bases: :py:obj:`BaseGraphItem`


   Base class for all graph items with standardized fields.


.. py:class:: QuotationItem(text, **kwargs)

   Bases: :py:obj:`BaseGraphItem`


   Base class for all graph items with standardized fields.


.. py:class:: RegexWrapper(mapping: dict)

   .. py:attribute:: regex_entries
      :value: []



   .. py:method:: _extract_regex_entries(mapping: dict) -> list


   .. py:method:: wrap(html: str) -> str


   .. py:method:: _wrap_pattern(html: str, pattern: str, cls: str) -> str


.. py:function:: generate_wadm_annotation(item)