A dummy component that just prints some information instead of executing a program. More...
Public Member Functions | |
__init__ (self, **kwargs) | |
execute (self, log_out=sys.stdout, log_err=sys.stderr) | |
Generic component execution method. | |
![]() | |
cmd_line_str (self) | |
cmd_exists (self) | |
Check if the component's assigned command exists. | |
cmd_args (self) | |
Return the command arguments of this component. | |
cmd_args_str (self) | |
Return list of arguments, making sure they are all converted to strings. | |
setup (self) | |
Perform any necessary setup for this component to run such as making symlinks to required directories. | |
cleanup (self) | |
Perform post-job cleanup such as deleting temporary files. | |
config_logging (self, parser) | |
Configure the logging for a component. | |
config (self, parser) | |
Automatic configuration. | |
set_parameters (self, params) | |
Set class attributes for the component based on JSON parameters. | |
required_parameters (self) | |
Return a list of required parameters. | |
optional_parameters (self) | |
Return a list of optional parameters. | |
required_config (self) | |
Return a list of required configuration settings. | |
check_config (self) | |
Raise an exception on the first missing config setting for this component. | |
input_files (self) | |
Get a list of input files for this component. | |
output_files (self) | |
Return a list of output files created by this component. | |
config_from_environ (self) | |
Configure component from environment variables which are just upper case versions of the required config names set in the shell environment. | |
Additional Inherited Members | |
![]() | |
name | |
command | |
nevents | |
seed | |
inputs | |
outputs | |
append_tok | |
output_ext | |
ignore_job_params | |
hpsmc_dir | |
logger | |
![]() | |
_inputs_to_outputs (self) | |
This is the default method for automatically transforming input file names to outputs when output file names are not explicitly provided. | |
A dummy component that just prints some information instead of executing a program.
Definition at line 243 of file component.py.
__init__ | ( | self, | |
** | kwargs | ||
) |
Reimplemented from Component.
Definition at line 246 of file component.py.
execute | ( | self, | |
log_out = sys.stdout , |
|||
log_err = sys.stderr |
|||
) |
Generic component execution method.
Individual components may override this if specific behavior is required.
log_out | name of log file for output |
log_err | name of log file for error |
Reimplemented from Component.
Definition at line 249 of file component.py.