Skip to main content

A pretty and colorful logger to emulate nest.js's logger

Project description

Pretty Logger

Description

This is python package has been developed to emulate the nest.js integrated logger. It allows for colorful terminal logs as well as activating or deactivating debug/warn or error print statements.

Install

pip install pretty-logger

In-code usage

To use it, create an instance of the Logger class within the class you wish to have this logger run for and give it the class's name. Once you have an object for the logger, replace all instances of your print statements to the new object. Now you will be able to decide if that print statement should be of type: log, debug, or error.

Example:

The code before:

class TestClass:
    def __init__(self):
        print('Object created')

    def something(self, number: str) -> int:
        print('We are here')
        
        try:
            return int(number)
        except ValueError as e:
            print(e)
            
            return 0

The updated code:

from pretty_logger import Logger

class TestClass:
    logger: Logger
    
    def __init__(self):
        self.logger = Logger('TestClass')
        self.logger.log('Object created')

    def something(self, number: str) -> int:
        self.logger.debug('We are here')
        
        try:
            return int(number)
        except ValueError as e:
            self.logger.error(e)
            
            return 0

Running a program which has a Pretty Logger

After the pretty logger has been implemented, you can use the following flags when launching your python script to activate the various logs:

  • --pretty-debug: Allows for displaying debug/warn logs
  • --pretty-error: Allows for displaying error logs
  • --pretty-none: Disables all logs for script

Example:

This will run the script main.py with all the possible loggers:

python main.py --pretty-debug --pretty-error

Buy me a coffee

If you wish to offer me a coffee, please buy yourself one instead and cheer in my name xD

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kayer-pretty-logger-1.0.2.tar.gz (3.1 kB view hashes)

Uploaded Source

Built Distribution

kayer_pretty_logger-1.0.2-py3-none-any.whl (3.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page