idstools.utils.clihelper

Module Contents

idstools.utils.clihelper.get_backend_id(name)[source]

The function get_backend_id returns the value of the attribute from the module ids_defs.

Parameters:
name

The name parameter is a string representing the name of a backend system in the code.

Returns:

The code snippet is defining a function called get_backend_id that takes a parameter name.

Inside the function, it uses the getattr function to dynamically access an attribute from the module ids_defs based on the value of name with the suffix “_BACKEND”. The value of this attribute is then returned by the function.

idstools.utils.clihelper.get_database_path(imasargs, time_value=None) → str[source]

The function get_database_path returns the absolute path of a database based on the provided arguments.

Parameters:
imasargs

The imasargs parameter is an object or dictionary that contains the following attributes:

Returns:

the absolute path of the database.

idstools.utils.clihelper.get_details_from_uri(uri)[source]

The function get_details_from_uri extracts specific details from a URI string using regular expressions and returns them in a dictionary format.

Parameters:
uri

The function get_details_from_uri takes a URI as input and extracts various parameters from

it. The parameters it extracts are:

Returns:

The function get_details_from_uri returns a dictionary containing details extracted from the

provided URI string. The dictionary includes information such as user, database, version, backend, shot, pulse, run, path, and flags indicating the presence of certain parameters.

idstools.utils.clihelper.get_file_name(imasargs, title='', time_value=None)[source]
idstools.utils.clihelper.get_slice_mode(name)[source]

The function get_slice_mode returns the interpolation mode for a given name from the ids_defs module.

Parameters:
name

Thank you for providing the code snippet. Could you please provide the value of the name

parameter so that I can assist you further with the get_slice_mode function?

Returns:

The get_slice_mode function is returning the value of the attribute with the name

{name}_INTERP from the ids_defs module.

idstools.utils.clihelper.get_title(imasargs, title='', time_value=None)[source]
idstools.utils.clihelper.db_group
idstools.utils.clihelper.dbentry_parser
idstools.utils.clihelper.imas_parser
idstools.utils.clihelper.rcparam_parser
idstools.utils.clihelper.uri_parser