bittensor.utils.btlogging

btlogging sub-package standardized logging for Bittensor.

This module provides logging functionality for the Bittensor package. It includes custom loggers, handlers, and formatters to ensure consistent logging throughout the project.

Submodules

• bittensor.utils.btlogging.console
• bittensor.utils.btlogging.defines
• bittensor.utils.btlogging.format
• bittensor.utils.btlogging.helpers
• bittensor.utils.btlogging.loggingmachine

Attributes

logging

Classes

LoggingMachine

Handles logger states for bittensor and 3rd party libraries.

Package Contents

class bittensor.utils.btlogging.LoggingMachine(config, name=BITTENSOR_LOGGER_NAME)

Bases: statemachine.StateMachine, logging.Logger

Handles logger states for bittensor and 3rd party libraries.

Initialize the logger with a name and an optional level.

Parameters:

• config (bittensor.core.config.Config)

• name (str)

Debug

Default

Disabled

Info

Trace

Warning

__call__(config=None, debug=None, trace=None, info=None, record_log=None, logging_dir=None)

Parameters:

• config (bittensor.core.config.Config)

• debug (bool)

• trace (bool)

• info (bool)

• record_log (bool)

• logging_dir (str)

property __trace_on__: bool

Checks if the current state is in “Trace” mode.

Returns:

True if the current state is “Trace”, otherwise False.

Return type:

bool

_config

_configure_handlers(config)

Return type:

list[logging.Handler]

_create_and_start_listener(handlers)

A listener to receive and publish log records.

This listener receives records from a queue populated by the main bittensor logger, as well as 3rd party loggers

_create_file_handler(logfile)

Parameters:

logfile (str)

_deinitialize_bt_logger(name)

Find the logger by name and remove the queue handler associated with it.

Parameters:

name (str)

_enable_file_logging(logfile)

Parameters:

logfile (str)

_enable_initial_state(config)

Set correct state action on initializing

_extract_logging_config(config)

Extract btlogging’s config from bittensor config

Parameters:

config (bittensor.core.config.Config) – Bittensor config instance.

Returns:

btlogging’s config from Bittensor config or Bittensor config.

Return type:

(dict)

_file_formatter

_handlers

_initialize_bt_logger(name)

Initialize logging for bittensor.

Since the initial state is Default, logging level for the module logger is INFO, and all third-party loggers are silenced. Subsequent state transitions will handle all logger outputs.

Parameters:

name (str)

_listener

_logger

_primary_loggers

_queue

_stream_formatter

classmethod add_args(parser, prefix=None)

Accept specific arguments fro parser

Parameters:

• parser (argparse.ArgumentParser)

• prefix (str)

after_disable_debug()

Logs status after disable Debug.

after_disable_trace()

Logs status after disable Trace.

after_enable_debug()

Logs status after enable Debug.

after_enable_default()

after_enable_info()

Logs status after enable info.

after_enable_trace()

Logs status after enable Trace.

after_enable_warning()

Logs status after enable Warning.

after_transition(event, state)

Starts listener after transition.

before_disable_debug()

Logs status before disable Debug.

before_disable_logging()

Prepares the logging system for disabling.

This method performs the following actions: 1. Logs an informational message indicating that logging is being disabled. 2. Disables trace mode in the stream formatter. 3. Sets the logging level to CRITICAL for all loggers.

This ensures that only critical messages will be logged after this method is called.

before_disable_trace()

Logs status before disable Trace.

before_enable_console()

Logs status before enable Console.

before_enable_debug()

Logs status before enable Debug.

before_enable_default()

Logs status before enable Default.

before_enable_info()

Logs status before enable info.

before_enable_trace()

Logs status before enable Trace.

before_enable_warning()

Logs status before enable Warning.

before_transition(event, state)

Stops listener after transition.

check_config(config)

Parameters:

config (bittensor.core.config.Config)

classmethod config()

Get config from the argument parser.

Returns:

config object

Return type:

config (bittensor.core.config.Config)

console

critical(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps critical message with prefix and suffix.

debug(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps debug message with prefix and suffix.

deregister_primary_logger(name)

De-registers a primary logger

This function removes the logger from the _primary_loggers set and deinitializes its queue handler

Parameters:

name (str) – the name of primary logger.

disable_debug

disable_info

disable_logging

disable_third_party_loggers()

Disables logging for third-party loggers by removing all their handlers.

disable_trace

disable_warning

enable_console

enable_debug

enable_default

enable_info

enable_third_party_loggers()

Enables logging for third-party loggers by adding a queue handler to each.

enable_trace

enable_warning

error(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps error message with prefix and suffix.

exception(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps exception message with prefix and suffix.

get_config()

get_level()

Returns Logging level.

Return type:

int

get_queue()

Get the queue the QueueListener is publishing from.

To set up logging in a separate process, a QueueHandler must be added to all the desired loggers.

help()

info(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps info message with prefix and suffix.

off()

Disables all states.

on()

Enable default state.

register_primary_logger(name)

Register a logger as primary logger

This adds a logger to the _primary_loggers set to ensure it doesn’t get disabled when disabling third-party loggers. A queue handler is also associated with it.

Parameters:

name (str) – the name for primary logger.

set_config(config)

Set config after initialization, if desired.

Parameters:

config (bittensor.core.config.Config) – Bittensor config instance.

set_console()

Sets Console state.

set_debug(on=True)

Sets Debug state.

Parameters:

on (bool)

set_default()

Sets Default state.

set_info(on=True)

Sets Info state.

Parameters:

on (bool)

set_trace(on=True)

Sets Trace state.

Parameters:

on (bool)

set_warning(on=True)

Sets Warning state.

Parameters:

on (bool)

success(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps success message with prefix and suffix.

trace(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps trace message with prefix and suffix.

warning(msg='', prefix='', suffix='', *args, stacklevel=1, **kwargs)

Wraps warning message with prefix and suffix.

bittensor.utils.btlogging.logging