tunel package

Subpackages

• tunel.client package
  • Submodules
  • tunel.client.apps module
    • docgen()
    • list_apps()
  • tunel.client.execute module
    • main()
  • tunel.client.launcher module
    • run_app()
    • run_condor()
    • run_docker()
    • run_singularity()
    • run_slurm()
    • stop_app()
    • stop_condor()
    • stop_slurm()
  • tunel.client.shell module
    • main()
  • tunel.client.tunnel module
    • main()
  • Module contents
    • get_parser()
    • run_tunel()
• tunel.launcher package
  • Subpackages
    • tunel.launcher.scripts package
      • Module contents
  • Submodules
  • tunel.launcher.base module
    • ContainerLauncher
      • ContainerLauncher.run_app()
    • Launcher
      • Launcher.assets
      • Launcher.assets_dir
      • Launcher.environ
      • Launcher.get_modules()
      • Launcher.home
      • Launcher.path
      • Launcher.prepare_render()
      • Launcher.remote_assets_dir
      • Launcher.remote_home
      • Launcher.remote_sockets
      • Launcher.remote_work
      • Launcher.run()
      • Launcher.run_app()
      • Launcher.scp_and_run()
      • Launcher.scp_get()
      • Launcher.slug
      • Launcher.stop()
      • Launcher.stop_app()
      • Launcher.username
      • Launcher.write_temporary_script()
  • tunel.launcher.singularity module
    • Singularity
      • Singularity.name
      • Singularity.run()
    • post_commands()
  • tunel.launcher.slurm module
    • Slurm
      • Slurm.get_machine()
      • Slurm.modules_file
      • Slurm.nodes_file
      • Slurm.previous_job_exists()
      • Slurm.print_session_instructions()
      • Slurm.print_updated_logs()
      • Slurm.run()
      • Slurm.run_app()
      • Slurm.show_logs_instruction()
      • Slurm.stop()
      • Slurm.stop_app()
      • Slurm.update_inventory()
    • post_commands()
  • Module contents
    • get_launcher()
• tunel.ssh package
  • Submodules
  • tunel.ssh.commands module
  • tunel.ssh.ssh module
    • Tunnel
      • Tunnel.execute()
      • Tunnel.execute_or_fail()
      • Tunnel.print_output()
      • Tunnel.scp_from()
      • Tunnel.scp_to()
      • Tunnel.shell()
      • Tunnel.tunnel()
      • Tunnel.tunnel_login_node()
  • Module contents
• tunel.templates package
  • Module contents
• tunel.utils package
  • Submodules
  • tunel.utils.fileio module
    • copyfile()
    • get_file_hash()
    • get_tmpdir()
    • get_tmpfile()
    • mkdir_p()
    • mkdirp()
    • print_json()
    • read_config_file()
    • read_file()
    • read_json()
    • read_lines()
    • read_yaml()
    • recursive_find()
    • write_file()
    • write_json()
  • tunel.utils.generate module
    • RobotNamer
      • RobotNamer.generate()
  • tunel.utils.terminal module
    • check_install()
    • confirm_action()
    • confirm_uninstall()
    • get_installdir()
    • run_command()
    • which()
  • Module contents

Submodules

tunel.apps module

class tunel.apps.App(app_config, app_dir, validate=True)

Bases: object

add_args(extras)

Extra is a list of args, in either format:

–name=value –flag

They must start with – to be considered.

property app_dir

docgen(out=None, outdir=None)

Render documentation for an app.

get(key, default=None)

get_script()

property has_xserver

Boolean to indicate if an application has an xserver

property job_name

property launchers

load(validate=True)

load_template()

Given an app, load the template script for it.

This also provides the app directory for any relative template scripts.

property name

property post_command

Get a post command, if it exists

print_pretty()

Print the app (and args, etc) pretty to the terminal.

property relative_dir

property relative_path

validate()

Validate the loaded settings with jsonschema

tunel.apps.get_app(name, extra=None)

Given an app name, get the loaded app for it

tunel.apps.list_apps(settings_file=None, validate=False)

Given the user settings,

tunel.defaults module

tunel.logger module

class tunel.logger.ColorizingStreamHandler(nocolor=False, stream=<_io.TextIOWrapper name='<stderr>' mode='w' encoding='utf-8'>, use_threads=False)

Bases: StreamHandler

BLACK = 0

BLUE = 4

BOLD_SEQ = '\x1b[1m'

COLOR_SEQ = '\x1b[%dm'

CYAN = 6

GREEN = 2

MAGENTA = 5

RED = 1

RESET_SEQ = '\x1b[0m'

WHITE = 7

YELLOW = 3

can_color_tty()

colors = {'CRITICAL': 1, 'DEBUG': 4, 'ERROR': 1, 'INFO': 2, 'WARNING': 3}

decorate(record)

emit(record)

Emit a record.

If a formatter is specified, it is used to format the record. The record is then written to the stream with a trailing newline. If exception information is present, it is formatted using traceback.print_exception and appended to the stream. If the stream has an ‘encoding’ attribute, it is used to determine how to do the output to the stream.

property is_tty

class tunel.logger.Logger

Bases: object

cleanup()

cyan(msg)

debug(msg)

error(msg)

exit(msg, return_code=1)

handler(msg)

info(msg)

location(msg)

panel_group(msgs)

Input is a dictionary of colors (for panel background) and corresponding messages.

print_pretty(obj)

Print a dict (and nested content) pretty.

progress(done=None, total=None)

purple(msg)

set_level(level)

set_stream_handler(stream_handler)

shellcmd(msg)

text_handler(msg)

The default handler prints output to the console. :param msg: the log message dictionary :type msg: dict

warning(msg)

tunel.logger.setup_logger(quiet=False, printshellcmds=False, nocolor=False, stdout=False, debug=False, use_threads=False, wms_monitor=None)

tunel.schemas module

tunel.settings module

class tunel.settings.Settings(settings_file, validate=True)

Bases: SettingsBase

The settings class is a wrapper for easily parsing a settings.yml file.

We parse into a query-able class. It also gives us control to update settings, meaning we change the values and then write them to file. It’s basically a dictionary-like class with extra functions.

class tunel.settings.SettingsBase

Bases: object

change_validate(key, value)

A courtesy function to validate a new config addition.

delete(key)

edit()

Interactively edit a config file.

get(key, default=None)

Get a settings value, doing appropriate substitution and expansion.

get_settings_file(settings_file=None)

Get the preferred used settings file.

load(settings_file=None)

Load the settings file into the settings object

save(filename=None)

Save settings, but do not change order of anything.

validate()

Validate the loaded settings with jsonschema

tunel.template module

class tunel.template.Template

Bases: object

Supporting functions for loading any kind of apps template

get(template_name, template_dir=None)

Get a template from templates

load(template_name, template_dir=None)

Load the default module template.

tunel.version module

Module contents