Module: dag_edge

Expand source code

# Copyright (C) 2023-present The Project Contributors
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from dataclasses import dataclass
from typing import Any
from typing import Dict
from cl.runtime.records.dataclasses_extensions import missing


@dataclass(slots=True, kw_only=True)
class DagEdge:
    """Directed acyclic graph (DAG) node edge."""

    id_: str = missing()
    """Unique edge identifier."""

    label: str | None = missing()
    """Optional edge label."""

    source: str = missing()
    """Source node id."""

    target: str = missing()
    """Target node id."""

    def to_networkx(self) -> Dict[str, Any]:
        """Transform node to networkx representation."""
        result = {
            "u_of_edge": self.source,
            "v_of_edge": self.target,
        }
        return result

Classes

class DagEdge (*, id_: str = None, label: str | None = None, source: str = None, target: str = None)

Directed acyclic graph (DAG) node edge.

Expand source code

@dataclass(slots=True, kw_only=True)
class DagEdge:
    """Directed acyclic graph (DAG) node edge."""

    id_: str = missing()
    """Unique edge identifier."""

    label: str | None = missing()
    """Optional edge label."""

    source: str = missing()
    """Source node id."""

    target: str = missing()
    """Target node id."""

    def to_networkx(self) -> Dict[str, Any]:
        """Transform node to networkx representation."""
        result = {
            "u_of_edge": self.source,
            "v_of_edge": self.target,
        }
        return result

Fields

var id_ -> str: Unique edge identifier.
var label -> str | None: Optional edge label.
var source -> str: Source node id.
var target -> str: Target node id.

Methods

def to_networkx(self) -> Dict[str, Any]: Transform node to networkx representation.