YunoHost/moulinette
1
0
Fork 0
mirror of https://github.com/YunoHost/moulinette.git synced 2024-09-03 20:06:31 +02:00
Code Issues Projects Releases Packages Wiki Activity

[enh] Allow to use a formatter and improve tty check in TTYHandler

Browse source
This commit is contained in:
Jérôme Lebleu 2015-11-14 19:14:45 +01:00
parent 0b8b51d306
commit 4cf898d9c7
1 changed files with 22 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
moulinette/interfaces/cli.py
View file

@ -136,11 +136,14 @@ class TTYHandler(log.StreamHandler):
A handler class which prints logging records for a tty. The record is A handler class which prints logging records for a tty. The record is
neverthemess formatted depending if it is connected to a tty(-like) neverthemess formatted depending if it is connected to a tty(-like)
device. device.
If it's the case, the level name - optionnaly colorized - is If it's the case, the level name - optionnaly colorized - is prepended
prepended to the message. If not, just the message is output. to the message and the result is stored in the record as `message_key`
attribute. That way, a custom formatter can be defined. The default is
to output just the formatted message.
Anyway, if the stream is not a tty, just the message is output.
Records with a level higher or equal to WARNING are sent to stderr Note that records with a level higher or equal to WARNING are sent to
stream. Otherwise, they are sent to stdout. stderr. Otherwise, they are sent to stdout.
""" """
LEVELS_COLOR = { LEVELS_COLOR = {
@ -153,16 +156,14 @@ class TTYHandler(log.StreamHandler):
log.CRITICAL : 'red', log.CRITICAL : 'red',
} }
def __init__(self): def __init__(self, message_key='fmessage'):
log.StreamHandler.__init__(self, stream=sys.stdout) log.StreamHandler.__init__(self)
if os.isatty(1): self.message_key = message_key
self.colorized = True
else:
self.colorized = False
def format(self, record): def format(self, record):
"""Enhance message with level and colors if supported."""
msg = record.getMessage() msg = record.getMessage()
if self.colorized: if self.supports_color():
level = '' level = ''
if self.level <= log.DEBUG: if self.level <= log.DEBUG:
# add level name before message # add level name before message
@ -173,6 +174,10 @@ class TTYHandler(log.StreamHandler):
color = self.LEVELS_COLOR.get(record.levelno, 'white') color = self.LEVELS_COLOR.get(record.levelno, 'white')
msg = '\033[{0}m\033[1m{1}\033[m{2}'.format( msg = '\033[{0}m\033[1m{1}\033[m{2}'.format(
colors_codes[color], level, msg) colors_codes[color], level, msg)
if self.formatter:
# use user-defined formatter
record.__dict__[self.message_key] = msg
return self.formatter.format(record)
return msg return msg
def emit(self, record): def emit(self, record):
@ -183,6 +188,12 @@ class TTYHandler(log.StreamHandler):
self.stream = sys.stdout self.stream = sys.stdout
log.StreamHandler.emit(self, record) log.StreamHandler.emit(self, record)
def supports_color(self):
"""Check whether current stream supports color."""
if hasattr(self.stream, 'isatty') and self.stream.isatty():
return True
return False
class ActionsMapParser(BaseActionsMapParser): class ActionsMapParser(BaseActionsMapParser):
"""Actions map's Parser for the CLI """Actions map's Parser for the CLI