Log library
Project description
SmileLog
SmileLog 4.1.2
Appending a silent feature which auto-remove itself the current content file if over a limit that given by a parameter 'maxMb'.
It won't do anything unless the value of the 'autoclean' equals 'False'.
autoclean= True
maxMb=100
Every writing a log, it will check these value.
The features since version 4.x.x:
- Log to a static file
- Backup file everyday
- Enable series of log session
- Parallel log between static log and session log
- Push any log to redis via pubsub method
- Dynamic line separation
- on or off
- editable line character
- editable number of line character
- Fix bugs
- Improve performance
- Clean up code
It's going to change the traditional tracing in another way.
What will it assist us:
- Showing the colorized log by following the standard color
- Ignoring any track by reading id in the list
- Each statement list down with a big span and symbols
- Using a static file to output the content that will be easier
- Disable the entire tracing in a second
- 5 methods for 5 outputs
- Backup file if log start a new date
- Separating a new file with a new file name This feature will cover to a specific tracking.
- Group the log with specific key(series key)
- Able to set maxSize log
It is available on PyPi store via https://pypi.org/project/SmileLog/
To Support my work, please donate me via Buy me a Coffee
Installation
# pip3 install SmileLog
5 Methods
Use in the different situation, and show up in different color
- error: error(title, content, id= None, channel= None)
- fail: fail(title, content, id= None, channel= None)
- information: info(title, content, id= None, channel= None)
- success: success(title, content, id= None, channel= None)
- track: track(title, content, id= None, channel= None)
- warning: warning(title, content, id= None, channel= None)
- title is a string
- content can be a string or dict
Figure (version 2.0)
Start using in the simple way:
from smilelog import Logger
# first instant
log = Logger(
enableLog= True
)
# try to print out
log.info(
'My Info Title'
, {'data':'My Dictionary Content'}
)
# success method
log.success(
title = 'My Success Title'
, content = 'My String'
)
# setKeySeries is a new method to indicate to the token of a long message
log.setKeySeries('NbcseX32cDse')
Logger
Logger is a tracing class library and write/output into a file.
This will need generating a file and keep writing the content.
Let's Look at its configure would explain more:
log = Logger(
path: str = 'log'
, filename: str = 'access'
, extension: str = 'log'
, enableLog: bool= True
, enableConsole: bool= True
, line: bool= True
, charInLine: int = 55
, lineCharStart: str = '>'
, lineCharEnd: str = '<',
, color: bool= True
, autoClean: bool= False
, maxMb: int=100
)
- path: is a directory
Ex:
/var/www/my-project/logs/
- filename: is the name of a new file log.
# set name
filename= 'access'
Ex:
/var/www/my-project/logs/access.log
# some app move it into system log directory, it is an advantage of prefix
- color: is for showing the color on terminal with tail command or terminal editor.
# set color
color= True
or
color= False
- enableLog: allow an object to create the file.
- True: To create a file and write content into log file
- False: To disable the logging
# set enable
# enable to write log file
enableLog= True
- enableConsole: to bring something on the screen of log.
- True: To print out on terminal
- False: No action
# set enable
enableConsole= True
Series
Just a series name of output
- setKeySeries: data
# set value
log.setKeySeries('Insert Data')
# stop
log.setKeySeries()
Disable print out
The most feature developer guy needs.
It will disable only the index that we set in disable list.
- disableIds: hide those ids.
- parameter must be Array
# Logger instant
# Ex: Logger logged 10 times
# but we will show some id except 1,2,3,7,8,9
# do this
log.disableIds([1,2,3,7,8,9])
Separate a session file
Here is the method to separate normal log file to a specific. Follow the setting:
- setKeySession: must be a string and maximum length 32
log.setKeySession('cbc98494543823442425488df')
It will separate from the default log, and generate a new file as 'cbc98494543823442425488df.log'.
Note:
To stop running a session, just set it the None.
log.setKeySession()
2022-05-12 21:40:20.345 <id: 4>
_>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[FAIL] My Title
{'data': 'my content'}
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
2022-05-12 21:40:20.345 <id: 5> Insert Data
_>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
[WARNING] Warning
{'data': 'my content'}
<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
2022-05-12 21:40:20.345 <id: 6> Delete Row
[TRACK] My Title
{'data': 'my content'}
2022-05-12 21:40:20.345 <id: 10>
[SUCCESS] Success
Hello String
Pub/Sub
initializes redis requirement
- setRedis
- host: required
- port: required
- channel: the default is None, scribe and publish
- db: by default is 0
- password: by default is None
enable Redis Engine
- enableRedis: bool
enable any functional alert
- enableError: bool
- enableFail: bool
- enableInfo: bool
- enableTrack: bool
- enableSuccess: bool
- enableWarning: bool
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.