1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421
|
import uuid
from qtpy.QtCore import QObject, Signal
from . import exceptions
from .base import ConnectionBase, Serializable
from .connection_geometry import ConnectionGeometry
from .connection_graphics_object import ConnectionGraphicsObject
from .node import Node, NodeDataType
from .node_data import NodeData
from .port import Port, PortType, opposite_port
from .style import StyleCollection
from .type_converter import TypeConverter
class Connection(QObject, Serializable, ConnectionBase):
connection_completed = Signal(QObject)
connection_made_incomplete = Signal(QObject)
updated = Signal(QObject)
def __init__(self, port_a: Port, port_b: Port = None, *,
style: StyleCollection, converter: TypeConverter = None):
super().__init__()
self._uid = str(uuid.uuid4())
if port_a is None:
raise ValueError('port_a is required')
elif port_a is port_b:
raise ValueError('Cannot connect a port to itself')
if port_a.port_type == PortType.input:
in_port = port_a
out_port = port_b
else:
in_port = port_b
out_port = port_a
if in_port is not None and out_port is not None:
if in_port.port_type == out_port.port_type:
raise exceptions.PortsOfSameTypeError(
'Cannot connect two ports of the same type')
self._ports = {
PortType.input: in_port,
PortType.output: out_port
}
if in_port is not None:
if in_port.connections:
conn, = in_port.connections
existing_in, existing_out = conn.ports
if existing_in == in_port and existing_out == out_port:
raise exceptions.PortsAlreadyConnectedError(
'Specified ports already connected')
raise exceptions.MultipleInputConnectionError(
f'Maximum one connection per input port '
f'(existing: {conn})')
if in_port and out_port:
self._required_port = PortType.none
elif in_port:
self._required_port = PortType.output
else:
self._required_port = PortType.input
self._last_hovered_node = None
self._converter = converter
self._style = style
self._connection_geometry = ConnectionGeometry(style)
self._graphics_object = None
def _cleanup(self):
if self.is_complete:
self.connection_made_incomplete.emit(self)
self.propagate_empty_data()
self.last_hovered_node = None
for port_type, port in self.valid_ports.items():
if port.node.graphics_object is not None:
port.node.graphics_object.update()
self._ports[port] = None
if self._graphics_object is not None:
self._graphics_object._cleanup()
self._graphics_object = None
@property
def style(self) -> StyleCollection:
return self._style
def __getstate__(self) -> dict:
"""
save
Returns
-------
value : dict
"""
in_port, out_port = self.ports
if not in_port and not out_port:
return {}
connection_json = dict(
in_id=in_port.node.id,
in_index=in_port.index,
out_id=out_port.node.id,
out_index=out_port.index,
)
if self._converter:
def get_type_json(type: PortType):
node_type = self.data_type(type)
return dict(
id=node_type.id,
name=node_type.name
)
connection_json["converter"] = {
"in": get_type_json(PortType.input),
"out": get_type_json(PortType.output),
}
return connection_json
@property
def id(self) -> str:
"""
Unique identifier (uuid)
Returns
-------
uuid : str
"""
return self._uid
@property
def required_port(self) -> PortType:
"""
Required port
Returns
-------
value : PortType
"""
return self._required_port
@required_port.setter
def required_port(self, dragging: PortType):
"""
Remembers the end being dragged. Invalidates Node address. Grabs mouse.
Parameters
----------
dragging : PortType
"""
self._required_port = dragging
try:
port = self.valid_ports[dragging]
except KeyError:
...
else:
port.remove_connection(self)
@property
def graphics_object(self) -> ConnectionGraphicsObject:
"""
Get the connection graphics object
Returns
----------
graphics : ConnectionGraphicsObject
"""
return self._graphics_object
@graphics_object.setter
def graphics_object(self, graphics: ConnectionGraphicsObject):
self._graphics_object = graphics
# this function is only called when the ConnectionGraphicsObject is
# newly created. At self moment both end coordinates are (0, 0) in
# Connection G.O. coordinates. The position of the whole Connection GO
# in scene coordinate system is also (0, 0). By moving the whole
# object to the Node Port position we position both connection ends
# correctly.
if self.required_port != PortType.none:
attached_port = opposite_port(self.required_port)
attached_port_index = self.get_port_index(attached_port)
node = self.get_node(attached_port)
node_scene_transform = node.graphics_object.sceneTransform()
pos = node.geometry.port_scene_position(attached_port,
attached_port_index,
node_scene_transform)
self._graphics_object.setPos(pos)
self._graphics_object.move()
def connect_to(self, port: Port):
"""
Assigns a node to the required port.
Parameters
----------
port : Port
"""
if self._ports[port.port_type] is not None:
raise ValueError('Port already specified')
was_incomplete = not self.is_complete
self._ports[port.port_type] = port
self.updated.emit(self)
self.required_port = PortType.none
if self.is_complete and was_incomplete:
self.connection_completed.emit(self)
def remove_from_nodes(self):
for port in self._ports.values():
if port is not None:
port.remove_connection(self)
@property
def geometry(self) -> ConnectionGeometry:
"""
Connection geometry
Returns
-------
value : ConnectionGeometry
"""
return self._connection_geometry
def get_node(self, port_type: PortType) -> Node:
"""
Get node
Parameters
----------
port_type : PortType
Returns
-------
value : Node
"""
port = self._ports[port_type]
if port is not None:
return port.node
@property
def nodes(self):
# TODO namedtuple; TODO order
return (self.get_node(PortType.input), self.get_node(PortType.output))
@property
def ports(self):
# TODO namedtuple; TODO order
return (self._ports[PortType.input], self._ports[PortType.output])
def get_port_index(self, port_type: PortType) -> int:
"""
Get port index
Parameters
----------
port_type : PortType
Returns
-------
index : int
"""
return self._ports[port_type].index
def clear_node(self, port_type: PortType):
"""
Clear node
Parameters
----------
port_type : PortType
"""
if self.is_complete:
self.connection_made_incomplete.emit(self)
port = self._ports[port_type]
self._ports[port_type] = None
port.remove_connection(self)
@property
def valid_ports(self):
return {port_type: port
for port_type, port in self._ports.items()
if port is not None
}
def data_type(self, port_type: PortType) -> NodeDataType:
"""
Data type
Parameters
----------
port_type : PortType
Returns
-------
value : NodeDataType
"""
ports = self.valid_ports
if not ports:
raise ValueError('No ports set')
try:
return ports[port_type].data_type
except KeyError:
valid_type, = ports
return ports[valid_type].data_type
@property
def type_converter(self) -> TypeConverter:
"""
Set type converter
Returns
-------
converter : TypeConverter
"""
return self._converter
@type_converter.setter
def type_converter(self, converter: TypeConverter):
self._converter = converter
@property
def is_complete(self) -> bool:
"""
Connection is complete - in/out nodes are set
Returns
-------
value : bool
"""
return all(self._ports.values())
def propagate_data(self, node_data: NodeData):
"""
Propagate the given data from the output port -> input port.
Parameters
----------
node_data : NodeData
"""
in_port, out_port = self.ports
if not in_port:
return
if node_data is not None and self._converter:
node_data = self._converter(node_data)
in_port.node.propagate_data(node_data, in_port)
@property
def input_node(self) -> Node:
'Input node'
return self._ports[PortType.input].node
@property
def output_node(self) -> Node:
'Output node'
return self._ports[PortType.output].node
# For backward-compatibility:
output = output_node
def propagate_empty_data(self):
self.propagate_data(None)
@property
def last_hovered_node(self) -> Node:
"""
Last hovered node
Returns
-------
value : Node
"""
return self._last_hovered_node
@last_hovered_node.setter
def last_hovered_node(self, node: Node):
"""
Set last hovered node
Parameters
----------
node : Node
"""
if node is None and self._last_hovered_node:
self._last_hovered_node.reset_reaction_to_connection()
self._last_hovered_node = node
def interact_with_node(self, node: Node):
"""
Interact with node
Parameters
----------
node : Node
"""
self.last_hovered_node = node
@property
def requires_port(self) -> bool:
"""
Requires port
Returns
-------
value : bool
"""
return self._required_port != PortType.none
def __repr__(self):
return (f'<{self.__class__.__name__} ports={self._ports}>')
|