Implement loggers

[barneydobson]

          Probably you should implement a proper logger at some point and do somthing like this:

        if ix > 0:
            LOGGER.warning('''a node has multiple successors, 
                not sure how that can happen if using shortest path
                to derive topology''')

Maybe open an issue about it, if not already there.

Originally posted by @dalonsoa in #31 (comment)

[cheginit]

For logging, I highly recommend loguru. I've been using it for many of my packages, since it doesn't have any additional dependency.

I have this function, usually in a utils module:

import os
import sys
import loguru

def get_logger(verbose: bool = False) -> Logger:
    """Get a logger."""
    logger = loguru.logger
    logger.configure(
        handlers=[
            {
                "sink": sys.stdout,
                "colorize": True,
                "format": " | ".join(
                    [
                        "<cyan>{time:YYYY/MM/DD HH:mm:ss}</>",
                        "{message}",
                    ]
                ),
            }
        ]
    )
    if os.getenv("PACKAGE_NAME_VERBOSE", str(verbose)).lower() == "true":
        logger.enable("package_name")
    else:
        logger.disable("package_name")
    return logger

This way, I can easily control the verbosity of the package with an env variable (PACKAGE_NAME_VERBOSE). In the code, whenever I want to use the logger, I just do:

logger = get_logger()
logger.info("This is a log")

By default, the logger is disabled and needs to be enabled explicitly using the env variable like so:

os.environ["PACKAGE_NAME_VERBOSE"] = "true"

It's a simple and clean solution and doesn't interfere with the logging level of other packages.

[dalonsoa]

I would personally use just the standard logger that comes with Python. I've never had the need of another, third party tool, very often just syntactic sugar for the standard logger. It has its drawbacks, of course, but still it is really powerful and, to be honest, it is WIDELY use, so learning to use it properly will help you understand other tools.

Here you have an interesting video on pros, cons and how to use it right: https://www.youtube.com/watch?v=9L77QExPmI0