pyloggor 1.2

An incredibly versatile yet simple logging system.

The easiest and perhaps the most versatile logger for python, in hundred lines.

Table of Contents

• Installation
• Usage
• Config
• Appendix

Installation

---

As simple as pip install pyloggor!

Usage

---

1. Once installed, you can access the logger class by importing it like so: from pyloggor import pyloggor
2. Instantize the class using: myLogger = pyloggor()
3. Log something! myLogger.log(level="ERROR", msg="JSON config is corrupt.")

Config

---

Standard

1. Standard Format. This currently does not support customizing the base format, however you CAN pass in extra variables per log, which gets added at the end of the standard format string.

   • Standard Format: [P] DATE_TIME LEVEL FILE TOPIC MSG EXTRAS

2. Level.

   • The default level hierarchy is: DEBUG -> INFO -> WARNING -> ERROR -> CRITICAL.
     • This means that if the level is WARNING, it will log all WARNINGs, ERRORs, and CRITICALs but not DEBUG and INFO messages.
   • You can pass in a custom level as well, which will not effect the level hierarchy and always print as well as log to file.

3. Colouring.

   • While passing in default or level_colours config, please pass it in the form of level_colours={"LEVEL": "[VALID_COLOUR]"}
   • Here, VALID_COLOUR can be any of colours listed here, additionaly, you can prefix them with bold to make them bold.

Initialization

1. file_output_level, console_output_level: Different levels for file and console output!

   • pyloggor(file_output_level="DEBUG", console_output_level="ERROR")
   • This will write ALL logs to file but only print ERRORs and CRITICALs to the console.
   • Both default to DEBUG.

2. fn: The file it will output to, leave empty if it should not output to file.

   • Pass in the file name, or the literal file location- it will create the file if it doens't exist.
   • Defaults to None.

3. console_output: Set this to False if you do not want it to print logs to the console. Defaults to True.

4. topic_adjustment_space, file_adjustment_space, level_adjustment_space:

   • The loggor automatically adds whitespace to the end of topics, file names and levels (passed during logging) to make the output appear more... beautiful, as seen below
   • Input as 0 for no adjustment space

5. level_align, topic_align, file_align:

   • Can be one of left, center, centre, right, all default to left.
   • Alignment of the text when it's wrapped with whitespace due to (4)

6. level_colours: Defines the colour the log message is printed in.

   • Pass in a dict structure like so:

      {
      	"DEBUG": "[bold blue]",
      	"INFO": "[bold green]",
      	"WARNING": "[bold yellow]",
      	"ERROR": "[bold red]",
      	"CRITICAL": "[bold red]"
      }
     

   • Colour names should be rich compliant.
   • If no colour is set, it defaults to above mentioned, and if custom level is used, defaults to [bold white]

7. level_symbols: Each log level has a level system at the start of the log entry.

   • Pass in a dict structure like so:

      {
      	"DEBUG": "D",
      	"INFO": "I",
      	"WARNING": "W",
      	"ERROR": "E",
      	"CRITICAL": "C"
      }
     

   • Defaults to above mentioned and to * for all else
   • This will get printed as [D] at the start of all log entries.
   • Check below for a visual example.

8. delim: Each field is separated by this deliminator, defaults to | (it gets wrapped with a space on each side).

9. datefmt: The datetime format in which the output is logged, defaults to "%d-%b-%y, %H:%M:%S:%f" It appears something like this: 01-Oct-22, 10:35:21:300273

Usage

1. level: Defaults to DEBUG
2. topic: The topic of the log entry, defaults to "None"
3. file: The file in which the log entry was done, useful for debugging! Defaults to "NoFile"
4. msg: The actual log message. I have no idea why people do this but it defaults to "NoMessage"
5. extras: A dict, of extras, which are printed beautifully.
6. console_output: boolean, defaults to logger default. Useful if you want to override logger default to print or not to print.
7. file_output: boolean, defaults to logger default. Same usecase as (6).

• You can also use set_level() to change the default logging level of the logger instance.
  • You an pass in file_output_level and console_output_level, both of which default to logger default if not passed.

from pyloggor import pyloggor

logger = pyloggor(fn="log.txt")

logger.log(level="debug", msg="DEBUG", topic="Internal", file="utils/internal.py")
logger.log(level="info", msg="This is an info message", topic="Info", file="info.py", file_output=False)
logger.log(level="warning", msg="Something is not right here.", topic="Listener", extras={"clientOid": "1c7c36d3464f11edb212b89a2a091df6", "clientName": "Joe"})
logger.log(level="error", msg="I caught an error.", topic="Error Handling", file="eh.py")
logger.log(level="critical", msg="Unhandled exception.", topic="MAIN", file="main.py", console_output=False)
logger.log(level="custom", msg="This is custom", topic="customized", file="test/custom.py")

Appendix

---

Find this incomplete? Create an issue! Just check mi main profile and my site, leave a star if ye liked this!