Converters

EasyNetwork’s packet converters module

class easynetwork.converter.AbstractPacketConverter

Bases: AbstractPacketConverterComposite[_PacketT, _PacketT, _DTOPacketT, _DTOPacketT], Generic[_PacketT, _DTOPacketT]

The base class for implementing a converter.

See also

The AbstractPacketConverterComposite class.

abstract create_from_dto_packet(packet, /)

Constructs the business object from the DTO packet.

Parameters:

packet (_DTOPacketT) – The data transfer object.

Raises:

PacketConversionError – packet is invalid.

Returns:

the business object.

Return type:

_PacketT

abstract convert_to_dto_packet(obj, /)

Creates the DTO packet from the business object obj.

Parameters:

obj (_PacketT) – The business object.

Returns:

the data transfer object.

Return type:

_DTOPacketT

class easynetwork.converter.AbstractPacketConverterComposite

Bases: Generic[_SentPacketT, _ReceivedPacketT, _SentDTOPacketT, _ReceivedDTOPacketT]

The base class for implementing a composite converter.

See also

The AbstractPacketConverter class.

abstract create_from_dto_packet(packet, /)

Constructs the business object from the DTO packet.

Parameters:

packet (_ReceivedDTOPacketT) – The data transfer object.

Raises:

PacketConversionError – packet is invalid.

Returns:

the business object.

Return type:

_ReceivedPacketT

abstract convert_to_dto_packet(obj, /)

Creates the DTO packet from the business object obj.

Parameters:

obj (_SentPacketT) – The business object.

Returns:

the data transfer object.

Return type:

_SentDTOPacketT

class easynetwork.converter.StapledPacketConverter(sent_packet_converter, received_packet_converter)

Bases: AbstractPacketConverterComposite[_SentPacketT, _ReceivedPacketT, _SentDTOPacketT, _ReceivedDTOPacketT]

A composite converter that merges two converters.

sent_packet_converter: AbstractPacketConverterComposite[_SentPacketT, Any, _SentDTOPacketT, Any]

Sent packet converter.

received_packet_converter: AbstractPacketConverterComposite[Any, _ReceivedPacketT, Any, _ReceivedDTOPacketT]

Received packet converter.

final create_from_dto_packet(packet, /)

Calls self.received_packet_converter.create_from_dto_packet(packet).

Parameters:

packet (_ReceivedDTOPacketT) – The data transfer object.

Raises:

PacketConversionError – packet is invalid.

Returns:

the business object.

Return type:

_ReceivedPacketT

final convert_to_dto_packet(obj, /)

Calls self.sent_packet_converter.convert_to_dto_packet(obj).

Parameters:

obj (_SentPacketT) – The business object.

Returns:

the data transfer object.

Return type:

_SentDTOPacketT