Module: dag_node

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 typing import Optional
from cl.runtime.records.dataclasses_extensions import missing
from cl.runtime.view.dag.dag_node_data import DagNodeData
from cl.runtime.view.dag.dag_node_position import DagNodePosition


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

    id_: str = missing()
    """Node unique identifier."""

    position: DagNodePosition | None = missing()
    """Node UI position."""

    data: DagNodeData = missing()
    """Node internal data."""

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

Classes

class DagNode (*, id_: str = None, position: DagNodePosition | None = None, data: DagNodeData = None)

Directed acyclic graph (DAG) node.

Expand source code
@dataclass(slots=True, kw_only=True)
class DagNode:
    """Directed acyclic graph (DAG) node."""

    id_: str = missing()
    """Node unique identifier."""

    position: DagNodePosition | None = missing()
    """Node UI position."""

    data: DagNodeData = missing()
    """Node internal data."""

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

Subclasses

Fields

var data -> DagNodeData

Node internal data.

var id_ -> str

Node unique identifier.

var position -> DagNodePosition | None

Node UI position.

Methods

def to_networkx(self) -> Dict[str, Any]

Transform node to networkx representation.