Skip to main content
show_proc(proc_name=, options=)[source]

Shows information about a proc.

Parameters

proc_name (str) –

Name of the proc to show information about. If specified, must be the name of a currently existing proc. If not specified, information about all procs will be returned. The default value is ‘’.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • include_files – If set to true, the files that make up the proc will be returned. If set to false, the files will not be returned. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

proc_names (list of str) –

The proc names.

execution_modes (list of str) –

The execution modes of the procs named in output parameter proc_names. Allowed values are:

  • distributed – Distributed

  • nondistributed – Nondistributed

files (list of dicts of str to bytes) –

Maps of the files that make up the procs named in output parameter proc_names.

commands (list of str) –

The commands (excluding arguments) that will be invoked when the procs named in output parameter proc_names are executed.

args (list of lists of str) –

Arrays of command-line arguments that will be passed to the procs named in output parameter proc_names when executed.

options (list of dicts of str to str) –

The optional parameters for the procs named in output parameter proc_names.

info (dict of str to str) –

Additional information.