uds.transport_interface.logger

Logger implementation for Transport Interfaces.

Classes

TransportLogger

Configurable logger for Transport Interface objects.

Module Contents

class uds.transport_interface.logger.TransportLogger(*, logger_name=None, message_logging_level=INFO, packet_logging_level=INFO, log_sending=True, log_receiving=True, message_log_format=DEFAULT_LOG_FORMAT, packet_log_format=DEFAULT_LOG_FORMAT)[source]

Configurable logger for Transport Interface objects.

Configure transport logging.

Parameters:

message_logging_level (Optional[int]) – Logging level to use for UDS Messages logging.
packet_logging_level (Optional[int]) – Logging level to use for Packets logging.
log_receiving (bool) – Whether to log received messages/packets.
message_log_format (str) – Log messages format for UDS Messages. It has to be defined as a str on which format method would be called with record parameter.
packet_log_format (str) – Log messages format for Packets. It has to be defined as a str on which format method would be called with record parameter.
logger_name (Optional[str])
log_sending (bool)

TransportInterfaceAlias: Alias of Transport Interface (either class or instance).

DECORATED_CLASS_NAME_SUFFIX = 'WithLogger': Suffix to add to decorated classes.

DEFAULT_LOG_FORMAT: str = '{record.direction.name} {record}': Default format of log messages.

__logger

property message_logging_level: int | None

Get logging level to use for UDS Messages logging.

Return type:: Optional[int]

property packet_logging_level: int | None

Get logging level to use for Packets logging.

Return type:: Optional[int]

property log_sending: bool

Get information whether outgoing traffic shall be logged.

Return type:: bool

property log_receiving: bool

Get information whether incoming traffic shall be logged.

Return type:: bool

property message_log_format: str

Get log messages format for UDS Messages.

Return type:: str

property packet_log_format: str

Get log messages format for Packets.

Return type:: str

__call__(transport_interface)[source]

Decorate Transport Interface.

Parameters:: transport_interface (TransportInterfaceAlias)
Return type:: TransportInterfaceAlias

property logger: logging.Logger

Get configured Logger (from logging package).

Return type:: logging.Logger

_decorate_class(cls)[source]

Decorate Transport Interface class.

Parameters:: cls (Type[uds.transport_interface.abstract_transport_interface.AbstractTransportInterface])
Return type:: Type[uds.transport_interface.abstract_transport_interface.AbstractTransportInterface]

_decorate_instance(instance)[source]

Decorate Transport Interface instance.

Parameters:: instance (uds.transport_interface.abstract_transport_interface.AbstractTransportInterface)
Return type:: uds.transport_interface.abstract_transport_interface.AbstractTransportInterface

_decorate_message_method(method)[source]

Decorate method that either transmits or receives UDS Message.

Parameters:: method (Callable)
Return type:: Callable

_decorate_packet_method(method)[source]

Decorate method that either transmits or receives Packet.

Parameters:: method (Callable)
Return type:: Callable

log_message(record)[source]

Log a message after receiving/transmitting UDS Message.

Parameters:: record (uds.message.UdsMessageRecord)
Return type:: None

log_packet(record)[source]

Log a message after receiving/transmitting Packet.

Parameters:: record (uds.packet.AbstractPacketRecord)
Return type:: None