carputils.job.serialise Namespace Reference

Functions
def	filename (directory, name)
	Generate a filename for the serialised function. More...
def	serialise_function (function, directory='.')
	Serialise the provided function, placing it in the specified directory. More...
def	execute_serialised_function (filename)
	Load and execute the serialised function. More...

Variables
	EXECSCRIPT = __file__
	parser = argparse.ArgumentParser('Run a serialised Python function')
	help
	args = parser.parse_args()

Function Documentation

execute_serialised_function()

def carputils.job.serialise.execute_serialised_function

(

filename

)

Load and execute the serialised function.

Parameters

filename str Path of the serialised function

filename()

def carputils.job.serialise.filename	(		directory,
			name
	)

Generate a filename for the serialised function.

Parameters

directory str Path of the directory to place the function in name str Name of the function

Returns

str Path of a file that does not yet exist

serialise_function()

def carputils.job.serialise.serialise_function	(		function,
			directory = '.'
	)

Serialise the provided function, placing it in the specified directory.

Parameters

function function The function to serialise directory str, optional The directory to place the serialised function in

Returns

str The filename of the serialised function

Variable Documentation

args

carputils.job.serialise.args = parser.parse_args()

EXECSCRIPT

carputils.job.serialise.EXECSCRIPT = __file__

help

carputils.job.serialise.help

parser

carputils.job.serialise.parser = argparse.ArgumentParser('Run a serialised Python function')