Module logging

Basic logging utilities

Functions

log.add_handler (handler) Add a LogHandler that listens for and logs messages
log.basic_config (level, fmt) Add a logger that will log messages to stdout (or to log.txt in AutoTouch)
log.debug (s, ...) Log a DEBUG level message
log.info (s, ...) Log an INFO level message
log.warning (s, ...) Log a WARNING level message
log.error (s, ...) Log an ERROR level message
log.critical (s, ...) Log a CRITICAL level message

Tables

log Callable log object - improved log from AutoTouch

Fields

log.default_format Default log format.
log.default_level Default log level.
log.file_handler LogHandler that logs messages to a file
log.stream_handler LogHandler that logs messages to stdout (or to log.txt in AutoTouch)

Class LogHandler

LogHandler:filter (level) Filter log message based on level
LogHandler:format (level, s, ...) Create formatted log message
LogHandler:record (s) Record the log message to an output.


Functions

log.add_handler (handler)
Add a LogHandler that listens for and logs messages

Parameters:

log.basic_config (level, fmt)
Add a logger that will log messages to stdout (or to log.txt in AutoTouch)

Parameters:

  • level string log level - one of (DEBUG, INFO, WARNING, ERROR, CRITICAL)
  • fmt string log format to use for all messages

Usage:

    -- log like AutoTouch's `log` function
log.basic_config('DEBUG', '%(message)s')
-- log left-padded message with max length of 10
log.basic_config('DEBUG', '%(message)-10s')
-- log current date and time, level and message
log.basic_config('DEBUG', '[ %(datetime)s ] %(level)-8s - %(message)s')
log.debug (s, ...)
Log a DEBUG level message

Parameters:

  • s string log message
  • ... arguments to format string s
log.info (s, ...)
Log an INFO level message

Parameters:

  • s string log message
  • ... arguments to format string s
log.warning (s, ...)
Log a WARNING level message

Parameters:

  • s string log message
  • ... arguments to format string s
log.error (s, ...)
Log an ERROR level message

Parameters:

  • s string log message
  • ... arguments to format string s
log.critical (s, ...)
Log a CRITICAL level message

Parameters:

  • s string log message
  • ... arguments to format string s

Tables

log
Callable log object - improved log from AutoTouch

Usage:

    -- All of the following usages result in the same message:
log('message')
log('%s', 'message')
log('INFO', 'message')
log('INFO', '%s', 'message')
log.info('message')
log.info('%s', 'message')
log.info('%s%s%s%s%s', 'message', '', '', '', '')
--[INFO    ] message

Fields

log.default_format
Default log format. The default format is [%(level)-8s] %(message)s

See also:

log.default_level
Default log level. The default level is INFO. Levels: (DEBUG, INFO, WARNING, ERROR, CRITICAL)
log.file_handler
LogHandler that logs messages to a file
  • options table logging options

    file: name of file to log to
    level: (optional) log level of log handler
    fmt: (optional) log format of log handler
    max_size: (optional) max size in bytes of log file (default is unlimited)
log.stream_handler
LogHandler that logs messages to stdout (or to log.txt in AutoTouch)
  • options table logging options

    level: (optional) log level of log handler
    fmt: (optional) log format of log handler

Class LogHandler

LogHandler object
LogHandler:filter (level)
Filter log message based on level

Parameters:

  • level level to check

Returns:

    boolen is level high enough to log
LogHandler:format (level, s, ...)
Create formatted log message

Parameters:

  • level string level of message
  • s string format string of message
  • ... (optional) arguments for format string s
LogHandler:record (s)
Record the log message to an output. This can be overwritten to send log messages anywhere.

Parameters:

generated by LDoc 1.4.6 Last updated 2018-11-10 22:55:04