nexuslims_logger namespace

Submodules

nexuslims_logger.filewatcher module

FileWatcher will watch a directory,and sync with Cloud periodically.

It will upload any files (require file types match if specified) (modified after certain time if specified) that checksum changed wrt. cache (if any) to a GCP cloud bucket in a specified interval.

class nexuslims_logger.filewatcher.FileWatcher(watch_dir, bucket_name, bucket_dir, credential_fn, cache_fn, interval=600, file_types=None, mtime_since=None, instr_info=None, logger=None)

Bases: object

property bucket_dir

classmethod from_config(config, watchdir, credential_fn, cache_fn, logger=None)

get_files_to_upload()

find files to upload recursively and return list of abs file names and content checksum.

file satisfying the following condition will be considered for uploading: - file type is allowed (set in app config) - file modification timestamp is after the set threshold (session start time) - file content checksum does not exist in cache or updated.

Returns

List of tuple consisting file names and MD5 checksum.

Return type

List[Tuple[str, str]]

property instr_info

property interval

property mtime_since

upload()

upload to the cloud object storage, set metadata and update the cache.

nexuslims_logger.instrument module

class nexuslims_logger.instrument.GCPInstrument(output_dir, bucket_name, bucket_dir, credential_fn, logger=None)

Bases: nexuslims_logger.instrument.Instrument

Mock an instrument with data stored in GCP.

classmethod from_config(config, outputdir, credential_fn, logger=None)

generate_data()

Download random file from GCP bucket.

save to self.output_dir, and rename by timestamp.

get_file_pool()

List all files in GCP self.bucket_dir

nexuslims_logger.loggerhub module

LoggerHub

class nexuslims_logger.loggerhub.App(config, cred_json, cache_json, verbose=20)

Bases: tkinter.Tk

copy_text_to_clipboard()

run()

start()

stop()

class nexuslims_logger.loggerhub.ConsoleUi(frame, logger)

Bases: object

Poll messages from a logging queue and display them in a scrolled text widget

display(record)

poll_log_queue()

class nexuslims_logger.loggerhub.DBSessionLogger(cpu_name, dbapi_url, dbapi_username=None, dbapi_password=None, user=None, logger=None)

Bases: object

communicate with database.

continue_last_session()

db_logger_setup()

get instrument info (pid, schema name).

db_logger_teardown()

teardown routine

classmethod from_config(config, cpu_name, user=None, logger=None)

handle(msg)

last_session_ended()

Check the database for this instrument to make sure that the last entry in the db was an “END” (properly ended). If it’s not, return False so the GUI can query the user for additional input on how to proceed.

Returns

• is_success (bool) – If the database is consistent (i.e. the last log for this instrument is an “END” log), return True. If not (it’s a “START” log), return False

• msg (str)

process_end()

Insert a session ‘END’ log for this computer’s instrument, and change the status of the corresponding ‘START’ entry from ‘WAITING_FOR_END’ to ‘TO_BE_BUILT’

process_end_check()

process_start()

Insert a session ‘START’ log for this computer’s instrument

Returns True if successful, False if not

process_start_check()

save_note(note_text)

update_start()

update_start_check()

class nexuslims_logger.loggerhub.QueueHandler(log_queue)

Bases: logging.Handler

Class to send logging records to a queue It can be used from different threads The ConsoleUi class polls this queue to display records in a ScrolledText widget

emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

nexuslims_logger.loggerhub.main()

nexuslims_logger.loggerhub.validate_config(config)

nexuslims_logger.loggertem module

LoggerTEM GUI

class nexuslims_logger.loggertem.App(hubaddr, watchdir, user=None, screen_res=None, logger=None, log_text=None)

Bases: tkinter.Tk

close_warning(num_to_show)

set loading text to remind the closing action

create_widgets()

draw widgets on main frame.

destroy()

Destroy this and all descendants widgets. This will end the application of this Tcl interpreter.

disable_buttons()

bring state of all buttons on main window to DISABLED

done_loading()

actions by the end of loading.

put off setup_frame, put up running_frame and labels, enable buttons.

draw_buttons()

buttons at the bottom

draw_info()

information section

incl. loading text, progress bar, instrument label, datetime

draw_logo()

Top NexusLIMS logo with tooltip.

enable_buttons()

bring state of all buttons on main window to NORMAL

generate_data()

communicate with hub via socket to generate data

on_closing()

actions when user is closing the main window.

save_note()

session_end()

routines for session ending.

change the frame, update loading text and progress bar.

session_end_worker()

communicate with hub via socket to perform end session tasks.

session_startup()

