Signale.py

Elegant Console Logger For Python Command-Line Apps

---

Installation

Signale.py can be installed using pip.

    [sudo] pip install signalepy

Usage

Package consists of a class Signale, it is the main constructor class. The object created has all the logger functions in it.

Using Loggers

Each logger function takes four arguments:-

• text
• prefix ( Optional )
• suffix ( Optional )
• level ( Optional )

They all are available in the logger object. To create one do this:-

from signalepy import Signale

logger = Signale()

Now you can use the default loggers using this object like:-

...

logger.success("Started Successfully", prefix="Debugger")
logger.warning("`a` function is deprecated", suffix="main.py")
logger.complete("Run Complete")

...

This will produce the following result:-

View All Available Loggers

• simple
• success
• error
• exception (same as error, but also prints a formatted stack backtrace)
• warning (=warn)
• start
• stop
• watch
• important
• pending
• complete
• debug
• xdebug
• pause
• info
• like
• center
• bold
• underline
• reversed
• coloured (=colored)

---

Scoped Loggers

To create scoped loggers, define the scope field in the options argument of constructor like:-

from signalepy import Signale

logger = Signale({
	"scope": "global scope"
})
logger.success("Scoped Logger Works!")

This will produce the following result:-

You also create multiple scopes by setting the scope field to a list of strings like:-

from signalepy import Signale

logger = Signale({
	"scope": ["global scope", "inner scope"]
})
logger.success("Scoped Logger Works!")

This will produce the following result:-

You can also create scoped a logger which is just clone of other by using by using the scoped function like this:-

from signalepy import Signale

logger = Signale({
	"scope": "global scope"
})

logger2 = logger.scoped("inner")
logger2.like("I love Signale.py", prefix="Shardul Nalegave", suffix="Creator")

This will produce the following result:-

Note:- All the configuration will be copied to the new logger just the scope will be extended.

---

Filtering With Levels

All logging output can be filtered based on levels and thresholds. All logging methods have an optional level argument, pre-filled with one of XDEBUG, DEBUG, INFO, WARNING, ERROR, or CRITICAL. For most, the default should be obvious, the others use INFO.

By default, all levels are visible. The threshold of visibility can be raised with the set_threshold(scope, level) module function globally, where scope is the name of a scope, or None (aka GLOBAL_SCOPE). The levels can also be specified as an uppercase string.

Any of the named scopes associated with a logger with a defined threshold will have to be surpassed by the level. If there is no explicit threshold for any named scopes, the GLOBAL_SCOPE will be used.

This means that the threshold of any named scopes can be raised or lowered independent of the global scope's threshold. However, for named scopes with a specified threshold, the lowest threshold of them will be used; i.e., it is not possible to raise the threshold for a sub-scope.

---

Aligning labels

The module supports a function set_align(left, right), which allows for the alignment of scopes and labels. Default are strings " " and ": " for left and right, which will be put before/after the scope and labels. These strings can be set to different strings. Alternatively, they can be changed to numbers, to specify the width of the respective fields. Care should be taken that the numbers are chosen large enough to make things aligned.

---

Custom Loggers

Custom loggers can be created by passing a array of custom logger configuration to the field custom in the options passed to the constructor. Even clone loggers inherit the parent's custom loggers. For example:-

from signalepy import Signale

logger = Signale({
	"scope": "global scope",
	"custom": [
		{
			"badge": "!",
			"label": "Attention",
			"color": "red",
			"name": "attention"
		}
	]
})

logger2 = logger.scoped("inner")

logger.attention("It Works!")
logger2.attention("With Logger2")

This will produce the following result:-

---

Underlined Labels

You can set labels to be underlined by setting the underlined field to True in the options passed to the constructor. For example:-

from signalepy import Signale

s = Signale({
	"underlined": True
})
s.center("Testing Logger")
s.simple("ABC", prefix="Debugger", suffix="xyz")
s.info("Starting", prefix="Debugger")
s.success("Started Successfully", prefix="Debugger", suffix="xyz")
s.watch("Watching All Files", prefix="Debugger")
s.error("Something Went Wrong", prefix="Debugger")
s.warning("Deprecation Warning", prefix="Debugger")
s.pending("Postponed", prefix="Debugger")
s.debug("Found A Bug on L55", prefix="Debugger")
s.start("Started New Process", prefix="Debugger")
s.pause("Process Paused", prefix="Debugger")
s.complete("Task Completed", prefix="Debugger")
s.important("New Update Available. Please Update!", prefix="Debugger")
s.like("I Love Signale", prefix="Debugger")
s.stop("Stopping", prefix="Debugger")

This will produce the following result:-

---

Options

Options taken by constructor

1. scope

   
   
   • Type: str or list

   Signale Logger Scope

   
   
   

2. underlined

   
   
   • Type: bool

   Labels Should Be Underlined Or Not

3. ansi

   
   
   • Type: bool or None

   Whether To Use ANSI Sequences. None will autodetect whether stdout is a TTY and only use color there.

4. custom

   
   
   • Type: list

   List of custom logger configuration.

   • Configuration Type: dict

     Custom Logger Configuration Dictionary

     • Keys

       1. name

          • Type: str

          Name of the logger

       2. label

          • Type: str

          Label displayed beside the icon ( colored text )

       3. badge

          • Type: str

          Icon

       4. color

          • Type: str

          Color of the icon and label. Should be from:-

          • red
          • dark
          • blue
          • pink
          • green
          • grey
          • purple
          • yellow
          • cyan
          • reset (color reset code)

   
   
   

---

API

1. logger = Signale(<options>)

   
   

   Signale

   • Type: class

   Signale class imported from signalepy module

   
   

   options

   • Type: dict

   Options Dictionary for logger.

   
   
   • Returns: Signale Logger Object

   Logger object which can be used for logging

   
   
   

2. logger.<logger>(message="", prefix="", suffix="")

   
   

   logger

   • Type: function

   Can be any default logger

   
   

   message

   • Type: str

   Message to be displayed

   
   

   prefix

   • Type: str
   • Required: False

   Prefix text

   
   

   suffix

   • Type: str
   • Required: False

   Suffix text

   
   
   • Returns: None

   
   
   

3. logger2 = logger.scoped(<new scope>)

   
   

   logger

   • Type: Signale Logger Object

   Parent Logger

   
   

   new scope

   • Type: str

   New Scope Name

   
   
   • Returns: Signale Logger Object

   Clone Logger object with extended scope