Skip to main content

Log Message

Description​

Logs message.

Function Signature:​

def log_message(base_folder_path: str, log_name: str, message: str, rotate_on_start: bool = False, prepend_datetime: bool = False) -> None:

Parameters​

  • base_folder_path (str): Input value for base_folder_path.
  • log_name (str): Input value for log_name.
  • message (str): Input value for message.
  • rotate_on_start (bool): Input value for rotate_on_start.
  • prepend_datetime (bool): Input value for prepend_datetime.

Returns​

  • None: The function does not return a value.

Example Usage​

# Example usage
base_folder_path = "example"
log_name = "example"
message = "example"
rotate_on_start = False
prepend_datetime = False
result = log_message(base_folder_path, log_name, message, rotate_on_start, prepend_datetime)
print(result)

Behavior​

  • Executes the function logic with the provided arguments.
  • On success, returns the computed value or result object.

Error Handling​

  • Exceptions are handled within the function where implemented.