Module pygmlparser.Edge

Classes

class Edge

Expand source code

class Edge:
    def __init__(self):

        self.id:     int = cast(int, None)
        """
        The unique edge id
        """
        self.source: int = cast(int, None)
        """
        The source node id for this edge
        """
        self.target: int = cast(int, None)
        """
        The target node id for this edge
        """

        self.label: int = cast(int, None)
        """
        Optional label for this edge
        """
        self.source_node = None
        """
        The actual source node
        """
        self.target_node = None
        """
        The actual target node
        """
        self.graphics: EdgeGraphics = cast(EdgeGraphics, None)
        """
        The Tulip <i>graphics</i> extension attributes
        """

    def validate(self, rawIdx: int):
        """
        Tests for the mandatory attributes id, source, and target from GML

        Args:
            rawIdx: Index into the source input
        Raises
            `GMLParseException` if mandatory properties are not valid
        """

        if self.source is None:
            raise GMLParseException(f'[pos {rawIdx}] edge has no source')
        if self.target is None:
            raise GMLParseException(f'[pos {rawIdx}] edge has no target')

        if not isinstance(self.source, int):
            raise GMLParseException(f'[pos {rawIdx}] edge has non-int source: {self.source}')
        if not isinstance(self.target, int):
            raise GMLParseException(f'[pos {rawIdx}] edge has non-int target: {self.target}')

    def __str__(self):
        meStr: str = f'Edge[id: {self.id} label: {self.label} source: {self.source} target: {self.target}] {self.graphics.__str__()}'

        return meStr

    def __repr__(self):
        return self.__str__()

Instance variables

var graphics

The Tulip graphics extension attributes

var id

The unique edge id

var label

Optional label for this edge

var source

The source node id for this edge

var source_node

The actual source node

var target

The target node id for this edge

var target_node

The actual target node

Methods

def validate(self, rawIdx: int)

Tests for the mandatory attributes id, source, and target from GML

Args

rawIdx

Index into the source input

Raises GMLParseException if mandatory properties are not valid

Expand source code

def validate(self, rawIdx: int):
    """
    Tests for the mandatory attributes id, source, and target from GML

    Args:
        rawIdx: Index into the source input
    Raises
        `GMLParseException` if mandatory properties are not valid
    """

    if self.source is None:
        raise GMLParseException(f'[pos {rawIdx}] edge has no source')
    if self.target is None:
        raise GMLParseException(f'[pos {rawIdx}] edge has no target')

    if not isinstance(self.source, int):
        raise GMLParseException(f'[pos {rawIdx}] edge has non-int source: {self.source}')
    if not isinstance(self.target, int):
        raise GMLParseException(f'[pos {rawIdx}] edge has non-int target: {self.target}')