hpcflow.sdk.app.BaseApp#

class hpcflow.sdk.app.BaseApp(*args, **kwargs)#

Bases: object

Class to generate the hpcflow application.

Parameters:
  • module – The module name in which the app object is defined.

  • docs_import_conv – The convention for the app alias used in import statements in the documentation. E.g. for the hpcflow base app, this is hf. This is combined with module to form the complete import statement. E.g. for the hpcflow base app, the complete import statement is: import hpcflow.app as hf, where hpcflow.app is the module argument and hf is the docs_import_conv argument.

Methods

get_info

get_parameter_task_schema_map

Get a dict mapping parameter types to task schemas that input/output each parameter.

load_builtin_template_component_data

load_config

load_template_components

perm_error_retry

Return a decorator for retrying functions on permission and OS errors that might be associated with cloud-storage desktop sync.

reload_config

reload_template_components

template_components_from_json_like

Attributes

API_logger

CLI_logger

command_files

config

config_logger

envs

is_config_loaded

is_template_components_loaded

log

logger

parameters

persistence_logger

run_time_info

runtime_info_logger

scripts

task_schemas

template_components

property API_logger: Logger#
property CLI_logger: Logger#
property command_files: CommandFilesList#
property config: Config#
property config_logger: Logger#
property envs: EnvironmentsList#
get_info()#
Return type:

Dict[str, Any]

get_parameter_task_schema_map()#

Get a dict mapping parameter types to task schemas that input/output each parameter.

Return type:

Dict[str, List[List]]

property is_config_loaded: bool#
property is_template_components_loaded: bool#
classmethod load_builtin_template_component_data(package)#
Return type:

Dict[str, List | Dict]

load_config(config_dir=None, config_invocation_key=None, **overrides)#
Return type:

None

load_template_components(warn=True)#
Return type:

None

property log: AppLog#
property logger: Logger#
property parameters: ParametersList#
perm_error_retry()#

Return a decorator for retrying functions on permission and OS errors that might be associated with cloud-storage desktop sync. engine operations.

property persistence_logger: Logger#
reload_config(config_dir=None, config_invocation_key=None, **overrides)#
Return type:

None

reload_template_components(warn=True)#
Return type:

None

property run_time_info: RunTimeInfo#
property runtime_info_logger: Logger#
property scripts#
property task_schemas: TaskSchemasList#
property template_components: Dict[str, ObjectList]#
template_components_from_json_like(json_like)#
Return type:

None