Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 4.12 KB

readme.md

File metadata and controls

112 lines (78 loc) · 4.12 KB
Raw

Gamu Logger - Python Version

📚 Table of Contents

🔨 Installation

The package is available in the assets of the latest release on pypi.

You can install it with pip(recommended):

pip install gamuLogger

Or from github:

pip install https://github.com/GamuNetwork/logger/releases/download/2.0.0/gamu_logger-2.0.0-py3-none-any.whl

note: replace 2.0.0 with the version number you want to install.

💡 Usage

  • First you need to import the package: 
    from gamuLogger import deepDebug, debug, info, warning, error, critical, Logger, LEVELS, SENSITIVE_LEVELS

note: you can also only import the members you need instead of importing all of them.

  • Then you can use the functions like this: 
    info('This is an info message')
warning('This is a warning message')
error('This is an error message')

You may note that the logging function are also available as static methods in the Logger class. This allow you to have them encapsulated in a class and use them in a more object > oriented way:

from gamuLogger import Logger

Logger.info('This is an info message')
Logger.warning('This is a warning message')
Logger.error('This is an error message')

⚙️ Configuration

1. Basic Configuration

You can configure the logger using methods of the Logger class. Here is an example of how you can do it:

from gamuLogger import Logger, LEVELS, SENSITIVE_LEVELS

# default target is the standard output, name is 'stdout'

Logger.setLevel("stdout", LEVELS.INFO); # this mean yhat all logs with level less than INFO will be ignored

Logger.setSensitiveLevel("stdout", SENSITIVE_LEVELS.HIDE); # If a log message contains sensitive data, it will be hidden

Logger.addSensitiveData('myPasswordSecret'); # add 'myPasswordSecret' to the list of sensitive data (if a log message contains any of them, it will be hidden according to the sensitive level)

Logger.setModule('my-module'); # set the module name for this file to 'my-module' (this will be displayed in the log message) (by default, no module name is set)

Logger.addTarget("data.log", LEVELS.DEBUG, SENSITIVE_LEVELS.HIDE) # add a new target to the logger (this will log all messages with level less than DEBUG to the file 'data.log' and hide sensitive data if any)

Please note that the logger can be used without any manual configuration. The default configuration is:

  • target: terminal
    • level: INFO
    • sensitive mode: HIDE
  • sensitive data: []
  • module name: None

Note that the module name is set only for the current file. If you want to set the module name for all files, you need to set it in each file.

2. Configuration with argparse

This module is compatible with argparse, and contains confugurations methods for the argument parser:

from gamuLogger import Logger
import argparse

parser = argparse.ArgumentParser()
Logger.configArgParse(parser) # this will add options to the parser, encapsulated in a group named 'Logger configuration'
args = parser.parse_args()
Logger.parseArgs(args) # this will apply the configuration from the arguments to the logger

3. Configuration from a file

3.1. JSON Configuration

3.2. XML Configuration

📁 Examples

you can find examples in the example directory.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.