nvflare.fuel.utils.fobs.decomposer module

class DataClassDecomposer(data_type: Type[T])

Bases: Decomposer

Generic decomposers for data classes, which must meet following requirements:

1. All class members must be serializable. The type of member must be one of the types supported by MessagePack or a decomposer is registered for the type.

2. The __new__ method only takes one argument which is the class type.

3. The __init__ method has no side effects. It can only change the states of the object. The side effects include creating files, initializing loggers, modifying global variables.

decompose(target: T, manager: DatumManager | None = None) → Any

Decompose the target into types supported by msgpack or classes with decomposers registered.

Msgpack supports primitives, bytes, memoryview, lists, dicts.

Parameters:

• target – The instance to be serialized

• manager – Datum manager to store externalized datum

Returns:

The decomposed serializable objects

recompose(data: dict, manager: DatumManager | None = None) → T

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[T]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class Decomposer

Bases: ABC

Abstract base class for decomposers.

Every class to be serialized by FOBS must register a decomposer which is a concrete subclass of this class.

abstract decompose(target: T, manager: DatumManager | None = None) → Any

Decompose the target into types supported by msgpack or classes with decomposers registered.

Msgpack supports primitives, bytes, memoryview, lists, dicts.

Parameters:

• target – The instance to be serialized

• manager – Datum manager to store externalized datum

Returns:

The decomposed serializable objects

process_datum(datum: Datum, manager: DatumManager)

This method will be called during message deserialization to process the specified datum.

Parameters:

• datum – the datum to be processed

• manager – the datum manger

Returns: None

abstract recompose(data: Any, manager: DatumManager | None = None) → T

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_dots() → List[int] | None

Return the Datum Object Types supported by this decomposer. If a DOT is returned, this decomposer’s process_datum method will be called for any datum whose DOT matches this DOT.

Returns: None or list of DOTs

abstract supported_type() → Type[T]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class DictDecomposer(dict_type: Type[dict])

Bases: Decomposer

Generic decomposer for subclasses of dict like Shareable

decompose(target: dict, manager: DatumManager | None = None) → Any

Decompose the target into types supported by msgpack or classes with decomposers registered.

Msgpack supports primitives, bytes, memoryview, lists, dicts.

Parameters:

• target – The instance to be serialized

• manager – Datum manager to store externalized datum

Returns:

The decomposed serializable objects

recompose(data: dict, manager: DatumManager | None = None) → dict

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type()

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class EnumTypeDecomposer(data_type: Type[Enum])

Bases: Decomposer

Generic decomposers for enum types.

decompose(target: Enum, manager: DatumManager | None = None) → Any

Decompose the target into types supported by msgpack or classes with decomposers registered.

Msgpack supports primitives, bytes, memoryview, lists, dicts.

Parameters:

• target – The instance to be serialized

• manager – Datum manager to store externalized datum

Returns:

The decomposed serializable objects

recompose(data: Any, manager: DatumManager | None = None) → Enum

Reconstruct the object from decomposed components.

Parameters:

• data – The decomposed component

• manager – Datum manager to internalize datum

Returns:

The reconstructed object

supported_type() → Type[Enum]

Returns the type/class supported by this decomposer.

Returns:

The class (not instance) of supported type

class Externalizer(manager: DatumManager)

Bases: object

This class is used to help creating ‘decompose’ method of decomposers of arbitrary classes.

externalize(target: Any)

Recursively go through object tree (dict or list) and externalize leaf nodes.

class Internalizer(manager: DatumManager)

Bases: object

This class is used to help creating ‘recompose’ method of decomposers of arbitrary classes.

internalize(target) → Any

Recursively go through object tree (dict or list) and internalize leaf nodes.

restore_position(manager: DatumManager, datum: Datum, position)

This function is used for restoring object state at the specified position.

Parameters:

• manager – the datum manager

• datum – the datum that contains the value of the original object at the position.

• position – the position to be restored

Returns: None