start startup_thread, update loading progress bar.

session_startup_worker()

communicate with hub via socket to perform start session tasks.

show_error_if_needed(res)

show error box if res is an Exception

switch_gui_to_end()

actions by the start of ending.

put off running_frame; putup setup_frame, diable buttons

watch_for_end_result()

Check if there is something in the queue.

update loading text and progress bar.

watch_for_startup_result()

Check if there is something in the queue.

update loading text and progress bar.

class nexuslims_logger.loggertem.ConfirmUi(parent, query)

Bases: tkinter.Toplevel

Popup window ask user for confirmation It has three buttons: yes, no, cancel

click_cancel()

click_no()

click_yes()

show()

class nexuslims_logger.loggertem.HangingSessionDialog(parent)

Bases: tkinter.Toplevel

Dialogue window prompt user for actions when previous session is detected not ended properly.

click_close()

enforce user to choose between continue or start with en error box.

click_continue()

record action, destroy the window.

click_new()

record action, destroy the window.

destroy()

destroy the window, enable buttons on the main window.

show()

Show the dialogue window, return the user response.

class nexuslims_logger.loggertem.LogWindow(parent, is_error=False)

Bases: tkinter.Toplevel

change_close_button(num_to_show, state='disabled')

copy_text_to_clipboard()

class nexuslims_logger.loggertem.NoteWindow(parent)

Bases: tkinter.Toplevel

change_close_button(num_to_show, state='disabled')

copy_text_to_clipboard()

delete_note()

on_closing()

save_note()

class nexuslims_logger.loggertem.PauseOrEndDialogue(parent)

Bases: tkinter.Toplevel

Dialogue window prompts user for actions when the user is closing the main window

click_cancel()

record action, destroy the window.

click_close()

record action, destroy the window.

click_end()

record action, destroy the window.

click_pause()

record action, destroy the window.

destroy()

destroy the window, enable buttons on the main window.

show()

Show the dialogue window, return the user response.

class nexuslims_logger.loggertem.ToolTip(wdgt, tooltip_font='TkDefaultFont', msg=None, msgFunc=None, header_msg=None, delay=1, follow=True)

Bases: tkinter.Toplevel

Provides a ToolTip widget for Tkinter. To apply a ToolTip to any Tkinter widget, simply pass the widget to the ToolTip constructor

hide(event=None)

Hides the ToolTip. Usually this is caused by leaving the widget :param event: The event that called this function

move(event)

Processes motion within the widget. :param event: The event that called this function

show()

Displays the ToolTip if the time delay has been long enough

spawn(event=None)

Spawn the ToolTip. This simply makes the ToolTip eligible for display. Usually this is caused by entering the widget

Parameters

event – The event that called this function

nexuslims_logger.loggertem.help()

nexuslims_logger.loggertem.main()

nexuslims_logger.loggertem.validate_config(config)

simple validation of config settings

nexuslims_logger.utils module

utility functions

class nexuslims_logger.utils.Config(dict=None, /, **kwargs)

Bases: collections.UserDict

subclass dict, get keys from environment first.

get(k[, d]) → D[k] if k in D, else d.  d defaults to None.

class nexuslims_logger.utils.ScreenRes(logger=None)

Bases: object

get_center_geometry_string(width, height)

This method will return a Tkinter geometry string that will place a Toplevel window into the middle of the screen given the widget’s width and height (using a Windows command or xrandr as needed). If it fails for some reason, a basic resolution of 800x600 is assumed.

Parameters

• width (int) – The width of the widget desired

• height (int) – The height of the widget desired

Returns

geometry_string – The Tkinter geometry string that will put a window of width and height at the center of the screen given the current resolution (of the format “WIDTHxHEIGHT+XPOSITION+YPOSITION”)

Return type

str

run_cmd(cmd)

Run a command using the subprocess module and return the output. Note that because we want to run the eventual logger without a console visible, we do not have access to the standard stdin, stdout, and stderr, and these need to be redirected subprocess pipes, accordingly.

Parameters

cmd (str) – The command to run (will be run in a new Windows cmd shell). stderr will be redirected for stdout and included in the returned output

Returns

output – The output of cmd

Return type

str

nexuslims_logger.utils.check_singleton()

make sure only ONE instance of the program running.

nexuslims_logger.utils.get_logger(name, verbose=20, stream=None)

get a logger from logging module, direct output to stdout, verbose level set by verbose.

If additional stream is provided, direct output (DEBUG) to that stream too.

nexuslims_logger.utils.resource_path(relative_path)

nexuslims_logger.utils.show_error_msg_box(msg)

show a tkinter error box.