Functions
def	add_par_entry (the_dict, the_key, val_to_add)

def	add_sect_entry (filename, sect_key, the_dict, the_key, val_to_add)

def	get_sect_key (line)

def	is_section_header (line)

def	is_key_valid (key_str)

def	is_whole_line_comment (line)

Variables
string	SECTION_HEADER_TEXT = 'section'

list	VALID_KEYS = ['deletefiles', 'overwrite', 'use_existing', 'use_ancillary', 'odir', 'ifile']

Detailed Description

Module providing the ParReader class for reading parameter files for the
multilevel_processor.py program.

Function Documentation

def mlp.uber_par_file_reader.add_par_entry	(	the_dict,
		the_key,
		val_to_add
	)

Adds an entry to the par file part of the passed in section dictionary.

Definition at line 38 of file uber_par_file_reader.py.

def mlp.uber_par_file_reader.add_sect_entry	(	filename,
		sect_key,
		the_dict,
		the_key,
		val_to_add
	)

Adds an entry to a section dictionary.

Definition at line 47 of file uber_par_file_reader.py.

def mlp.uber_par_file_reader.get_sect_key ( line )

Returns the section name from a line of text.
The line is expected to be of the form '# section SECTION_NAME' (without the quotes).

Definition at line 69 of file uber_par_file_reader.py.

def mlp.uber_par_file_reader.is_key_valid ( key_str )

Returns True if opt is one of the valid options for Main section.

Definition at line 91 of file uber_par_file_reader.py.

def mlp.uber_par_file_reader.is_section_header ( line )

Returns True if a line is the header for a new section; returns False otherwise.

Definition at line 80 of file uber_par_file_reader.py.

def mlp.uber_par_file_reader.is_whole_line_comment ( line )

Returns True if an entire line is a comment; returns False otherwise.

Definition at line 100 of file uber_par_file_reader.py.

string SECTION_HEADER_TEXT = 'section'

Definition at line 13 of file uber_par_file_reader.py.

list VALID_KEYS = ['deletefiles', 'overwrite', 'use_existing', 'use_ancillary', 'odir', 'ifile']

Definition at line 14 of file uber_par_file_reader.py.