EthDefiRichHandler

Documentation for eth_defi.coloured_logging.EthDefiRichHandler Python class.

class EthDefiRichHandler

Bases: rich.logging.RichHandler

Rich log handler that preserves eth_defi’s module/thread fields.

Initializes the instance - basically setting the formatter to None and the filter list to empty.

Attributes summary

KEYWORDS
name

Methods summary

__init__(*args[, show_context, colour_threads])	Initializes the instance - basically setting the formatter to None and the filter list to empty.
acquire()	Acquire the I/O thread lock.
addFilter(filter)	Add the specified filter to this handler.
close()	Tidy up any resources used by the handler.
createLock()	Acquire a thread lock for serializing access to the underlying I/O.
emit(record)	Invoked by logging.
filter(record)	Determine if a record is loggable by consulting all the filters.
flush()	Ensure all logging output has been flushed.
format(record)	Format the specified record.
get_level_text(record)	Get the level name from the record.
get_name()
get_thread_style(thread_name)	Get a stable Rich style for a thread name.
handle(record)	Conditionally emit the specified logging record.
handleError(record)	Handle errors which occur during an emit() call.
release()	Release the I/O thread lock.
removeFilter(filter)	Remove the specified filter from this handler.
render(*, record, traceback, message_renderable)	Render log for display.
render_message(record, message)	Render log message with module and thread context.
setFormatter(fmt)	Set the formatter for this handler.
setLevel(level)	Set the logging level of this handler.
set_name(name)

__init__(*args, show_context=True, colour_threads=False, **kwargs)

Initializes the instance - basically setting the formatter to None and the filter list to empty.

Parameters

• args (Any) –

• show_context (bool) –

• colour_threads (bool) –

• kwargs (Any) –

Return type

None

get_thread_style(thread_name)

Get a stable Rich style for a thread name.

Parameters

thread_name (str) –

Return type

str

render_message(record, message)

Render log message with module and thread context.

Parameters

• record (logging.LogRecord) –

• message (str) –

Return type

rich.text.Text

HIGHLIGHTER_CLASS

alias of rich.highlighter.ReprHighlighter

acquire()

Acquire the I/O thread lock.

addFilter(filter)

Add the specified filter to this handler.

close()

Tidy up any resources used by the handler.

This version removes the handler from an internal map of handlers, _handlers, which is used for handler lookup by name. Subclasses should ensure that this gets called from overridden close() methods.

createLock()

Acquire a thread lock for serializing access to the underlying I/O.

emit(record)

Invoked by logging.

Parameters

record (logging.LogRecord) –

Return type

None

filter(record)

Determine if a record is loggable by consulting all the filters.

The default is to allow the record to be logged; any filter can veto this by returning a false value. If a filter attached to a handler returns a log record instance, then that instance is used in place of the original log record in any further processing of the event by that handler. If a filter returns any other true value, the original log record is used in any further processing of the event by that handler.

If none of the filters return false values, this method returns a log record. If any of the filters return a false value, this method returns a false value.

Changed in version 3.2: Allow filters to be just callables.

Changed in version 3.12: Allow filters to return a LogRecord instead of modifying it in place.

flush()

Ensure all logging output has been flushed.

This version does nothing and is intended to be implemented by subclasses.

format(record)

Format the specified record.

If a formatter is set, use it. Otherwise, use the default formatter for the module.

get_level_text(record)

Get the level name from the record.

Args:

record (LogRecord): LogRecord instance.

Returns:

Text: A tuple of the style and level name.

Parameters

record (logging.LogRecord) –

Return type

rich.text.Text

handle(record)

Conditionally emit the specified logging record.

Emission depends on filters which may have been added to the handler. Wrap the actual emission of the record with acquisition/release of the I/O thread lock.

Returns an instance of the log record that was emitted if it passed all filters, otherwise a false value is returned.

handleError(record)

Handle errors which occur during an emit() call.

This method should be called from handlers when an exception is encountered during an emit() call. If raiseExceptions is false, exceptions get silently ignored. This is what is mostly wanted for a logging system - most users will not care about errors in the logging system, they are more interested in application errors. You could, however, replace this with a custom handler if you wish. The record which was being processed is passed in to this method.

release()

Release the I/O thread lock.

removeFilter(filter)

Remove the specified filter from this handler.

render(*, record, traceback, message_renderable)

Render log for display.

Args:

record (LogRecord): logging Record. traceback (Optional[Traceback]): Traceback instance or None for no Traceback. message_renderable (ConsoleRenderable): Renderable (typically Text) containing log message contents.

Returns:

ConsoleRenderable: Renderable to display log.

Parameters

• record (logging.LogRecord) –

• traceback (Optional[rich.traceback.Traceback]) –

• message_renderable (rich.console.ConsoleRenderable) –

Return type

rich.console.ConsoleRenderable

setFormatter(fmt)

Set the formatter for this handler.

setLevel(level)

Set the logging level of this handler. level must be an int or a str.