uds.transport_interface.logger
==============================

.. py:module:: uds.transport_interface.logger

.. autoapi-nested-parse::

   Logger implementation for Transport Interfaces.



Classes
-------

.. autoapisummary::

   uds.transport_interface.logger.TransportLogger


Module Contents
---------------

.. py:class:: 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)

   Configurable logger for Transport Interface objects.

   Configure transport logging.

   :param message_logging_level: Logging level to use for UDS Messages logging.
   :param packet_logging_level: Logging level to use for Packets logging.
   :param log_receiving: Whether to log received messages/packets.
   :param message_log_format: Log messages format for UDS Messages.
       It has to be defined as a str on which format method would be called with record parameter.
   :param packet_log_format: Log messages format for Packets.
       It has to be defined as a str on which format method would be called with record parameter.


   .. py:attribute:: TransportInterfaceAlias

      Alias of Transport Interface (either class or instance).



   .. py:attribute:: DECORATED_CLASS_NAME_SUFFIX
      :value: 'WithLogger'


      Suffix to add to decorated classes.



   .. py:attribute:: DEFAULT_LOG_FORMAT
      :type:  str
      :value: '{record.direction.name} {record}'


      Default format of log messages.



   .. py:attribute:: __logger


   .. py:property:: message_logging_level
      :type: Optional[int]


      Get logging level to use for UDS Messages logging.



   .. py:property:: packet_logging_level
      :type: Optional[int]


      Get logging level to use for Packets logging.



   .. py:property:: log_sending
      :type: bool


      Get information whether outgoing traffic shall be logged.



   .. py:property:: log_receiving
      :type: bool


      Get information whether incoming traffic shall be logged.



   .. py:property:: message_log_format
      :type: str


      Get log messages format for UDS Messages.



   .. py:property:: packet_log_format
      :type: str


      Get log messages format for Packets.



   .. py:method:: __call__(transport_interface)

      Decorate Transport Interface.



   .. py:property:: logger
      :type: logging.Logger


      Get configured Logger (from logging package).



   .. py:method:: _decorate_class(cls)

      Decorate Transport Interface class.



   .. py:method:: _decorate_instance(instance)

      Decorate Transport Interface instance.



   .. py:method:: _decorate_message_method(method)

      Decorate method that either transmits or receives UDS Message.



   .. py:method:: _decorate_packet_method(method)

      Decorate method that either transmits or receives Packet.



   .. py:method:: log_message(record)

      Log a message after receiving/transmitting UDS Message.



   .. py:method:: log_packet(record)

      Log a message after receiving/transmitting Packet.