sshmitm.logger module

class sshmitm.logger.Colors

Bases: object

classmethod do_noformat(text, styles, reset=True)
Parameters:
  • text (Any)

  • styles (Any)

  • reset (bool, default: True)

Return type:

Any

classmethod do_stylize(text, styles, reset=True)
Parameters:
  • text (Any)

  • styles (Any)

  • reset (bool, default: True)

Return type:

Any

classmethod emoji(name)
Parameters:

name (str)

Return type:

str

classmethod stylize(text, styles, reset=True)
Parameters:
  • text (Any)

  • styles (Any)

  • reset (bool, default: True)

Return type:

Any

stylize_func: bool = True
class sshmitm.logger.FailSaveLogStream(debug=False)

Bases: object

Parameters:

debug (bool, default: False)

classmethod activate_format(*, debug=False)
Parameters:

debug (bool, default: False)

Return type:

None

flush()
Return type:

None

write(text)
Parameters:

text (str)

Return type:

None

class sshmitm.logger.PlainJsonFormatter(*args, json_default=None, json_encoder=None, json_serializer=<function dumps>, json_indent=None, json_ensure_ascii=True, **kwargs)

Bases: JsonFormatter

Parameters:
  • json_default (Union[Callable, str, None], default: None)

  • json_encoder (Union[Callable, str, None], default: None)

  • json_serializer (Union[Callable, str], default: <function dumps at 0x7a9ad4e18ca0>)

  • json_indent (Union[int, str, None], default: None)

  • json_ensure_ascii (bool, default: True)

add_fields(log_record, record, message_dict)

Extract fields from a LogRecord for logging

This method can be overridden to implement custom logic for adding fields.

Args:

log_record: data that will be logged record: the record to extract data from message_dict: dictionary that was logged instead of a message. e.g

logger.info({“is_this_message_dict”: True})

Parameters:
  • log_record (Dict[str, Any])

  • record (LogRecord)

  • message_dict (Dict[str, Any])

Return type:

None

process_log_record(log_record)

Custom processing of the log record.

Child classes can override this method to alter the log record before it is serialized.

Args:

log_record: incoming data

Parameters:

log_record (Dict[str, Any])

Return type:

Dict[str, Any]