Skip to content

saner99/ctprint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Hi there! Here a Color-Tagged Print

Cross-platform colorization terminal text using '<tags> embedded in strings' (text markup)

Installation

pip install ctprint

or

poetry add ctprint

Usage

Initialization

from ctprint import ctp, ctdecode, cterr, ctlog  # callable

ctp.help() -> None

print colored and some interactive help-message. nothing return

ctp.help()  # print help message

ctp(*strings: str) -> None

obj of ctprint. decode <tags> in the strings and print it. nothing return

# decode <tags> and then print the string
ctp('<bw> black text on white background /> default formating')

ctdecode( *strings: str) -> str

decode <tags> in the strings and return it decoded

# decode <tags> in the strings and return decoded string
string0 = ' background /> default'
string1 = ' formating'
ctdecode('<bw> black text on white', string0, string1)

return string

cterr(exception=None, comment='') -> None

exception required. print colored error message from try/except. nothing return

try:
    1/0  # any broken line
except Exception as _ex:
    cterr(_ex)

ctlog(**vars) -> None

vars required. print colored message with names $ values of all **vars. nothibg return

var0 = var1 = 0

def example_ctlog():

    var2 = 'string val'
    var3 = {'ctp_string': '<bg_red><red>red text on red background (NO) >'}

    # out of the function, var0=var2 - nothing problems.
    ctlog(var0=var0, var1=var1, var2=var2, var3=var3)

ctprint.help()

Thanks