cctools
Public Member Functions
work_queue.PythonTask Class Reference

Python PythonTask object. More...

Inheritance diagram for work_queue.PythonTask:
work_queue.Task

Public Member Functions

def __init__
 Creates a new python task. More...
 
def output
 returns the result of a python task as a python variable More...
 
- Public Member Functions inherited from work_queue.Task
def __init__
 Create a new task specification. More...
 
def clone
 Return a copy of this task. More...
 
def specify_command
 Set the command to be executed by the task. More...
 
def specify_algorithm
 Set the worker selection algorithm for task. More...
 
def specify_tag
 Attach a user defined logical name to the task. More...
 
def specify_category
 Label the task with the given category. More...
 
def specify_feature
 Label the task with the given user-defined feature. More...
 
def specify_preferred_host
 Indicate that the task would be optimally run on a given host. More...
 
def specify_file
 Add a file to the task. More...
 
def specify_file_command
 Add a file to the task which will be transfered with a command at the worker. More...
 
def specify_file_piece
 Add a file piece to the task. More...
 
def specify_input_file
 Add a input file to the task. More...
 
def specify_output_file
 Add a output file to the task. More...
 
def specify_directory
 Add a directory to the task. More...
 
def specify_buffer
 Add an input bufer to the task. More...
 
def specify_snapshot_file
 When monitoring, indicates a json-encoded file that instructs the monitor to take a snapshot of the task resources. More...
 
def specify_max_retries
 Indicate the number of times the task should be retried. More...
 
def specify_cores
 Indicate the number of cores required by this task. More...
 
def specify_memory
 Indicate the memory (in MB) required by this task. More...
 
def specify_disk
 Indicate the disk space (in MB) required by this task. More...
 
def specify_gpus
 Indicate the number of GPUs required by this task. More...
 
def specify_priority
 Indicate the the priority of this task (larger means better priority, default is 0). More...
 
def specify_environment_variable
 Set this environment variable before running the task. More...
 
def specify_monitor_output
 Set a name for the resource summary output directory from the monitor. More...
 
def tag
 Get the user-defined logical name for the task. More...
 
def category
 Get the category name for the task. More...
 
def command
 Get the shell command executed by the task. More...
 
def priority
 Get the priority of the task. More...
 
def algorithm
 Get the algorithm for choosing worker to run the task. More...
 
def std_output
 Get the standard output of the task. More...
 
def output
 Get the standard output of the task. More...
 
def id
 Get the task id number. More...
 
def return_status
 Get the exit code of the command executed by the task. More...
 
def result
 Get the result of the task as an integer code, such as successful, missing file, etc. More...
 
def result_str
 Return a string that explains the result of a task. More...
 
def total_submissions
 Get the number of times the task has been resubmitted internally. More...
 
def exhausted_attempts
 Get the number of times the task has been failed given resource exhaustion. More...
 
def host
 Get the address and port of the host on which the task ran. More...
 
def hostname
 Get the name of the host on which the task ran. More...
 
def submit_time
 Get the time at which this task was submitted. More...
 
def finish_time
 Get the time at which this task was finished. More...
 
def total_cmd_exhausted_execute_time
 Get the total time the task executed and failed given resource exhaustion. More...
 
def app_delay
 Get the time spent in upper-level application (outside of work_queue_wait). More...
 
def send_input_start
 Get the time at which the task started to transfer input files. More...
 
def send_input_finish
 Get the time at which the task finished transferring input files. More...
 
def execute_cmd_start
 The time at which the task began. More...
 
def execute_cmd_finish
 Get the time at which the task finished (discovered by the manager). More...
 
def receive_output_start
 Get the time at which the task started to transfer output files. More...
 
def receive_output_finish
 Get the time at which the task finished transferring output files. More...
 
def total_bytes_received
 Get the number of bytes received since task started receiving input data. More...
 
def total_bytes_sent
 Get the number of bytes sent since task started sending input data. More...
 
def total_bytes_transferred
 Get the number of bytes transferred since task started transferring input data. More...
 
def total_transfer_time
 Get the time comsumed in microseconds for transferring total_bytes_transferred. More...
 
def cmd_execution_time
 Time spent in microseconds for executing the command until completion on a single worker. More...
 
def total_cmd_execution_time
 Accumulated time spent in microseconds for executing the command on any worker, regardless of whether the task finished (i.e., this includes time running on workers that disconnected). More...
 
def resources_measured
 Get the resources measured for the task execution if resource monitoring is enabled. More...
 
def limits_exceeded
 Get the resources the task exceeded. More...
 
def resources_requested
 Get the resources the task requested to run. More...
 
def resources_allocated
 Get the resources allocated to the task in its latest attempt. More...
 

Detailed Description

Python PythonTask object.

this class is used to create a python task

Constructor & Destructor Documentation

def work_queue.PythonTask.__init__ (   self,
  func,
  args 
)

Creates a new python task.

Parameters
selfReference to the current python task object
funcpython function to be executed by task
argsarguments used in function to be executed by task

References work_queue.PythonTask._args_file, work_queue.PythonTask._command, work_queue.PythonTask._create_wrapper(), work_queue.PythonTask._env_file, work_queue.PythonTask._func_file, work_queue.PythonTask._id, work_queue.PythonTask._out_file, work_queue.PythonTask._output, work_queue.PythonTask._output_loaded, work_queue.PythonTask._pp_run, work_queue.PythonTask._python_function_command(), work_queue.PythonTask._serialize_python_function(), work_queue.PythonTask._specify_IO_files(), work_queue.PythonTask._tmpdir, and work_queue.PythonTask._wrapper.

Member Function Documentation

def work_queue.PythonTask.output (   self)

returns the result of a python task as a python variable

Parameters
selfreference to the current python task object

References work_queue.PythonTask._args_file, work_queue.PythonTask._command, work_queue.PythonTask._env_file, work_queue.PythonTask._func_file, work_queue.PythonTask._id, work_queue.PythonTask._out_file, work_queue.PythonTask._output, work_queue.PythonTask._output_loaded, work_queue.PythonTask._pp_run, work_queue.PythonTask._python_function_command(), work_queue.Task._task, work_queue.PythonTask._tmpdir, work_queue.PythonTask._wrapper, work_queue_task.result, work_queue.PythonTask.result, work_queue.Task.specify_input_file(), work_queue.Task.specify_output_file(), work_queue.Task.std_output(), and work_queue_task_specify_command().


The documentation for this class was generated from the following file: