checkDictionaryUpdate Namespace Reference

Functions
def	main (args)
def	policyChecks (document)
def	updatePolicyChecks (reference, update)

Variables
	action
	args
	DATAFORMATS_CHANGED
	description
	help
	NO_CHANGES
	parser
	POLICY_VIOLATION
	required
	str
	True
	type

Function Documentation

main()

def checkDictionaryUpdate.main

(

args

)

Definition at line 22 of file checkDictionaryUpdate.py.

References policyChecks(), print(), and updatePolicyChecks().

def main(args):
    with open(args.baseline) as f:
        baseline = json.load(f)

    if args.pr is not None:
        with open(args.pr) as f:
            pr = json.load(f)
        pc1 = policyChecks(pr)
        if baseline != pr:
            pc2 = updatePolicyChecks(baseline, pr)
            if not (pc1 and pc2):
                return POLICY_VIOLATION

            print("Changes in persistable data formats")
            return DATAFORMATS_CHANGED
        if not pc1:
            return POLICY_VIOLATION
    else:
        if not policyChecks(baseline):
            return POLICY_VIOLATION

    return NO_CHANGES

policyChecks()

def checkDictionaryUpdate.policyChecks

(

document

)

Check policies on dictionary definitions. Return True if checks are fine.

Definition at line 12 of file checkDictionaryUpdate.py.

Referenced by main().

def policyChecks(document):
    """Check policies on dictionary definitions. Return True if checks are fine."""
    # Contents to be added later
    return True

updatePolicyChecks()

def checkDictionaryUpdate.updatePolicyChecks	(		reference,
			update
	)

Check policies on dictionary updates. Return True if checks are fine.

Definition at line 17 of file checkDictionaryUpdate.py.

Referenced by main().

def updatePolicyChecks(reference, update):
    """Check policies on dictionary updates. Return True if checks are fine."""
    # Contents to be added later
    return True

Variable Documentation

action

checkDictionaryUpdate.action

Definition at line 50 of file checkDictionaryUpdate.py.

args

checkDictionaryUpdate.args

Definition at line 52 of file checkDictionaryUpdate.py.

DATAFORMATS_CHANGED

checkDictionaryUpdate.DATAFORMATS_CHANGED

Definition at line 9 of file checkDictionaryUpdate.py.

description

checkDictionaryUpdate.description

Definition at line 46 of file checkDictionaryUpdate.py.

help

checkDictionaryUpdate.help

Definition at line 48 of file checkDictionaryUpdate.py.

NO_CHANGES

checkDictionaryUpdate.NO_CHANGES

Definition at line 8 of file checkDictionaryUpdate.py.

parser

checkDictionaryUpdate.parser

Definition at line 46 of file checkDictionaryUpdate.py.

POLICY_VIOLATION

checkDictionaryUpdate.POLICY_VIOLATION

Definition at line 10 of file checkDictionaryUpdate.py.

required

checkDictionaryUpdate.required

Definition at line 48 of file checkDictionaryUpdate.py.

str

checkDictionaryUpdate.str

Definition at line 48 of file checkDictionaryUpdate.py.

True

checkDictionaryUpdate.True

Definition at line 48 of file checkDictionaryUpdate.py.

type

checkDictionaryUpdate.type

Definition at line 48 of file checkDictionaryUpdate.py.