The code a Worker actually runs to accomplish its task is in a module called a “Runnable”. At its simplest, a Runnable is a class that implements either:
- Bio::EnsEMBL::Hive::Process (Perl),
- eHive.BaseRunnable (Python), or
- org.ensembl.hive.BaseRunnable (Java).
When a Worker specialises to perform a Job, it compiles and runs the Runnable associated with the Job’s Analysis.
The base class provides a set of methods that are guaranteed to be called in order:
Note that the method names are just suggestions for the functionality to implement within them. With the exception of pre_cleanup and write_output, there is no special behaviour for these methods, except for the order in which they are run. There is no need to implement all (or indeed, any) of these methods. If nothing is provided for a method, the default is to do nothing.
There are a number of example Runnables provided with eHive. They can be found in two locations:
- Utility Runnables are located in
- Runnables associated with example pipelines can be found in the
RunnableDB/subdirectories under the example directories in
If the Job has a retry count greater than zero, then
pre_cleanup() is the first method called when a Worker runs a Job. This provides an opportunity to clean up database entries or files that may be leftover from a failed attempt to run the Job before trying again.
fetch_input() method is the first method called the first time a Job is run (if a Job has a retry count greater than zero, then pre_cleanup() will be the first method called). This method is provided to check that input parameters exist and are valid. The benefits of putting input parameter checks here include:
- Making the code easier to understand and maintain; users of the Runnable will know where to look to quickly discover which parameters are required or optional.
- If there are problems with input parameters, the Job will fail quickly.
run() method is called after
fetch_input() completes. This method is provided as a place to put the main Analysis logic of the Runnable.
write_output() method is called after
run() completes. This method is provided as a place to put statements that create dataflow events. It is generally good practice to put dataflow statements here to aid users in understanding and maintaining the Runnable.
post_healthcheck() method is called after
write_output() completes. This method is provided as a place to verify that the Runnable executed correctly.
There are two possible triggers for calling the
post_cleanup() method. It is called immediately after
post_healthcheck(), and it is called (if possible) if a Job is failing (e.g. if a die statement is reached elsewhere in the Runnable). Therefore, this method is somewhat similar to an exception handling catch block. This method should contain code performing cleanup that needs happen regardless of whether or not the Job completed successfully, such as closing database connections or filehandles.