vcorelib.graph.edge
index
/home/vkottler/src/vkottler/workspace/vcorelib/vcorelib/graph/edge.py

A module for defining and working with graph edges.

 
Classes
       
builtins.tuple(builtins.object)
GraphEdge

 
class GraphEdge(builtins.tuple)
    GraphEdge(src: str, dst: str, src_port: Optional[vcorelib.graph.port.Port] = None, dst_port: Optional[vcorelib.graph.port.Port] = None, attrs: Optional[Dict[str, str]] = None)
 
A grouping of attributes describing a directed edge in a graph.
 
 
Method resolution order:
GraphEdge
builtins.tuple
builtins.object

Methods defined here:
__eq__(self, other) -> bool
Determine if this edge is equivalent to another.
__getnewargs__(self)
Return self as a plain tuple.  Used by copy and pickle.
__hash__(self) -> int
Use a string representation as a sane hashing method.
__repr__(self)
Return a nicely formatted representation string
_asdict(self)
Return a new dict which maps field names to their values.
_replace(self, /, **kwds)
Return a new GraphEdge object replacing specified fields with new values
to_stream(self, stream: <class 'TextIO'>, edgeop: str = '->', **_) -> None
Write this object to a text stream.

Class methods defined here:
_make(iterable) from builtins.type
Make a new GraphEdge object from a sequence or iterable

Static methods defined here:
__new__(_cls, src: str, dst: str, src_port: Optional[vcorelib.graph.port.Port] = None, dst_port: Optional[vcorelib.graph.port.Port] = None, attrs: Optional[Dict[str, str]] = None)
Create new instance of GraphEdge(src, dst, src_port, dst_port, attrs)

Data descriptors defined here:
src
Alias for field number 0
dst
Alias for field number 1
src_port
Alias for field number 2
dst_port
Alias for field number 3
attrs
Alias for field number 4

Data and other attributes defined here:
__annotations__ = {'attrs': typing.Optional[typing.Dict[str, str]], 'dst': <class 'str'>, 'dst_port': typing.Optional[vcorelib.graph.port.Port], 'src': <class 'str'>, 'src_port': typing.Optional[vcorelib.graph.port.Port]}
__match_args__ = ('src', 'dst', 'src_port', 'dst_port', 'attrs')
__orig_bases__ = (<function NamedTuple>,)
_field_defaults = {'attrs': None, 'dst_port': None, 'src_port': None}
_fields = ('src', 'dst', 'src_port', 'dst_port', 'attrs')

Methods inherited from builtins.tuple:
__add__(self, value, /)
Return self+value.
__contains__(self, key, /)
Return bool(key in self).
__ge__(self, value, /)
Return self>=value.
__getattribute__(self, name, /)
Return getattr(self, name).
__getitem__(self, key, /)
Return self[key].
__gt__(self, value, /)
Return self>value.
__iter__(self, /)
Implement iter(self).
__le__(self, value, /)
Return self<=value.
__len__(self, /)
Return len(self).
__lt__(self, value, /)
Return self<value.
__mul__(self, value, /)
Return self*value.
__ne__(self, value, /)
Return self!=value.
__rmul__(self, value, /)
Return value*self.
count(self, value, /)
Return number of occurrences of value.
index(self, value, start=0, stop=9223372036854775807, /)
Return first index of value.
 
Raises ValueError if the value is not present.

Class methods inherited from builtins.tuple:
__class_getitem__(...) from builtins.type
See PEP 585

 
Functions
       
write_attributes(stream: <class 'TextIO'>, data: Dict[str, str] = None) -> None
A simple attribute writer for Graphviz's DOT language.
write_node_id(label: str, stream: <class 'TextIO'>, port: vcorelib.graph.port.Port = None) -> None
Write a node identifier to a stream.

 
Data
        AttributeMap = typing.Dict[str, str]