Source code for labscript_utils

#####################################################################
#                                                                   #
# __init__.py                                                       #
#                                                                   #
# Copyright 2013, Monash University                                 #
#                                                                   #
# This file is part of the labscript suite (see                     #
# http://labscriptsuite.org) and is licensed under the Simplified   #
# BSD License. See the license.txt file in the root of the project  #
# for the full license.                                             #
#                                                                   #
#####################################################################

import sys
import os
import importlib

from .__version__ import __version__ 

from labscript_profile import LABSCRIPT_SUITE_PROFILE

if not os.path.exists(LABSCRIPT_SUITE_PROFILE):
    # Create new profile if none exists
    from labscript_profile.create import create_profile
    create_profile()
    # This would normally run at interpreter startup but didn't since the profile didn't
    # exist:
    import labscript_profile
    labscript_profile.add_userlib_and_pythonlib()


# This folder
labscript_utils_dir = os.path.dirname(os.path.realpath(__file__))


[docs]def import_or_reload(modulename): """ Behaves like 'import modulename' would, excepts forces the imported script to be rerun """ # see if the proposed module is already loaded # if so, we will need to re-run the code contained in it if modulename in sys.modules.keys(): importlib.reload(sys.modules[modulename]) return sys.modules[modulename] module = importlib.import_module(modulename) return module
from labscript_utils.versions import VersionException, check_version
[docs]def dedent(s): """Remove leading spaces from the first line of a string, all common leading indentation (spaces only) from subsequent lines, strip trailing spaces from all lines and replace single newlines prior to lines with the common indentation with spaces. Lines with additional indentation are kept verbatim. Good for unwrapping error messages etc that are in code as multiline triple-quoted strings.""" # Strip trailing whitespace: lines = [line.rstrip(' ') for line in s.splitlines()] # Get common indentation from lines other than the first one: indentation = float('inf') for line in lines[1:]: if line: indentation = min(indentation, len(line) - len(line.lstrip(' '))) if not lines[1:]: indentation = 0 # Dedent the lines: dedented_lines = [] for i, line in enumerate(lines): if i == 0: dedented_line = line.lstrip(' ') else: dedented_line = line[indentation:] dedented_lines.append(dedented_line) # Then add newline characters where we are going to keep them: unwrapped_lines = [] for i, line in enumerate(dedented_lines): if i == 0: unwrapped_lines.append(line) else: previous_line = dedented_lines[i - 1] # If either this line or the previous line is blank or starts with custom # indentation, put this line on a newline rather than unwrapping it: if any(not l or l.startswith(' ') for l in [line, previous_line]): unwrapped_lines.append('\n' + line) else: unwrapped_lines.append(' ' + line) return ''.join(unwrapped_lines)
# Enforce that the same file can't be imported under multiple names, to help # prevent subtle bugs: import labscript_utils.double_import_denier labscript_utils.double_import_denier.enable() # Disable the 'quick edit' feature of Windows' cmd.exe, which causes console applicatons # to freeze if their console windows are merely clicked on. This causes all kinds of # headaches, so we disable it in all labscript programs: import zprocess zprocess.disable_quick_edit()