Converters

EasyNetwork’s packet converters module.

class easynetwork.converter.AbstractPacketConverter

Bases: AbstractPacketConverterComposite[_T_SentPacket, _T_SentPacket, _T_SentDTOPacket, _T_SentDTOPacket], Generic[_T_SentPacket, _T_SentDTOPacket]

The base class for implementing a converter.

See also

The AbstractPacketConverterComposite class.

abstract create_from_dto_packet(packet: _T_SentDTOPacket, /) → _T_SentPacket

Constructs the business object from the DTO packet.

Parameters:

packet (_T_SentDTOPacket) – The data transfer object.

Raises:

PacketConversionError – packet is invalid.

Returns:

the business object.

Return type:

_T_SentPacket

abstract convert_to_dto_packet(obj: _T_SentPacket, /) → _T_SentDTOPacket

Creates the DTO packet from the business object obj.

Parameters:

obj (_T_SentPacket) – The business object.

Returns:

the data transfer object.

Return type:

_T_SentDTOPacket

class easynetwork.converter.AbstractPacketConverterComposite

Bases: Generic[_T_SentPacket, _T_ReceivedPacket, _T_SentDTOPacket, _T_ReceivedDTOPacket]

The base class for implementing a composite converter.

See also

The AbstractPacketConverter class.

abstract create_from_dto_packet(packet: _T_ReceivedDTOPacket, /) → _T_ReceivedPacket

Constructs the business object from the DTO packet.

Parameters:

packet (_T_ReceivedDTOPacket) – The data transfer object.

Raises:

PacketConversionError – packet is invalid.

Returns:

the business object.

Return type:

_T_ReceivedPacket

abstract convert_to_dto_packet(obj: _T_SentPacket, /) → _T_SentDTOPacket

Creates the DTO packet from the business object obj.

Parameters:

obj (_T_SentPacket) – The business object.

Returns:

the data transfer object.

Return type:

_T_SentDTOPacket

class easynetwork.converter.StapledPacketConverter

Bases: AbstractPacketConverterComposite[_T_SentPacket, _T_ReceivedPacket, _T_SentDTOPacket, _T_ReceivedDTOPacket]

A composite converter that merges two converters.

sent_packet_converter: AbstractPacketConverterComposite[_T_SentPacket, Any, _T_SentDTOPacket, Any]

Sent packet converter.

received_packet_converter: AbstractPacketConverterComposite[Any, _T_ReceivedPacket, Any, _T_ReceivedDTOPacket]

Received packet converter.

final create_from_dto_packet(packet: _T_ReceivedDTOPacket, /) → _T_ReceivedPacket

Calls self.received_packet_converter.create_from_dto_packet(packet).

Parameters:

packet (_T_ReceivedDTOPacket) – The data transfer object.

Raises:

PacketConversionError – packet is invalid.

Returns:

the business object.

Return type:

_T_ReceivedPacket

final convert_to_dto_packet(obj: _T_SentPacket, /) → _T_SentDTOPacket

Calls self.sent_packet_converter.convert_to_dto_packet(obj).

Parameters:

obj (_T_SentPacket) – The business object.

Returns:

the data transfer object.

Return type:

_T_SentDTOPacket

---

See also

How-to — Communication Protocols

Describes where and when a converter is used.