carputils.clean Namespace Reference

Functions for cleaning directories and manage overwrite behavior. More...

Functions
def	clean_directory (filelist=None, globstr=None, regex=None)
	Remove the specified files. More...
def	overwrite_mode_prompt (name, directory)
def	overwrite_mode_error (name, directory)
def	overwrite_check (name, mode='prompt')
	Make sure the user does not overwrite an existing output directory. More...

Variables
bool	OVERWRITE_CHECK = True
bool	CLEAN_BATCH = False
int	CLEAN_REMOVED_COUNT = 0
dictionary	OVERWRITE_MODES

Detailed Description

Functions for cleaning directories and manage overwrite behavior.

Function Documentation

clean_directory()

def carputils.clean.clean_directory	(		filelist = None,
			globstr = None,
			regex = None
	)

Remove the specified files.

This convenience method is provided to minimise duplication of directory cleanup code in run scripts. Files and directories can be specified by an explicit list, glob expression or regular expression. The user is prompted with a list of files to be removed before anything is done. Exits the program when done.

Parameters

filelist	list of str List of file and directory names to be removed.
globstr	str Glob expression (e.g. 'output_*' to match files and directories for removal).
regex	str Regular expression (e.g. '^output_\\d{4}') to match files and directories for removal.

overwrite_check()

def carputils.clean.overwrite_check	(		name,
			mode = 'prompt'
	)

Make sure the user does not overwrite an existing output directory.

Parameters

simID	str The simulation output directory.
mode	str, optional The overwrite mode - one of 'append','prompt', 'error', 'delete' or 'overwrite'

overwrite_mode_error()

def carputils.clean.overwrite_mode_error	(		name,
			directory
	)

overwrite_mode_prompt()

def carputils.clean.overwrite_mode_prompt	(		name,
			directory
	)

Variable Documentation

CLEAN_BATCH

bool carputils.clean.CLEAN_BATCH = False

CLEAN_REMOVED_COUNT

int carputils.clean.CLEAN_REMOVED_COUNT = 0

OVERWRITE_CHECK

bool carputils.clean.OVERWRITE_CHECK = True

OVERWRITE_MODES

dictionary carputils.clean.OVERWRITE_MODES

Initial value:

=  {'prompt':    overwrite_mode_prompt,
                   'error':     overwrite_mode_error,
                   'delete':    lambda n, d: True,
                   'overwrite': lambda n, d: False,
                   'append':    lambda n, d: False}