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
|
import inspect
from collections import namedtuple
from qtpy.QtCore import QObject, Signal
from qtpy.QtWidgets import QWidget
from . import style as style_module
from .base import Serializable
from .enums import ConnectionPolicy, NodeValidationState, PortType
from .port import Port
NodeDataType = namedtuple('NodeDataType', ('id', 'name'))
class NodeData:
"""
Class represents data transferred between nodes.
The actual data is stored in subtypes
"""
data_type = NodeDataType(None, None)
def __init_subclass__(cls, **kwargs):
super().__init_subclass__(**kwargs)
if cls.data_type is None:
raise ValueError('Subclasses must set the `data_type` attribute')
def same_type(self, other) -> bool:
"""
Is another NodeData instance of the same type?
Parameters
----------
other : NodeData
Returns
-------
value : bool
"""
return self.data_type.id == other.data_type.id
class NodeDataModel(QObject, Serializable):
name = None
caption = None
caption_visible = True
num_ports = {PortType.input: 1,
PortType.output: 1,
}
# data_updated and data_invalidated refer to the port index that has
# changed:
data_updated = Signal(int)
data_invalidated = Signal(int)
computing_started = Signal()
computing_finished = Signal()
embedded_widget_size_updated = Signal()
def __init__(self, style=None, parent=None):
super().__init__(parent=parent)
if style is None:
style = style_module.default_style
self._style = style
def __init_subclass__(cls, verify=True, **kwargs):
super().__init_subclass__(**kwargs)
# For all subclasses, if no name is defined, default to the class name
if cls.name is None:
cls.name = cls.__name__
if cls.caption is None and cls.caption_visible:
cls.caption = cls.name
num_ports = cls.num_ports
if isinstance(num_ports, property):
# Dynamically defined - that's OK, but we can't verify it.
return
if verify:
cls._verify()
@classmethod
def _verify(cls):
'''
Verify the data model won't crash in strange spots
Ensure valid dictionaries:
- num_ports
- data_type
- port_caption
- port_caption_visible
'''
num_ports = cls.num_ports
if isinstance(num_ports, property):
# Dynamically defined - that's OK, but we can't verify it.
return
assert set(num_ports.keys()) == {'input', 'output'}
# TODO while the end result is nicer, this is ugly; refactor away...
def new_dict(value):
return {
PortType.input: {i: value
for i in range(num_ports[PortType.input])
},
PortType.output: {i: value
for i in range(num_ports[PortType.output])
},
}
def get_default(attr, default, valid_type):
current = getattr(cls, attr, None)
if current is None:
# Unset - use the default
return default
if valid_type is not None:
if isinstance(current, valid_type):
# Fill in the dictionary with the user-provided value
return current
if attr == 'data_type' and inspect.isclass(current):
if issubclass(current, NodeData):
return current.data_type
if inspect.ismethod(current) or inspect.isfunction(current):
raise ValueError('{} should not be a function; saw: {}\n'
'Did you forget a @property decorator?'
''.format(attr, current))
try:
type(default)(current)
except TypeError:
raise ValueError('{} is of an unexpected type: {}'
''.format(attr, current)) from None
# Fill in the dictionary with the given value
return current
def fill_defaults(attr, default, valid_type=None):
if isinstance(getattr(cls, attr, None), dict):
return
default = get_default(attr, default, valid_type)
if default is None:
raise ValueError('Cannot leave {} unspecified'.format(attr))
setattr(cls, attr, new_dict(default))
fill_defaults('port_caption', '')
fill_defaults('port_caption_visible', False)
fill_defaults('data_type', None, valid_type=NodeDataType)
reasons = []
for attr in ('data_type', 'port_caption', 'port_caption_visible'):
try:
dct = getattr(cls, attr)
except AttributeError:
reasons.append('{} is missing dictionary: {}'
''.format(cls.__name__, attr))
continue
if isinstance(dct, property):
continue
for port_type in {'input', 'output'}:
if port_type not in dct:
if num_ports[port_type] == 0:
dct[port_type] = {}
else:
reasons.append('Port type key {}[{!r}] missing'
''.format(attr, port_type))
continue
for i in range(num_ports[port_type]):
if i not in dct[port_type]:
reasons.append('Port key {}[{!r}][{}] missing'
''.format(attr, port_type, i))
if reasons:
reason_text = '\n'.join('* {}'.format(reason)
for reason in reasons)
raise ValueError(
'Verification of NodeDataModel class failed:\n{}'
''.format(reason_text)
)
@property
def style(self):
'Style collection for drawing this data model'
return self._style
def save(self) -> dict:
"""
Subclasses may implement this to save additional state for
pickling/saving to JSON.
Returns
-------
value : dict
"""
return {}
def restore(self, doc: dict):
"""
Subclasses may implement this to load additional state from
pickled or saved-to-JSON data.
Parameters
----------
value : dict
"""
return {}
def __setstate__(self, doc: dict):
"""
Set the state of the NodeDataModel
Parameters
----------
doc : dict
"""
self.restore(doc)
return doc
def __getstate__(self) -> dict:
"""
Get the state of the NodeDataModel for saving/pickling
Returns
-------
value : QJsonObject
"""
doc = {'name': self.name}
doc.update(**self.save())
return doc
@property
def data_type(self):
"""
Data type placeholder - to be implemented by subclass.
Parameters
----------
port_type : PortType
port_index : int
Returns
-------
value : NodeDataType
"""
raise NotImplementedError(f'Subclass {self.__class__.__name__} must '
f'implement `data_type`')
def port_out_connection_policy(self, port_index: int) -> ConnectionPolicy:
"""
Port out connection policy
Parameters
----------
port_index : int
Returns
-------
value : ConnectionPolicy
"""
return ConnectionPolicy.many
@property
def node_style(self) -> style_module.NodeStyle:
"""
Node style
Returns
-------
value : NodeStyle
"""
return self._style.node
def set_in_data(self, node_data: NodeData, port: Port):
"""
Triggers the algorithm; to be overridden by subclasses
Parameters
----------
node_data : NodeData
port : Port
"""
...
def out_data(self, port: int) -> NodeData:
"""
Out data
Parameters
----------
port : int
Returns
-------
value : NodeData
"""
...
def embedded_widget(self) -> QWidget:
"""
Embedded widget
Returns
-------
value : QWidget
"""
...
def resizable(self) -> bool:
"""
Resizable
Returns
-------
value : bool
"""
return False
def validation_state(self) -> NodeValidationState:
"""
Validation state
Returns
-------
value : NodeValidationState
"""
return NodeValidationState.valid
def validation_message(self) -> str:
"""
Validation message
Returns
-------
value : str
"""
return ""
def painter_delegate(self):
"""
Painter delegate
Returns
-------
value : NodePainterDelegate
"""
return None
def input_connection_created(self, connection):
"""
Input connection created
Parameters
----------
connection : Connection
"""
...
def input_connection_deleted(self, connection):
"""
Input connection deleted
Parameters
----------
connection : Connection
"""
...
def output_connection_created(self, connection):
"""
Output connection created
Parameters
----------
connection : Connection
"""
...
def output_connection_deleted(self, connection):
"""
Output connection deleted
Parameters
----------
connection : Connection
"""
...
|