web Package¶
web
Package¶
api
Module¶
-
class
fastr.web.api.
NetworkApi
(api=None, *args, **kwargs)[source]¶ Bases:
flask_restplus.resource.Resource
-
__module__
= 'fastr.web.api'¶
-
endpoint
= 'api_network'¶
-
mediatypes
()¶
-
methods
= {'GET'}¶
-
-
class
fastr.web.api.
NetworkListApi
(api=None, *args, **kwargs)[source]¶ Bases:
flask_restplus.resource.Resource
-
__module__
= 'fastr.web.api'¶
-
endpoint
= 'api_networks'¶
-
mediatypes
()¶
-
methods
= {'GET'}¶
-
-
class
fastr.web.api.
ObjectUrl
(object_classs, **kwargs)[source]¶ Bases:
flask_restplus.fields.Raw
-
__init__
(object_classs, **kwargs)[source]¶ Initialize self. See help(type(self)) for accurate signature.
-
__module__
= 'fastr.web.api'¶
-
__schema_type__
= 'string'¶
-
__slotnames__
= []¶
-
format
(value)[source]¶ 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)[source]¶ 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)[source]¶ Initialize self. See help(type(self)) for accurate signature.
-
__module__
= 'fastr.web.api'¶
-
__weakref__
¶ list of weak references to the object (if defined)
-
-
class
fastr.web.api.
RunApi
(api=None, *args, **kwargs)[source]¶ Bases:
flask_restplus.resource.Resource
Run API documentation
-
__module__
= 'fastr.web.api'¶
-
endpoint
= 'api_run'¶
-
mediatypes
()¶
-
methods
= {'DELETE', 'GET'}¶
-
-
class
fastr.web.api.
RunListApi
(api=None, *args, **kwargs)[source]¶ Bases:
flask_restplus.resource.Resource
-
__module__
= 'fastr.web.api'¶
-
endpoint
= 'api_runs'¶
-
mediatypes
()¶
-
methods
= {'GET', 'POST'}¶
-
request_parser
= <flask_restplus.reqparse.RequestParser object>¶
-
-
class
fastr.web.api.
StatusApi
(api=None, *args, **kwargs)[source]¶ Bases:
flask_restplus.resource.Resource
-
__module__
= 'fastr.web.api'¶
-
endpoint
= 'api_status'¶
-
mediatypes
()¶
-
methods
= {'GET'}¶
-
-
class
fastr.web.api.
SubUrl
(object_classs, subfield, **kwargs)[source]¶ Bases:
flask_restplus.fields.Raw
-
__init__
(object_classs, subfield, **kwargs)[source]¶ Initialize self. See help(type(self)) for accurate signature.
-
__module__
= 'fastr.web.api'¶
-
__schema_type__
= 'string'¶
-
format
(value)[source]¶ 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)[source]¶ Bases:
flask_restplus.resource.Resource
-
__module__
= 'fastr.web.api'¶
-
endpoint
= 'api_version_tool'¶
-
mediatypes
()¶
-
methods
= {'GET'}¶
-
-
class
fastr.web.api.
ToolListApi
(api=None, *args, **kwargs)[source]¶ Bases:
flask_restplus.resource.Resource
-
__module__
= 'fastr.web.api'¶
-
endpoint
= 'api_tools'¶
-
mediatypes
()¶
-
methods
= {'GET'}¶
-