copyxnat.pyreporter.pyreporter module

Logging and user I/O

exception copyxnat.pyreporter.pyreporter.ProjectFailure

Bases: copyxnat.pyreporter.pyreporter.PyReporterError

An error which is non-recoverable for a project but which allows other project processing to continue

class copyxnat.pyreporter.pyreporter.PyReporter(data_dir, verbose=False)

Bases: object

Class for custom reporting actions

complete_progress()

Complete progress bar

debug(message)

Message which can be ignored unless in verbose mode

error(message)

Error message to report to end user

get_password(message)

Obtain a password

info(message)

Informational message which should be shown to the user

log(message)

Message which should always be written to the log but not shown to the end user unless debugging

next_progress()

Update existing progress bar to next step

output(message)

Print text to the console without a message prefix

start_progress(message, max_iter)

Display a progress bar

warning(message)

Warning message to report to end user

exception copyxnat.pyreporter.pyreporter.PyReporterError

Bases: RuntimeError

Non-recoverable error