duck.contrib.websockets.logging

Logging module for websockets.

Module Contents

Functions

get_django_formatted_log

Returns a log message formatted similarly to Django logs with color support.

get_duck_formatted_log

This returns default duck formatted log with color support.

log_message

Logs a WebSocket message to the console.

API

duck.contrib.websockets.logging.get_django_formatted_log(request: Optional[duck.http.request.HttpRequest] = None, debug_message: Optional[Union[str, List[str]]] = None) → str

Returns a log message formatted similarly to Django logs with color support.

Useful for logging WebSockets messages.

Parameters:

  • request – The HTTP request object. Optional, used for adding more detailed log information.

  • debug_message – A custom debug message or a list of messages to append to the log.

Returns:

The formatted log message with color code.

Return type:

str

duck.contrib.websockets.logging.get_duck_formatted_log(request: Optional[duck.http.request.HttpRequest] = None, debug_message: Optional[Union[str, List[str]]] = None) → str

This returns default duck formatted log with color support.

Useful for logging WebSockets messages.

Parameters:

  • request – The http request object.

  • debug_message – Custom debug message or a list of messages to add to log.

duck.contrib.websockets.logging.log_message(request: Optional[duck.http.request.HttpRequest] = None, debug_message: Optional[Union[str, List[str]]] = None) → None

Logs a WebSocket message to the console.

Parameters:

  • request – The http request object.

  • debug_message – Custom message or list of messages to display.