spy_log Module

The Spyral logging system.

get_spyral_logger(module)

Get the spyral logger for this process,

The logger is decorated with the module name from which it is being called, allowing for easier tracing of errors.

Do not call this directly, prefer one of the spyral_* log functions

Parameters:

Name	Type	Description	Default
module	str	The module name from which the logger is called	required

Returns:

Type	Description
Logger	The Logger

Source code in src/spyral/core/spy_log.py

def get_spyral_logger(module: str) -> logging.Logger:
    """Get the spyral logger for this process,

    The logger is decorated with the module name from which it is being called,
    allowing for easier tracing of errors.

    Do not call this directly, prefer one of the spyral_* log functions

    Parameters
    ----------
    module: str
        The module name from which the logger is called

    Returns
    -------
    logging.Logger
        The Logger

    """
    return logging.getLogger(module)

init_spyral_logger_child(workspace_path, process_id)

Setup the spyral logging system for a child process.

Should only be called once at the start of each child process.

This will create a log file in the log/ directory of the workspace, where the name indicates which child process is logging to it. All stdout messages are then written to this log file. Each process gets its own log to avoid any need for synchronization.

Parameters:

Name	Type	Description	Default
workspace_path	Path	The project workspace path	required
process_id	int	The process id used to name the log file	required

Source code in src/spyral/core/spy_log.py

def init_spyral_logger_child(workspace_path: Path, process_id: int):
    """Setup the spyral logging system for a child process.

    Should only be called *once* at the start of each child process.

    This will create a log file in the log/ directory of the workspace,
    where the name indicates which child process is logging to it. All stdout messages are then written to
    this log file. Each process gets its own log to avoid any need for synchronization.

    Parameters
    ----------
    workspace_path: pathlib.Path
        The project workspace path
    process_id: int
        The process id used to name the log file
    """
    log_path = workspace_path / LOG_DIR
    if not log_path.exists():
        raise ValueError("You forgot to call init_spyral_logger_parent()!")
    logger = logging.getLogger(ROOT_LOGGER)
    fmt = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
    fh = logging.FileHandler(log_path / f"log_proc{process_id}.txt", mode="w")
    fh.setFormatter(fmt)
    fh.setLevel(logging.INFO)
    logger.setLevel(logging.INFO)
    logger.addHandler(fh)

init_spyral_logger_parent(workspace_path)

Setup the Spyral logger for the parent process

Should only be used by the parent process

Parameters:

Name	Type	Description	Default
workspace_path	Path	The project workspace path	required

Source code in src/spyral/core/spy_log.py

def init_spyral_logger_parent(workspace_path: Path):
    """Setup the Spyral logger for the parent process

    Should only be used by the parent process

    Parameters
    ----------
    workspace_path: pathlib.Path
        The project workspace path
    """
    log_path = workspace_path / LOG_DIR
    if not log_path.exists():
        log_path.mkdir()
    logger = logging.getLogger(ROOT_LOGGER)
    fmt = logging.Formatter("%(asctime)s - %(name)s - %(levelname)s - %(message)s")
    fh = logging.FileHandler(log_path / "log_procParent.txt", mode="w")
    fh.setFormatter(fmt)
    fh.setLevel(logging.INFO)
    logger.setLevel(logging.INFO)
    logger.addHandler(fh)

spyral_debug(module, message)

Log a debug message

Use like

spyral_debug(__name__, "Here's some debug info")

The magic __name__ variable will be the module name

Parameters:

Name	Type	Description	Default
module	str	The module from which the logger was called	required
message	str	The log message	required

Source code in src/spyral/core/spy_log.py

def spyral_debug(module: str, message: str):
    """Log a debug message

    Use like

    ```python
    spyral_debug(__name__, "Here's some debug info")
    ```
    The magic `__name__` variable will be the module name

    Parameters
    ----------
    module: str
        The module from which the logger was called
    message: str
        The log message
    """
    logger = get_spyral_logger(module)
    logger.debug(message)

spyral_error(module, message)

Log an error

Use like

spyral_error(__name__, "There was an error")

The magic __name__ variable will be the module name

Parameters:

Name	Type	Description	Default
module	str	The module from which the logger was called	required
message	str	The log message	required

Source code in src/spyral/core/spy_log.py

def spyral_error(module: str, message: str):
    """Log an error

    Use like

    ```python
    spyral_error(__name__, "There was an error")
    ```
    The magic `__name__` variable will be the module name

    Parameters
    ----------
    module: str
        The module from which the logger was called
    message: str
        The log message
    """
    logger = get_spyral_logger(module)
    logger.error(message)

spyral_except(module, exception)

Log an exception

Use like

try:
    ...
except Exception as e
    spyral_except(__name__, e)

The magic __name__ variable will be the module name

Parameters:

Name	Type	Description	Default
module	str	The module from which the logger was called	required
exception	Exception	The exception to be logged	required

Source code in src/spyral/core/spy_log.py

def spyral_except(module: str, exception: Exception):
    """Log an exception

    Use like

    ```python
    try:
        ...
    except Exception as e
        spyral_except(__name__, e)
    ```
    The magic `__name__` variable will be the module name

    Parameters
    ----------
    module: str
        The module from which the logger was called
    exception: Exception
        The exception to be logged
    """
    logger = get_spyral_logger(module)
    logger.exception(exception)

spyral_info(module, message)

Log some info

Use like

spyral_info(__name__, "Here's some info")

The magic __name__ variable will be the module name

Parameters:

Name	Type	Description	Default
module	str	The module from which the logger was called	required
message	str	The log message	required

Source code in src/spyral/core/spy_log.py

def spyral_info(module: str, message: str):
    """Log some info

    Use like

    ```python
    spyral_info(__name__, "Here's some info")
    ```
    The magic `__name__` variable will be the module name

    Parameters
    ----------
    module: str
        The module from which the logger was called
    message: str
        The log message
    """
    logger = get_spyral_logger(module)
    logger.info(message)

spyral_warn(module, message)

Log a warning

Use like

spyral_warn(__name__, "There was a warning")

The magic __name__ variable will be the module name

Parameters:

Name	Type	Description	Default
module	str	The module from which the logger was called	required
message	str	The log message	required

Source code in src/spyral/core/spy_log.py

def spyral_warn(module: str, message: str):
    """Log a warning

    Use like

    ```python
    spyral_warn(__name__, "There was a warning")
    ```
    The magic `__name__` variable will be the module name

    Parameters
    ----------
    module: str
        The module from which the logger was called
    message: str
        The log message
    """
    logger = get_spyral_logger(module)
    logger.warn(message)