cmd Package

cmd Package

fastr.utils.cmd.add_parser_doc_link(parser, filepath)

fastr.utils.cmd.find_commands()

fastr.utils.cmd.get_command_module(command)

fastr.utils.cmd.main()

fastr.utils.cmd.print_help(commands=None)

cat Module

fastr.utils.cmd.cat.fastr_cat(infile, path)

fastr.utils.cmd.cat.get_parser()

fastr.utils.cmd.cat.main()

Print information from a job file

dump Module

fastr.utils.cmd.dump.create_zip(directory, output_file)

fastr.utils.cmd.dump.get_parser()

fastr.utils.cmd.dump.main()

Dump the contents of a network run tempdir into a zip for remote assistance

execute Module

fastr.utils.cmd.execute.get_parser()

fastr.utils.cmd.execute.main()

Execute a fastr job file

extract_argparse Module

fastr.utils.cmd.extract_argparse.cardinality_from_nargs(value)

fastr.utils.cmd.extract_argparse.datatype_from_type(type_, metavar)

fastr.utils.cmd.extract_argparse.extract_argparser(filepath)

fastr.utils.cmd.extract_argparse.find_argparser(entry, basename='/home/docs/checkouts/readthedocs.org/user_builds/fastr/envs/default/bin/sphinx-build')

fastr.utils.cmd.extract_argparse.get_parser()

fastr.utils.cmd.extract_argparse.main()

Create a stub for a Tool based on a python script using argparse

provenance Module

fastr.utils.cmd.provenance.get_parser()

fastr.utils.cmd.provenance.get_prov_document(result)

fastr.utils.cmd.provenance.main()

Get PROV information from the result pickle.

pylint Module

fastr.utils.cmd.pylint.get_parser()

fastr.utils.cmd.pylint.main()

Tiny wrapper in pylint so the output can be saved to a file (for test automation)

fastr.utils.cmd.pylint.run_pylint(out_file, pylint_args)

report Module

fastr.utils.cmd.report.get_parser()

fastr.utils.cmd.report.main()

Print report of a job result (__fastr_result__.pickle.gz) file

run Module

fastr.utils.cmd.run.create_network_parser(network)

fastr.utils.cmd.run.get_parser()

fastr.utils.cmd.run.main()

Run a Network from the commandline

sink Module

fastr.utils.cmd.sink.get_parser()

fastr.utils.cmd.sink.main()

Command line access to the IOPlugin sink

fastr.utils.cmd.sink.sink()

source Module

fastr.utils.cmd.source.get_parser()

fastr.utils.cmd.source.main()

Command line access to the IOPlugin source

fastr.utils.cmd.source.source()

test Module

fastr.utils.cmd.test.check_network(args)

fastr.utils.cmd.test.check_networks(args)

fastr.utils.cmd.test.check_tool(args)

fastr.utils.cmd.test.check_tools(args)

fastr.utils.cmd.test.directory(path)

Make sure the path is a valid directory for argparse

fastr.utils.cmd.test.get_parser()

fastr.utils.cmd.test.main()

Run the tests of a tool to verify the proper function

fastr.utils.cmd.test.tool(value)

Make sure the value is a correct tool for argparse or reference directory

trace Module

fastr.utils.cmd.trace.get_parser()

fastr.utils.cmd.trace.main()

Trace samples/sinks from a run

fastr.utils.cmd.trace.print_sample_sink(sink_data, dirname, sample_sink_tuples, verbose)

fastr.utils.cmd.trace.print_samples(sink_data, sample_ids, verbose)

fastr.utils.cmd.trace.print_sinks(sink_data, sink_ids, verbose)

fastr.utils.cmd.trace.read_sink_data(infile)

fastr.utils.cmd.trace.switch_sample_sink(sink_data)

upgrade Module

class fastr.utils.cmd.upgrade.FastrNamespaceType(toollist, typelist)

Bases: tuple

__getnewargs__()

Return self as a plain tuple. Used by copy and pickle.

__module__ = 'fastr.utils.cmd.upgrade'

static __new__(_cls, toollist, typelist)

Create new instance of FastrNamespaceType(toollist, typelist)

__repr__()

Return a nicely formatted representation string

__slots__ = ()

property toollist

Alias for field number 0

property typelist

Alias for field number 1

class fastr.utils.cmd.upgrade.dummy_container

Bases: object

__dict__ = mappingproxy({'__module__': 'fastr.utils.cmd.upgrade', '__getitem__': <function dummy_container.__getitem__>, '__dict__': <attribute '__dict__' of 'dummy_container' objects>, '__weakref__': <attribute '__weakref__' of 'dummy_container' objects>, '__doc__': None})

__getitem__(value)

__module__ = 'fastr.utils.cmd.upgrade'

__weakref__

list of weak references to the object (if defined)

fastr.utils.cmd.upgrade.find_tool(toolspec)

fastr.utils.cmd.upgrade.get_parser()

fastr.utils.cmd.upgrade.main()

Upgrade a fastr 2.x python file to fastr 3.x syntax

fastr.utils.cmd.upgrade.upgrade_network(infile, outfile)

fastr.utils.cmd.upgrade.upgrade_tool(infile, outfile)

verify Module

fastr.utils.cmd.verify.get_parser()

fastr.utils.cmd.verify.main()

Verify fastr resources, at the moment only tool definitions are supported.

webapp Module

fastr.utils.cmd.webapp.get_parser()

fastr.utils.cmd.webapp.main()

Start the fastr webapp and open in a new browser tab

fastr.utils.cmd.webapp.open_url(url)