aequilibrae.log

Functions

get_log_handler(log_file[, ensure_file_exists])

Return a log handler that writes to the given log_file

Classes

Log(project_base_path)

API entry point to the log file contents

class aequilibrae.log.Log(project_base_path: Path)

API entry point to the log file contents

>>> project = Project()
>>> project.new(project_path)

>>> log = project.log()

# We get all entries for the log file
>>> entries = log.contents()

# Or clear everything (NO UN-DOs)
>>> log.clear()

>>> project.close()

clear()

Clears the log file. Use it wisely

contents() → list

Returns contents of log file

Returns:

log_contents (list): List with all entries in the log file

aequilibrae.log.get_log_handler(log_file: Path, ensure_file_exists=True)

Return a log handler that writes to the given log_file