jenkins-bot has submitted this change. ( https://gerrit.wikimedia.org/r/c/pywikibot/core/+/692270 ) Change subject: [IMPR] subclass TerminalHandler from logging.StreamHandler ...................................................................... [IMPR] subclass TerminalHandler from logging.StreamHandler - rename strm parameter to stream - use createLock to set thread lock - flush of superclass to flush the stream which also acquires locking - rename text to msg like usage in StreamHandler Change-Id: Iccc67f233880dcc6c55e5980b3942695a03711fc --- M pywikibot/userinterfaces/terminal_interface_base.py 1 file changed, 22 insertions(+), 26 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py index 9db7fc3..c7bc96b 100755 --- a/pywikibot/userinterfaces/terminal_interface_base.py +++ b/pywikibot/userinterfaces/terminal_interface_base.py @@ -22,7 +22,7 @@ StandardOption, ) from pywikibot.logging import INFO, INPUT, STDOUT, VERBOSE, WARNING -from pywikibot.tools import RLock +from pywikibot.tools import deprecated_args, RLock from pywikibot.userinterfaces import transliteration from pywikibot.userinterfaces._interface_base import ABUIC @@ -97,7 +97,7 @@ default_stream = self.stderr # default handler for display to terminal - default_handler = TerminalHandler(self, strm=default_stream) + default_handler = TerminalHandler(self, stream=default_stream) if config.verbose_output: default_handler.setLevel(VERBOSE) else: @@ -109,7 +109,7 @@ root_logger.addHandler(default_handler) # handler for level STDOUT - output_handler = TerminalHandler(self, strm=self.stdout) + output_handler = TerminalHandler(self, stream=self.stdout) output_handler.setLevel(STDOUT) output_handler.addFilter(MaxLevelFilter(STDOUT)) output_handler.setFormatter( @@ -117,7 +117,7 @@ root_logger.addHandler(output_handler) # handler for levels WARNING and higher - warning_handler = TerminalHandler(self, strm=self.stderr) + warning_handler = TerminalHandler(self, stream=self.stderr) warning_handler.setLevel(WARNING) warning_handler.setFormatter( TerminalFormatter(fmt='%(levelname)s: %(message)s%(newline)s')) @@ -494,44 +494,40 @@ return list(self.argv) -class TerminalHandler(logging.Handler): +class TerminalHandler(logging.StreamHandler): """A handler class that writes logging records to a terminal. - This class does not close the stream, - as sys.stdout or sys.stderr may be (and usually will be) used. + This class does not close the stream, as sys.stdout or sys.stderr + may be (and usually will be) used. Slightly modified version of the StreamHandler class that ships with logging module, plus code for colorization of output. - """ # create a class-level lock that can be shared by all instances sharedlock = threading.RLock() - def __init__(self, UI, strm=None): + @deprecated_args(strm='stream') + def __init__(self, UI, stream=None): """Initialize the handler. - If strm is not specified, sys.stderr is used. - + If stream is not specified, sys.stderr is used. """ - super().__init__() - # replace Handler's instance-specific lock with the shared class lock - # to ensure that only one instance of this handler can write to - # the console at a time - self.lock = TerminalHandler.sharedlock - if strm is None: - strm = sys.stderr - self.stream = strm - self.formatter = None + super().__init__(stream=stream) self.UI = UI - def flush(self): - """Flush the stream.""" - self.stream.flush() + def createLock(self): + """Acquire a thread lock for serializing access to the underlying I/O. + + Replace Handler's instance-specific lock with the shared + class lock to ensure that only one instance of this handler can + write to the console at a time. + """ + self.lock = TerminalHandler.sharedlock def emit(self, record): - """Emit the record formatted to the output and return it.""" + """Emit the record formatted to the output.""" if record.name == 'py.warnings': # Each warning appears twice # the second time it has a 'message' @@ -540,8 +536,8 @@ record.__dict__.setdefault('newline', '\n') - text = self.format(record) - return self.UI.output(text, targetStream=self.stream) + msg = self.format(record) + self.UI.output(msg, targetStream=self.stream) class TerminalFormatter(logging.Formatter): -- To view, visit https://gerrit.wikimedia.org/r/c/pywikibot/core/+/692270 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Change-Id: Iccc67f233880dcc6c55e5980b3942695a03711fc Gerrit-Change-Number: 692270 Gerrit-PatchSet: 3 Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Merlijn van Deen <valhallasw(a)arctus.nl> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot Gerrit-MessageType: merged