cwltool.load_tool

Loads a CWL document.

Module Contents

Functions

default_loader(fetcher_constructor = None, enable_dev = False, doc_cache = True)

resolve_tool_uri(argsworkflow, resolver = None, fetcher_constructor = None, document_loader = None)

fetch_document(argsworkflow, loadingContext = None)

Retrieve a CWL document.

resolve_and_validate_document(loadingContext, workflowobj, uri, preprocess_only = False, skip_schemas = None)

Validate a CWL document.

make_tool(uri, loadingContext)

Make a Python CWL object.

load_tool(argsworkflow, loadingContext = None)

resolve_overrides(ov, ov_uri, baseurl)

load_overrides(ov, base_url)

recursive_resolve_and_validate_document(loadingContext, workflowobj, uri, preprocess_only = False, skip_schemas = None)

Validate a CWL document, checking that a tool object can be built.

Attributes

jobloaderctx

overrides_ctx

cwltool.load_tool.jobloaderctx :ContextType
cwltool.load_tool.overrides_ctx :ContextType
cwltool.load_tool.default_loader(fetcher_constructor=None, enable_dev=False, doc_cache=True)
Parameters
  • fetcher_constructor (Optional[schema_salad.utils.FetcherCallableType]) –

  • enable_dev (bool) –

  • doc_cache (bool) –

Return type

schema_salad.ref_resolver.Loader

cwltool.load_tool.resolve_tool_uri(argsworkflow, resolver=None, fetcher_constructor=None, document_loader=None)
Parameters
  • argsworkflow (str) –

  • resolver (Optional[cwltool.utils.ResolverType]) –

  • fetcher_constructor (Optional[schema_salad.utils.FetcherCallableType]) –

  • document_loader (Optional[schema_salad.ref_resolver.Loader]) –

Return type

Tuple[str, str]

cwltool.load_tool.fetch_document(argsworkflow, loadingContext=None)

Retrieve a CWL document.

Parameters
Return type

Tuple[cwltool.context.LoadingContext, ruamel.yaml.comments.CommentedMap, str]

cwltool.load_tool.resolve_and_validate_document(loadingContext, workflowobj, uri, preprocess_only=False, skip_schemas=None)

Validate a CWL document.

Parameters
  • loadingContext (cwltool.context.LoadingContext) –

  • workflowobj (Union[ruamel.yaml.comments.CommentedMap, ruamel.yaml.comments.CommentedSeq]) –

  • uri (str) –

  • preprocess_only (bool) –

  • skip_schemas (Optional[bool]) –

Return type

Tuple[cwltool.context.LoadingContext, str]

cwltool.load_tool.make_tool(uri, loadingContext)

Make a Python CWL object.

Parameters
Return type

cwltool.process.Process

cwltool.load_tool.load_tool(argsworkflow, loadingContext=None)
Parameters
Return type

cwltool.process.Process

cwltool.load_tool.resolve_overrides(ov, ov_uri, baseurl)
Parameters
  • ov (schema_salad.utils.IdxResultType) –

  • ov_uri (str) –

  • baseurl (str) –

Return type

List[cwltool.utils.CWLObjectType]

cwltool.load_tool.load_overrides(ov, base_url)
Parameters
  • ov (str) –

  • base_url (str) –

Return type

List[cwltool.utils.CWLObjectType]

cwltool.load_tool.recursive_resolve_and_validate_document(loadingContext, workflowobj, uri, preprocess_only=False, skip_schemas=None)

Validate a CWL document, checking that a tool object can be built.

Parameters
  • loadingContext (cwltool.context.LoadingContext) –

  • workflowobj (Union[ruamel.yaml.comments.CommentedMap, ruamel.yaml.comments.CommentedSeq]) –

  • uri (str) –

  • preprocess_only (bool) –

  • skip_schemas (Optional[bool]) –

Return type

Tuple[cwltool.context.LoadingContext, str, cwltool.process.Process]