threedb.result_logging.base_logger

Implements an abstract class for logging results.

class threedb.result_logging.base_logger.BaseLogger(root_dir: str, result_buffer: threedb.utils.CyclicBuffer, config: Optional[Dict[str, Dict[str, Any]]])

Bases: multiprocessing.context.Process, abc.ABC

Abstract class for a Logger, inherits from multiprocessing.Process. Implements the additional functions:

  • enqueue(): put a new item on the logging queue, to be logged ASAP

  • log(): the actual logging mechanism, meant to be overwritten by the user for each unique subclass. This should not be called directly, but rather will be called by run()

  • run(): main loop, waits for logs to be added to the queue, and calls log() on them.

  • end(): Performs cleanup operations for the logger. No-op by default, should

    be overriden with code for closing any open file handles, ports, etc.

__init__(root_dir: str, result_buffer: threedb.utils.CyclicBuffer, config: Optional[Dict[str, Dict[str, Any]]]) → None

Creates a logger instance

Parameters

  • root_dir (str) – The directory in which to write the logging results (should be the same for all loggers, with each logger making a subfolder to log in)

  • result_buffer (CyclicBuffer) – The buffer where the main thread is writing the results

  • config (Optional[Dict[str, Dict[str, Any]]]) – The config file (parsed from YAML) of the 3DB experiment being run

enqueue(item: Dict[str, Any]) → None

Add an item in the queue to be logged.

Parameters

item (Dict[str, Any]) – The item to be logged.

abstract log(item: Dict[str, Any]) → None

Abstract method for logging an item from the buffer

Parameters

item (Dict[str, Any]) – A dictionary containing the results of a single rendering (as returned by threedb.client).

abstract end() → None

Performs cleanup operations for the logger. No-op by default, should be overriden with code for closing any open file handles, ports, etc.

run() → None

Method to be run in sub-process; can be overridden in sub-class