Module nafparserpy.layers.markables

Expand source code 
from dataclasses import dataclass, field
from typing import List

from nafparserpy.layers.utils import AttributeGetter, IdrefGetter, create_node, ExternalReferenceHolder
from nafparserpy.layers.elements import Span, ExternalReferences, Sentiment


@dataclass
class Mark(AttributeGetter, IdrefGetter, ExternalReferenceHolder):
    """Represents a mark"""
    id: str
    span: Span
    """span of covered target ids"""
    sentiment: Sentiment = Sentiment.create_none()
    """optional sentiment"""
    external_references: ExternalReferences = ExternalReferences([])
    """optional externalReferences"""
    attrs: dict = field(default_factory=dict)
    """optional attributes ('type', 'lemma', 'pos', 'morphofeat', 'case', 'source')"""

    def __post_init__(self):
        """Copy compulsory attributes to `attrs` field"""
        self.attrs.update({'id': self.id})

    def node(self):
        """Create etree node from object"""
        children = [self.span]
        if self.sentiment.is_none():
            children.append(self.sentiment)
        if self.external_references.items:
            children.append(self.external_references)
        return create_node('mark', None, children, self.attrs)

    @staticmethod
    def object(node):
        """Create object from etree node"""
        return Mark(node.get('id'),
                    Span.object(node.find('span')),
                    Sentiment.object(node.find('sentiment')),
                    ExternalReferences(ExternalReferences.object(node.find('externalReferences'))),
                    node.attrib)


@dataclass
class Markables:
    """Markables layer class"""
    items: List[Mark]

    def node(self):
        """Create etree node from object"""
        return create_node('markables', None, self.items, {})

    @staticmethod
    def object(node):
        """Create list of `Mark` objects from etree node"""
        return [Mark.object(n) for n in node]

Classes

class Mark (id: str, span: Span, sentiment: Sentiment = AttributeLayer(layer='sentiment', attrs={}), external_references: ExternalReferences = ExternalReferences(items=[]), attrs: dict = <factory>)

Represents a mark

Expand source code 
@dataclass
class Mark(AttributeGetter, IdrefGetter, ExternalReferenceHolder):
    """Represents a mark"""
    id: str
    span: Span
    """span of covered target ids"""
    sentiment: Sentiment = Sentiment.create_none()
    """optional sentiment"""
    external_references: ExternalReferences = ExternalReferences([])
    """optional externalReferences"""
    attrs: dict = field(default_factory=dict)
    """optional attributes ('type', 'lemma', 'pos', 'morphofeat', 'case', 'source')"""

    def __post_init__(self):
        """Copy compulsory attributes to `attrs` field"""
        self.attrs.update({'id': self.id})

    def node(self):
        """Create etree node from object"""
        children = [self.span]
        if self.sentiment.is_none():
            children.append(self.sentiment)
        if self.external_references.items:
            children.append(self.external_references)
        return create_node('mark', None, children, self.attrs)

    @staticmethod
    def object(node):
        """Create object from etree node"""
        return Mark(node.get('id'),
                    Span.object(node.find('span')),
                    Sentiment.object(node.find('sentiment')),
                    ExternalReferences(ExternalReferences.object(node.find('externalReferences'))),
                    node.attrib)

Ancestors

Class variables

var attrs : dict

optional attributes ('type', 'lemma', 'pos', 'morphofeat', 'case', 'source')

var external_references : ExternalReferences

optional externalReferences

var id : str
var sentiment : Sentiment

optional sentiment

var span : Span

span of covered target ids

Static methods

def object(node)

Create object from etree node

Expand source code 
@staticmethod
def object(node):
    """Create object from etree node"""
    return Mark(node.get('id'),
                Span.object(node.find('span')),
                Sentiment.object(node.find('sentiment')),
                ExternalReferences(ExternalReferences.object(node.find('externalReferences'))),
                node.attrib)

Methods

def node(self)

Create etree node from object

Expand source code 
def node(self):
    """Create etree node from object"""
    children = [self.span]
    if self.sentiment.is_none():
        children.append(self.sentiment)
    if self.external_references.items:
        children.append(self.external_references)
    return create_node('mark', None, children, self.attrs)

Inherited members

class Markables (items: List[Mark])

Markables layer class

Expand source code 
@dataclass
class Markables:
    """Markables layer class"""
    items: List[Mark]

    def node(self):
        """Create etree node from object"""
        return create_node('markables', None, self.items, {})

    @staticmethod
    def object(node):
        """Create list of `Mark` objects from etree node"""
        return [Mark.object(n) for n in node]

Class variables

var items : List[Mark]

Static methods

def object(node)

Create list of Mark objects from etree node

Expand source code 
@staticmethod
def object(node):
    """Create list of `Mark` objects from etree node"""
    return [Mark.object(n) for n in node]

Methods

def node(self)

Create etree node from object

Expand source code 
def node(self):
    """Create etree node from object"""
    return create_node('markables', None, self.items, {})