python_utils.jobset.Jobset Class Reference

Inheritance diagram for python_utils.jobset.Jobset:

Public Member Functions
def	__init__ (self, check_cancelled, maxjobs, maxjobs_cpu_agnostic, newline_on_success, travis, stop_on_failure, add_env, quiet_success, max_time)
def	cancelled (self)
def	cpu_cost (self)
def	finish (self)
def	get_num_failures (self)
def	reap (self, waiting_for=None, waiting_for_cost=None)
def	set_remaining (self, remaining)
def	start (self, spec)

Public Attributes
	resultset

Private Attributes
	_add_env
	_cancelled
	_check_cancelled
	_completed
	_failures
	_max_time
	_maxjobs
	_maxjobs_cpu_agnostic
	_newline_on_success
	_quiet_success
	_remaining
	_running
	_start_time
	_stop_on_failure
	_travis

Detailed Description

Manages one run of jobs.

Definition at line 423 of file jobset.py.

Constructor & Destructor Documentation

__init__()

def python_utils.jobset.Jobset.__init__	(		self,
			check_cancelled,
			maxjobs,
			maxjobs_cpu_agnostic,
			newline_on_success,
			travis,
			stop_on_failure,
			add_env,
			quiet_success,
			max_time
	)

Definition at line 426 of file jobset.py.

Member Function Documentation

cancelled()

def python_utils.jobset.Jobset.cancelled

(

self

)

Poll for cancellation.

Definition at line 533 of file jobset.py.

cpu_cost()

def python_utils.jobset.Jobset.cpu_cost

(

self

)

Definition at line 452 of file jobset.py.

finish()

def python_utils.jobset.Jobset.finish

(

self

)

Definition at line 544 of file jobset.py.

get_num_failures()

def python_utils.jobset.Jobset.get_num_failures

(

self

)

Definition at line 449 of file jobset.py.

reap()

def python_utils.jobset.Jobset.reap	(		self,
			waiting_for = None,
			waiting_for_cost = None
	)

Collect the dead jobs.

Definition at line 486 of file jobset.py.

set_remaining()

def python_utils.jobset.Jobset.set_remaining	(		self,
			remaining
	)

Definition at line 446 of file jobset.py.

start()

def python_utils.jobset.Jobset.start	(		self,
			spec
	)

Start a job. Return True on success, False on failure.

Definition at line 458 of file jobset.py.

Member Data Documentation

_add_env

python_utils.jobset.Jobset._add_env

private

Definition at line 437 of file jobset.py.

_cancelled

python_utils.jobset.Jobset._cancelled

private

Definition at line 429 of file jobset.py.

_check_cancelled

python_utils.jobset.Jobset._check_cancelled

private

Definition at line 428 of file jobset.py.

_completed

python_utils.jobset.Jobset._completed

private

Definition at line 431 of file jobset.py.

_failures

python_utils.jobset.Jobset._failures

private

Definition at line 430 of file jobset.py.

_max_time

python_utils.jobset.Jobset._max_time

private

Definition at line 439 of file jobset.py.

_maxjobs

python_utils.jobset.Jobset._maxjobs

private

Definition at line 432 of file jobset.py.

_maxjobs_cpu_agnostic

python_utils.jobset.Jobset._maxjobs_cpu_agnostic

private

Definition at line 433 of file jobset.py.

_newline_on_success

python_utils.jobset.Jobset._newline_on_success

private

Definition at line 434 of file jobset.py.

_quiet_success

python_utils.jobset.Jobset._quiet_success

private

Definition at line 438 of file jobset.py.

_remaining

python_utils.jobset.Jobset._remaining

private

Definition at line 441 of file jobset.py.

_running

python_utils.jobset.Jobset._running

private

Definition at line 427 of file jobset.py.

_start_time

python_utils.jobset.Jobset._start_time

private

Definition at line 442 of file jobset.py.

_stop_on_failure

python_utils.jobset.Jobset._stop_on_failure

private

Definition at line 436 of file jobset.py.

_travis

python_utils.jobset.Jobset._travis

private

Definition at line 435 of file jobset.py.

resultset

python_utils.jobset.Jobset.resultset

Definition at line 440 of file jobset.py.

---

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

• jobset.py