pyplelogger

Simple logger written in python mostly for command line interface tools.

Install

pip install pyplelogger

Usage

Simple usage

This is the atomic usage. Import this and print it out.

from pyplelogger import Logger

log = Logger(__name__).build()
log.info("hogehoge")

INFO 2018-11-26 23:11:15,109 test.py:main in line 4: hogehoge

The default log level is INFO and you have to pass unique name for each handler.

Change default logger level

You can change logger level entire the project.

import logging
from pyplelogger import Logger

Logger.set_default_log_level(logging.WARNING)

log = Logger(__name__).build()
log.info("hogehoge")

#=> Nothing is pritted out

And once you set teh default log level, it is valid in entire project.

The logger levels are defined in logging library.

Let's say you have a script1.py and script2.py.

If you change defaul log level in script1.py like this,

import logging
from pyplelogger import Logger

Logger.set_default_log_level(logging.WARNING)

it is valid in script2.py too.

import logging
from pyplelogger import Logger

log = Logger(__name__).build()
log.info("hogehoge")

#=> Nothing is pritted out

Change logger level

This is similier to changing default log level but this method changes log level for one logger.

Futhermore, the method to change default log level is a class method but, this method is a instance method, so it will only effect the instance.

import logging
from pyplelogger import Logger

log = Logger(__name__).set_log_level(logging.WARNING).build()
log.info("hogehoge")

#=> Nothing is pritted out

Change default format

You can change default format of every instance of Logger by this method. Pass string object describing logging format.

format = '%(levelname)s %(asctime)s %(message)s'
Logger.set_default_format(format)

log = Logger(__name__).build()
log.info("hogehoge")

This will print out this logs.

INFO 2018-11-28 18:11:15,109 hogehoge

Change format

Specify format in string. The default format is '%(levelname)s %(asctime)s %(module)s.py:%(funcName)s in line %(lineno)d: %(message)s'.

from pyplelogger import Logger

log_before = Logger(__name__).build()
log_after = Logger(__name__ + "after").set_format('%(levelname)s %(message)s').build()

log_before.info("before")
log_after.info("after")

Here is the output.

INFO 2018-11-26 23:11:15,109 test.py:main in line 4: before
INFO after

With Argparse

This has good integration with argparse, a library for creating cli tool.

Verbose flag

This is just a simple example of the verbose flag.

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--verbose', '-v', action='count')

args = parser.parse_args()

Now you can get number of v flags like

• -v: 1
• -vvv: 3

You can convert to log level by Using IncrementalLoggerLevel IntEnum Class.

# 1 is debug level

count = 1

log_level = IncrementalLoggerLevel.convert_logger_level(1)

log = Logger().set_log_level(log_level)
log.DEBUG("hoge")

Then you will see

#=> 
DEBUG 2018-11-26 23:11:15,109 test.py:main in line 3: hoge

The default level of logging is INFO in current version.

To contribute

We welcome for your contribution.

1. Fork this project
2. Run just to install dependencies.
3. Give us a pull request

Member

• KeisukeYamashita: Maintainer and creater