Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 942 Bytes

serialization.rst

File metadata and controls

24 lines (17 loc) · 942 Bytes

Serialization

All of serializable classes derive from ~nodedge.serializable.Serializable class. Serializable does create commonly used parameters for our classes. In our case it is just id attribute.

Serializable defines two methods which should be overridden in child classes:

  • :py~nodedge.serializable.Serializable.serialize
  • :py~nodedge.serializable.Serializable.deserialize

According to coding-standards we keep these two functions on the bottom of the class source code.

To contain all of the data we use OrderedDict instead of regular dict. Mainly because we want to retain the order of parameters serialized in files.

Classes which derive from ~nodeeditr.serializable.Serializable:

  • ~nodedge.scene.Scene
  • ~nodedge.node.Node
  • ~nodedge.content_widget.QDMNodeContentWidget
  • ~nodedge.edge.Edge
  • ~nodedge.socket.Socket