verify_menu_config Namespace Reference

Functions
def	verify (config, trigger_level)
def	load_and_verify (file_path, trigger_level)
def	paths_starting_with (prefix)

Variables
	log
	parser
	description
	individual
	title
	help
	args
	results
	json_files
	any_failures
	success_plural
	failure_plural

Function Documentation

load_and_verify()

def verify_menu_config.load_and_verify	(		file_path,
			trigger_level
	)

Definition at line 41 of file verify_menu_config.py.

def load_and_verify(file_path, trigger_level):
    if not os.path.isfile(file_path):
        log.error("'{}' does not exist".format(file_path))
    elif not os.path.splitext(file_path)[1] == ".json":
        log.error("'{}' is not a JSON file".format(file_path))
    else:
        with open(file_path, "r") as config_file:
            config = json.load(config_file, object_pairs_hook = odict)
 
        return verify(config, trigger_level)
 
    return {"successes": [], "failures": []}
 
 

paths_starting_with()

def verify_menu_config.paths_starting_with

(

prefix

)

Definition at line 75 of file verify_menu_config.py.

        def paths_starting_with(prefix):
            return [args.folder + os.sep + f
                    for f in json_files if f.startswith(prefix)]
 

verify()

def verify_menu_config.verify	(		config,
			trigger_level
	)

Run all consistency checks for the trigger on the config.

Definition at line 23 of file verify_menu_config.py.

def verify(config, trigger_level):
    '''
    Run all consistency checks for the trigger on the config.
    '''
    tests = menu_tests[trigger_level]
    for test in tests:
        test.run(config)
 
    successes = []
    failures = []
    for test in tests:
        if test.failures:
            failures.append(test)
        else:
            successes.append(test)
    return { "successes": successes, "failures": failures }
 
 

Variable Documentation

any_failures

verify_menu_config.any_failures

Definition at line 94 of file verify_menu_config.py.

args

verify_menu_config.args

Definition at line 65 of file verify_menu_config.py.

description

verify_menu_config.description

Definition at line 57 of file verify_menu_config.py.

failure_plural

verify_menu_config.failure_plural

Definition at line 98 of file verify_menu_config.py.

help

verify_menu_config.help

Definition at line 61 of file verify_menu_config.py.

individual

verify_menu_config.individual

Definition at line 58 of file verify_menu_config.py.

json_files

verify_menu_config.json_files

Definition at line 73 of file verify_menu_config.py.

log

verify_menu_config.log

Definition at line 21 of file verify_menu_config.py.

parser

verify_menu_config.parser

Definition at line 56 of file verify_menu_config.py.

results

verify_menu_config.results

Definition at line 67 of file verify_menu_config.py.

success_plural

verify_menu_config.success_plural

Definition at line 96 of file verify_menu_config.py.

title

verify_menu_config.title

Definition at line 59 of file verify_menu_config.py.