# # This file is part of the PyMeasure package. # # Copyright (c) 2013-2024 PyMeasure Developers # # Permission is hereby granted, free of charge, to any person obtaining a copy # of this software and associated documentation files (the "Software"), to deal # in the Software without restriction, including without limitation the rights # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell # copies of the Software, and to permit persons to whom the Software is # furnished to do so, subject to the following conditions: # # The above copyright notice and this permission notice shall be included in # all copies or substantial portions of the Software. # # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN # THE SOFTWARE. # import logging import logging.handlers from logging.handlers import QueueHandler from queue import Queue log = logging.getLogger(__name__) log.addHandler(logging.NullHandler()) class QueueListener(logging.handlers.QueueListener): def is_alive(self): try: return self._thread.is_alive() except AttributeError: return False def console_log(logger, level=logging.INFO, queue=None): """Create a console log handler. Return a scribe thread object.""" if queue is None: queue = Queue() logger.setLevel(level) ch = logging.StreamHandler() ch.setLevel(level) formatter = logging.Formatter( fmt='%(asctime)s: %(message)s (%(name)s, %(levelname)s)', datefmt='%I:%M:%S %p') ch.setFormatter(formatter) logger.addHandler(ch) scribe = Scribe(queue) return scribe def file_log(logger, log_filename, level=logging.INFO, queue=None, **kwargs): """Create a file log handler. Return a scribe thread object.""" if queue is None: queue = Queue() logger.setLevel(level) ch = logging.FileHandler(log_filename, **kwargs) ch.setLevel(level) formatter = logging.Formatter('%(asctime)s - %(name)s - %(levelname)s - %(message)s') ch.setFormatter(formatter) logger.addHandler(ch) scribe = Scribe(queue) return scribe class Scribe(QueueListener): """ Scribe class which logs records as retrieved from a queue to support consistent multi-process logging. :param queue: The multiprocessing queue which the scriber will listen to. """ def __init__(self, queue): super().__init__(queue) def handle(self, record): logging.getLogger(record.name).handle(record) def setup_logging(logger=None, console=False, console_level='INFO', filename=None, file_level='DEBUG', queue=None, file_kwargs=None): """Setup logging for console and/or file logging. Returns a scribe thread object. Defaults to no logging.""" if queue is None: queue = Queue() if logger is None: logger = logging.getLogger() if file_kwargs is None: file_kwargs = {} logger.handlers = [] if console: console_log(logger, level=getattr(logging, console_level)) logger.info('Set up console logging') if filename is not None: file_log(logger, filename, level=getattr(logging, file_level), **file_kwargs) logger.info('Set up file logging') scribe = Scribe(queue) return scribe class TopicQueueHandler(QueueHandler): def __init__(self, queue, topic='log'): super().__init__(queue) self.topic = topic def prepare(self, record): return self.topic, record