Logging

[StefanGreve]

Preamble

With logging users are able to investigate error messages for long running tasks more easily.

Requirements

Use the built-in logging module to implement LogHandler class and initialize the logger with a default level of 50. If possible, use the builder-pattern to expose log handler (e.g. for seamless RichHandler integration). The log file location should be determined by the function below:

def get_resource_dir() -> Path:
    """
    Return a platform-specific resource directory for storing globally
    accessible package files.
    """
    parent = None
    
    match platform.system():
        case "Windows":
            parent = Path(os.path.expandvars('%LOCALAPPDATA%'))
        case "Darwin":
            parent = Path.home().joinpath("Library").joinpath("Application Support")
        case _:
            # Assume Unix-like file system
            parent = Path.home().joinpath(".config")
    
    return parent.joinpath(package_name)

Remarks

• Python's log levels are documented here: https://docs.python.org/3/library/logging.html#logging-levels
• The logging feature should be opt-in
• No PII should be logged at any point in time

Planning

Scheduled for milestone 1.0.0.

[YisusChrist]

There is a module called platformdirs that currently achieves the same result with more control and in a more standard approach i.e. using the XDG environment variables in Unix systems.

You should take a look at this, I'm sure it will fit perfectly for the functionality you are trying to implement (cross-platform support is great and I highly defend it) and it will save you valuable time.

[StefanGreve]

Thank you for the suggestion. When I get to this feature, I will take a closer look into this module. As it currently stands, I only need the location of the local app data path (and its equivalents on MacOS and Linux), which is why I am hesitant to add another library as a dependency, but if I find myself in a position where I need to access more than one folder on different platforms, using platformdirs certainly would become a reasonable choice.

[StefanGreve]

Closed by #34.

Let's just go with the simple function for now, if this becomes problematic switching to platformdirs later should pose no problem.