serialize and deserilize mro

[Licini]

This is to add the ability to deserializing a datastructure implementation like Mesh, Graph, Cellnetwork etc. to its closest available parent class.

For example we want to be able to serialize a FormDiagram object using compas_tna into a json. And open same json in another environment without compas_tna installed, while loading the same object as its closest available class Mesh.

An example behaviour:

from compas.datastructures import Mesh
from compas import json_dumps
from compas import json_loads

# Some custom class that inherits from Mesh but is not available when deserializing
class MyCustomMesh(Mesh):
    pass

mesh = MyCustomMesh()
serialized = json_dumps(mesh)

# delete the access to our custom class
del MyCustomMesh

# fallback to Mesh if MyCustomMesh is not available
loaded = json_loads(serialized)
assert loaded.__class__ == Mesh

This is done through inserting an mro (method resolving order) field into the json dump state, so the decoder can later pickup and use as a backup if dtype is not directly found

[codecov]

Codecov Report

Attention: Patch coverage is 91.66667% with 3 lines in your changes missing coverage. Please review.

Project coverage is 61.92%. Comparing base (d773b3e) to head (ff7344e).
Report is 6 commits behind head on main.

Files with missing lines	Patch %	Lines
src/compas/data/encoders.py	86.66%	2 Missing ⚠️
src/compas/datastructures/datastructure.py	94.44%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1460      +/-   ##
==========================================
+ Coverage   61.91%   61.92%   +0.01%     
==========================================
  Files         208      208              
  Lines       22334    22365      +31     
==========================================
+ Hits        13827    13850      +23     
- Misses       8507     8515       +8     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[tomvanmele]

__clstype__ or __ctype__ perhaps?

[Licini]

ok clstype then, as ctype is a exiting function (C compatible data types)

[tomvanmele]

i would not call this "mro". method resolution order refers to the mechanism that Python uses to determine which method should be called in a multiple inheritance scenario. but that is not what we do here...

[Licini]

indeed, we use "inheritance" then

[tomvanmele]

__clstree__ or __inheritance__ or something like that?

[Licini]

ok, __inheritance__ and as property

[Licini]

@tomvanmele how does this look now?

[gonzalocasas]

Very cool change! Could you please revise the data serialization doc page, and add this information? https://compas.dev/compas/latest/userguide/advanced.serialisation.html