job

This module contains the following classes:

• Job, representing a job;
• JobConfiguration, representing a job configuration.

class aeneas.job.Job(config_string=None, rconf=None, logger=None)

A structure representing a job, that is, a collection of related Tasks.

Parameters:

• config_string (string) – the job configuration string
• rconf (RuntimeConfiguration) – a runtime configuration
• logger (Logger) – the logger object

Raises:

TypeError: if config_string is not None and not a Unicode string

add_task(task)

Add a task to this job.

Parameters:task (Task) – the task to be added

clear_tasks()

Delete all the tasks of this job.

identifier

The identifier of the job.

Return type:string

class aeneas.job.JobConfiguration(config_string=None)

A structure representing a configuration for a job, that is, a series of directives for I/O and processing the job.

Allowed keys:

• PPN_JOB_DESCRIPTION or description
• PPN_JOB_LANGUAGE or language
• PPN_JOB_IS_AUDIO_FILE_NAME_REGEX or i_a_name_regex
• PPN_JOB_IS_AUDIO_FILE_RELATIVE_PATH or i_a_relative_path
• PPN_JOB_IS_HIERARCHY_PREFIX or i_hierarchy_prefix
• PPN_JOB_IS_HIERARCHY_TYPE or i_hierarchy_type
• PPN_JOB_IS_TASK_DIRECTORY_NAME_REGEX or i_task_directory_name_regex
• PPN_JOB_IS_TEXT_FILE_NAME_REGEX or i_t_name_regex
• PPN_JOB_IS_TEXT_FILE_RELATIVE_PATH or i_t_relative_path
• PPN_JOB_OS_CONTAINER_FORMAT or o_container_format
• PPN_JOB_OS_FILE_NAME or o_name
• PPN_JOB_OS_HIERARCHY_PREFIX or o_hierarchy_prefix
• PPN_JOB_OS_HIERARCHY_TYPE or o_hierarchy_type

Parameters:config_string (string) – the job configuration string Raises:TypeError: if config_string is not None and it is not a Unicode string Raises:KeyError: if trying to access a key not listed above