Logging - vcspull.log

Log utilities for formatting CLI output in vcspull.

This module containers special formatters for processing the additional context information from libvcs.base.RepoLoggingAdapter.

Colorized formatters for generic logging inside the application is also provided.

vcspull.log.get_cli_logger_names(include_self=True)

function

Return logger names under vcspull.cli.

Parameters:

include_self (bool)

Return type:

list[str]

vcspull.log.setup_logger(log=None, level='INFO')

function

Configure the vcspull logging hierarchy once and reuse it everywhere.

Parameters:

• log (Logger | None)

• level (Literal['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'])

Return type:

None

class vcspull.log.LogFormatter

class

Bases: Formatter

Log formatting for vcspull.

template(record)

method

Return the prefix for the log message. Template for Formatter.

Parameters:

record (logging.LogRecord) – Passed in from inside the logging.Formatter.format() record.

Return type:

str

__init__(color=True, **kwargs)

method

Initialize the formatter with specified format strings.

Initialize the formatter either with the specified format string, or a default as described above. Allow for specialized date formatting with the optional datefmt argument. If datefmt is omitted, you get an ISO8601-like (or RFC 3339-like) format.

Use a style parameter of ‘%’, ‘{’ or ‘$’ to specify that you want to use one of %-formatting, str.format() ({}) formatting or string.Template formatting in your format string.

Changed in version 3.2: Added the style parameter.

Parameters:

• color (bool)

• kwargs (Any)

Return type:

None

format(record)

method

Format log record.

Parameters:

record (LogRecord)

Return type:

str

class vcspull.log.DebugLogFormatter

class

Bases: LogFormatter

Provides greater technical details than standard log Formatter.

template(record)

method

Return the prefix for the log message. Template for Formatter.

Parameters:

record (logging.LogRecord) – Passed from inside the logging.Formatter.format() record.

Return type:

str

class vcspull.log.RepoLogFormatter

class

Bases: LogFormatter

Log message for VCS repository.

template(record)

method

Template for logging vcs bin name, along with a contextual hint.

Parameters:

record (LogRecord)

Return type:

str

class vcspull.log.SimpleLogFormatter

class

Bases: Formatter

Simple formatter that outputs only the message, like print().

format(record)

method

Format log record to just return the message.

Parameters:

record (LogRecord)

Return type:

str

class vcspull.log.RepoFilter

class

Bases: Filter

Only include repo logs for this type of record.

filter(record)

method

Only return a record if a keyword object.

Parameters:

record (LogRecord)

Return type:

bool