web Package

web Package

api Module

class fastr.web.api.NetworkApi(api=None, *args, **kwargs)

Bases: flask_restplus.resource.Resource

__module__ = 'fastr.web.api'

endpoint = 'api_network'

get(id_)

Get a Network json description from the server

mediatypes()

methods = {'GET'}

class fastr.web.api.NetworkListApi(api=None, *args, **kwargs)

Bases: flask_restplus.resource.Resource

__module__ = 'fastr.web.api'

endpoint = 'api_networks'

get()

Get a list of the networks

mediatypes()

methods = {'GET'}

class fastr.web.api.ObjectUrl(object_classs, **kwargs)

Bases: flask_restplus.fields.Raw

__init__(object_classs, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'fastr.web.api'

__schema_type__ = 'string'

__slotnames__ = []

format(value)

Formats a field’s value. No-op by default - field classes that modify how the value of existing object keys should be presented should override this and apply the appropriate formatting.

Parameters

value – The value to format

Raises

MarshallingError – In case of formatting problem

Ex:

class TitleCase(Raw):
    def format(self, value):
        return unicode(value).title()

class fastr.web.api.Run(id_, network, source_data, sink_data)

Bases: object

__dict__ = mappingproxy({'__module__': 'fastr.web.api', '__init__': <function Run.__init__>, 'run_network': <function Run.run_network>, 'status': <function Run.status>, 'abort': <function Run.abort>, '__dict__': <attribute '__dict__' of 'Run' objects>, '__weakref__': <attribute '__weakref__' of 'Run' objects>, '__doc__': None})

__init__(id_, network, source_data, sink_data)

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'fastr.web.api'

__weakref__

list of weak references to the object (if defined)

abort()

run_network(network, source_data, sink_data, abort_lock)

status()

class fastr.web.api.RunApi(api=None, *args, **kwargs)

Bases: flask_restplus.resource.Resource

Run API documentation

__module__ = 'fastr.web.api'

delete(id_)

Abort a Network run and stop all associated execution

endpoint = 'api_run'

get(id_)

Get information about a Network run

mediatypes()

methods = {'DELETE', 'GET'}

class fastr.web.api.RunListApi(api=None, *args, **kwargs)

Bases: flask_restplus.resource.Resource

__module__ = 'fastr.web.api'

endpoint = 'api_runs'

get()

Get a list of all Network runs on the server

mediatypes()

methods = {'GET', 'POST'}

post()

Create a new Network run and start execution

request_parser = <flask_restplus.reqparse.RequestParser object>

class fastr.web.api.StatusApi(api=None, *args, **kwargs)

Bases: flask_restplus.resource.Resource

__module__ = 'fastr.web.api'

endpoint = 'api_status'

get(id_)

Get the status of a Network Run on the server

mediatypes()

methods = {'GET'}

class fastr.web.api.SubUrl(object_classs, subfield, **kwargs)

Bases: flask_restplus.fields.Raw

__init__(object_classs, subfield, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

__module__ = 'fastr.web.api'

__schema_type__ = 'string'

format(value)

Formats a field’s value. No-op by default - field classes that modify how the value of existing object keys should be presented should override this and apply the appropriate formatting.

Parameters

value – The value to format

Raises

MarshallingError – In case of formatting problem

Ex:

class TitleCase(Raw):
    def format(self, value):
        return unicode(value).title()

class fastr.web.api.ToolApi(api=None, *args, **kwargs)

Bases: flask_restplus.resource.Resource

__module__ = 'fastr.web.api'

endpoint = 'api_version_tool'

get(id_, version=None)

Get a Tool json description from the server

mediatypes()

methods = {'GET'}

class fastr.web.api.ToolListApi(api=None, *args, **kwargs)

Bases: flask_restplus.resource.Resource

__module__ = 'fastr.web.api'

endpoint = 'api_tools'

get()

Get a list of all Tools known to the server

mediatypes()

methods = {'GET'}

fastr.web.api.network_lock_thread(lock, network)

fastr.web.api.network_runner(network, source_data, sink_data, chuck_status, job_status, job_results, abort_lock)

fastr.web.api.update_job_result(job, job_status, job_results)

fastr.web.api.update_status(job, job_status)

run Module

fastr.web.run.main()

fastr.web.run.runapp(debug=False)

views Module

fastr.web.views.doc()

fastr.web.views.index()

fastr.web.views.network(name=None)

fastr.web.views.networks()

fastr.web.views.prov()

fastr.web.views.shutdown()

fastr.web.views.shutdown_server()

fastr.web.views.tool(toolname=None, version=None)

fastr.web.views.websocket_client()