pyvista.set_pickle_format

pyvista.set_pickle_format#

set_pickle_format(format: Literal['vtk', 'xml', 'legacy']) → None[source]#

Set the format used to serialize pyvista.DataObject when pickled.

Parameters:
formatstr

The format for serialization. Acceptable values are:

  • 'vtk' (default)objects are serialized using VTK’s official

    marshalling methods.

  • 'xml': objects are serialized as an XML-formatted string.

  • 'legacy' objects are serialized to bytes in VTK’s binary format.

Note

The 'vtk' format requires VTK 9.3 or greater.

Warning

'xml' and 'legacy' are not recommended. These formats are not officially supported by VTK and have limitations. For example, these formats cannot be used to pickle pyvista.MultiBlock.

Raises:
ValueError

If the provided format is not supported.