pyloggor 2.0.0

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": "ANSI_ESCAPE_CODE"}
   • Colours are raw ANSI escape codes, e.g. "\033[1;36m" for bold cyan. pyloggor writes them directly, so any ANSI SGR sequence works.

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 of ANSI escape codes like so:

      {
      	"DEBUG": "\033[1;36m",
      	"INFO": "\033[1;32m",
      	"WARNING": "\033[1;33m",
      	"ERROR": "\033[1;31m",
      	"CRITICAL": "\033[1;35m"
      }
     

   • Values are raw ANSI SGR escape codes.
   • If no colour is set, it defaults to the above, and for a custom level it defaults to bold white (\033[1;37m, configurable via default_colour).

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 (custom levels)
   • 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

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 logging levels of the logger instance at runtime.
  • You can pass in file_output_level and/or console_output_level; either one left unset keeps its current value.
  • e.g. logger.set_level(console_output_level="ERROR")
• Call logger.close() to flush any buffered file logs and stop the background writer (also done automatically on interpreter exit).

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")