fixms.logger ============ .. py:module:: fixms.logger .. autoapi-nested-parse:: Logging module for FixMS .. !! processed by numpydoc !! Attributes ---------- .. autoapisummary:: fixms.logger.logger Classes ------- .. autoapisummary:: fixms.logger.CustomFormatter fixms.logger.LoggerWithHistory fixms.logger.TqdmToLogger Functions --------- .. autoapisummary:: fixms.logger.get_fixms_logger fixms.logger.update_history Module Contents --------------- .. py:class:: CustomFormatter(fmt=None, datefmt=None, style='%', validate=True, *, defaults=None) Bases: :py:obj:`logging.Formatter` Formatter instances are used to convert a LogRecord to text. Formatters need to know how a LogRecord is constructed. They are responsible for converting a LogRecord to (usually) a string which can be interpreted by either a human or an external system. The base Formatter allows a formatting string to be specified. If none is supplied, the style-dependent default value, "%(message)s", "{message}", or "${message}", is used. The Formatter can be initialized with a format string which makes use of knowledge of the LogRecord attributes - e.g. the default value mentioned above makes use of the fact that the user's message and arguments are pre- formatted into a LogRecord's message attribute. Currently, the useful attributes in a LogRecord are described by: %(name)s Name of the logger (logging channel) %(levelno)s Numeric logging level for the message (DEBUG, INFO, WARNING, ERROR, CRITICAL) %(levelname)s Text logging level for the message ("DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL") %(pathname)s Full pathname of the source file where the logging call was issued (if available) %(filename)s Filename portion of pathname %(module)s Module (name portion of filename) %(lineno)d Source line number where the logging call was issued (if available) %(funcName)s Function name %(created)f Time when the LogRecord was created (time.time() return value) %(asctime)s Textual time when the LogRecord was created %(msecs)d Millisecond portion of the creation time %(relativeCreated)d Time in milliseconds when the LogRecord was created, relative to the time the logging module was loaded (typically at application startup time) %(thread)d Thread ID (if available) %(threadName)s Thread name (if available) %(process)d Process ID (if available) %(message)s The result of record.getMessage(), computed just as the record is emitted .. !! processed by numpydoc !! .. py:method:: format(record) Format the specified record as text. The record's attribute dictionary is used as the operand to a string formatting operation which yields the returned string. Before formatting the dictionary, a couple of preparatory steps are carried out. The message attribute of the record is computed using LogRecord.getMessage(). If the formatting string uses the time (as determined by a call to usesTime(), formatTime() is called to format the event time. If there is exception information, it is formatted using formatException() and appended to the message. .. !! processed by numpydoc !! .. py:attribute:: FORMATS .. py:attribute:: blue :value: '\x1b[34;20m' .. py:attribute:: bold_red :value: '\x1b[31;1m' .. py:attribute:: format_str :value: '%(asctime)s.%(msecs)03d %(module)s - %(funcName)s: %(message)s' .. py:attribute:: green :value: '\x1b[32;20m' .. py:attribute:: grey :value: '\x1b[38;20m' .. py:attribute:: red :value: '\x1b[31;20m' .. py:attribute:: reset :value: '\x1b[0m' .. py:attribute:: yellow :value: '\x1b[33;20m' .. py:class:: LoggerWithHistory(*args, **kwargs) Bases: :py:obj:`logging.Logger` Custom logger that will also update the HISTORY table in the MS. .. !! processed by numpydoc !! .. py:method:: critical(message, *args, ms=None, app_params=[], **kwargs) Log 'msg % args' with severity 'CRITICAL'. To pass exception information, use the keyword argument exc_info with a true value, e.g. logger.critical("Houston, we have a %s", "major disaster", exc_info=1) .. !! processed by numpydoc !! .. py:method:: debug(message, *args, ms=None, app_params=[], **kwargs) Log 'msg % args' with severity 'DEBUG'. To pass exception information, use the keyword argument exc_info with a true value, e.g. logger.debug("Houston, we have a %s", "thorny problem", exc_info=1) .. !! processed by numpydoc !! .. py:method:: error(message, *args, ms=None, app_params=[], **kwargs) Log 'msg % args' with severity 'ERROR'. To pass exception information, use the keyword argument exc_info with a true value, e.g. logger.error("Houston, we have a %s", "major problem", exc_info=1) .. !! processed by numpydoc !! .. py:method:: info(message, *args, ms=None, app_params=[], **kwargs) Log 'msg % args' with severity 'INFO'. To pass exception information, use the keyword argument exc_info with a true value, e.g. logger.info("Houston, we have a %s", "interesting problem", exc_info=1) .. !! processed by numpydoc !! .. py:method:: log(level, message, *args, ms=None, app_params=[], **kwargs) Log 'msg % args' with the integer severity 'level'. To pass exception information, use the keyword argument exc_info with a true value, e.g. logger.log(level, "We have a %s", "mysterious problem", exc_info=1) .. !! processed by numpydoc !! .. py:method:: warning(message, *args, ms=None, app_params=[], **kwargs) Log 'msg % args' with severity 'WARNING'. To pass exception information, use the keyword argument exc_info with a true value, e.g. logger.warning("Houston, we have a %s", "bit of a problem", exc_info=1) .. !! processed by numpydoc !! .. py:class:: TqdmToLogger(logger, level=None) Bases: :py:obj:`io.StringIO` Output stream for TQDM which will output to logger module instead of the StdOut. .. !! processed by numpydoc !! .. py:method:: flush() Flush write buffers, if applicable. This is not implemented for read-only and non-blocking streams. .. !! processed by numpydoc !! .. py:method:: write(buf) Write string to file. Returns the number of characters written, which is always equal to the length of the string. .. !! processed by numpydoc !! .. py:attribute:: buf :value: '' .. py:attribute:: level :value: None .. py:attribute:: logger :value: None .. py:function:: get_fixms_logger(name: str = 'fixms', attach_handler: bool = True) -> LoggerWithHistory Will construct a logger object. :Parameters: * **name** (*str, optional*) -- Name of the logger to attempt to use. This is ignored if in a prefect flowrun. Defaults to 'arrakis'. * **attach_handler** (*bool, optional*) -- Attacjes a custom StreamHandler. Defaults to True. :returns: The appropriate logger :rtype: logging.Logger .. !! processed by numpydoc !! .. py:function:: update_history(ms: str, message: str, app_params: List[str] = [], obs_id: int = 0, priority: str = 'NORMAL') -> None .. py:data:: logger