Skip to main content
show_environment(environment_name=”, options=)[source]

Shows information about a specified user-defined function (UDF) environment or all environments. Returns detailed information about existing environments.

Parameters

environment_name (str) –

Name of the environment on which to retrieve information. The name must refer to a currently existing environment. If ‘*’ or an empty value is specified, information about all environments will be returned. The default value is ‘’.

options (dict of str to str) –

Optional parameters. Allowed keys are:

  • no_error_if_not_exists – If true and if the environment specified in input parameter environment_name does not exist, no error is returned. If false and if the environment specified in input parameter environment_name does not exist, then an error is returned. Allowed values are:

    • true

    • false

    The default value is ‘false’.

  • show_names_only – If true only return the names of the installed environments and omit package listing. Allowed values are:

    • true

    • false

    The default value is ‘false’.

The default value is an empty dict ( ).

Returns

A dict with the following entries–

environment_names (list of str) –

A list of all environment names.

packages (list of lists of str) –

Information about the installed packages in the respective environments in output parameter environment_names.

info (dict of str to str) –

Additional information.