pypeit.pypmsgs module

Module for terminal and file logging.

Todo

Why not use pythons native logging package?

class pypeit.pypmsgs.Messages(log=None, verbosity=None, colors=True)

Bases: object

Create coloured text for messages printed to screen.

For further details on colours see the following example: http://ascii-table.com/ansi-escape-sequences.php

Parameters:

• log (str or file-like object,optional) – Name of saved log file (no log will be saved if log==””). If None, no log is saved.

• verbosity (int) –

  Level of verbosity. Options are

  • 0 = No output

  • 1 = Minimal output

  • 2 = All output (default)

• colors (bool) – If true, the screen output will have colors, otherwise normal screen output will be displayed

_cleancolors(msg)

_devmsg()

_initialize_log_file(log=None)

Expects self._log is already None.

_print(premsg, msg, last=True, printDevMsg=True)

Print to standard error and the log file

bug(msg)

Print a bug message

close()

Close the log file before the code exits

disablecolors()

Disable colored output text

enablecolors()

Enable colored output text

error(msg, cls='PypeItError')

Print an error message

static indent()

Return a text string containing an indent to be used with messages

info(msg)

Print an information message

info_update(msg, last=False)

Print an information message that needs to be updated

input()

Return a text string to be used to display input required from the user

static newline()

Return a text string containing a newline to be used with messages

prindent(msg)

Print an indent

pypeitpar(msglist)

Print a message with the pypeit par formatting.

Parameters:

msglist (list) –

A list containing the pypeit parameter strings. The last element of the list must be the argument and the variable. For example, to print:

[sensfunc]
    [[UVIS]]
        polycorrect = False

you should set msglist = ['sensfunc', 'UVIS', 'polycorrect = False'].

pypeitpar_text(msglist)

Prepare a text string with the pypeit par formatting.

Parameters:

msglist (list) –

A list containing the pypeit parameter strings. The last element of the list must be the argument and the variable. For example, to print:

[sensfunc]
    [[UVIS]]
        polycorrect = False

you should set msglist = ['sensfunc', 'UVIS', 'polycorrect = False'].

Returns:

parstring – The parameter string

Return type:

str

reset(log=None, verbosity=None, colors=True, log_to_stderr=None)

Reinitialize the object.

Needed so that there can be a default object for all modules, but also a dynamically defined log file.

reset_log_file(log)

set_logfile_and_verbosity(scriptname, verbosity)

Set the logfile name and verbosity level for a script run.

PypeIt scripts (with the exception of run_pypeit) default to verbosity level = 1. For certain scripts, having a more verbose output (with an accompanying log file) would be helpful for debugging purposes. This function provides the ability to set the msgs verbosity and create a log file for those certain scripts.

Log filenames have the form scriptname_YYYYMMDD_HHMM.log to differentiate between different runs of the script. Timestamp is UT.

Parameters:

• scriptname (str, optional) – The name of the calling script for use in the logfile

• verbosity (int, optional) – The requested verbosity, passed in from the argument parser. Verbosity level between 0 [none] and 2 [all]

test(msg)

Print a test message

warn(msg)

Print a warning message

work(msg)

Print a work in progress message

exception pypeit.pypmsgs.PypeItBitMaskError

Bases: PypeItError

exception pypeit.pypmsgs.PypeItDataModelError

Bases: PypeItError

exception pypeit.pypmsgs.PypeItError

Bases: Exception

exception pypeit.pypmsgs.PypeItPathError

Bases: PypeItError