scripts.render.glog_check Namespace Reference

Classes
class	bcolors

Functions
def	green (msg)
def	yellow (msg)
def	red (msg)
def	check (condition, message=None)
def	build_check_message (o1, o2, type, message=None)
def	check_eq (o1, o2, message=None)
def	check_ne (o1, o2, message=None)
def	check_ge (o1, o2, message=None)
def	check_gt (o1, o2, message=None)
def	check_le (o1, o2, message=None)
def	check_lt (o1, o2, message=None)

Function Documentation

build_check_message()

def scripts.render.glog_check.build_check_message	(		o1,
			o2,
			type,
			message = None
	)

Constructs failure message for validation.

Args:
    o1 (comparable): Any comparable value.
    o1 (comparable): Any value comparable to o1.
    type (str): String representation of the comparison performed.
    message (str, optional): Message to display if comparison fails.

Returns:
    str: Failure message.

check()

def scripts.render.glog_check.check	(		condition,
			message = None
	)

Produces a message if the condition does not hold.

Args:
    condition (bool): The condition to be verified.
    message (str, optional): Text to be displayed if the condition fails.

check_eq()

def scripts.render.glog_check.check_eq	(		o1,
			o2,
			message = None
	)

Validates o1 == o2. Produces error message if not.

Args:
    o1 (comparable): Any comparable value.
    o1 (comparable): Any value comparable to o1.
    message (str, optional): Message to display if comparison fails.

check_ge()

def scripts.render.glog_check.check_ge	(		o1,
			o2,
			message = None
	)

Validates o1 >= o2. Produces error message if not.

Args:
    o1 (comparable): Any comparable value.
    o1 (comparable): Any value comparable to o1.
    message (str, optional): Message to display if comparison fails.

check_gt()

def scripts.render.glog_check.check_gt	(		o1,
			o2,
			message = None
	)

Validates o1 > o2. Produces error message if not.

Args:
    o1 (comparable): Any comparable value.
    o1 (comparable): Any value comparable to o1.
    message (str, optional): Message to display if comparison fails.

check_le()

def scripts.render.glog_check.check_le	(		o1,
			o2,
			message = None
	)

Validates o1 <= o2. Produces error message if not.

Args:
    o1 (comparable): Any comparable value.
    o1 (comparable): Any value comparable to o1.
    message (str, optional): Message to display if comparison fails.

check_lt()

def scripts.render.glog_check.check_lt	(		o1,
			o2,
			message = None
	)

Validates o1 < o2. Produces error message if not.

Args:
    o1 (comparable): Any comparable value.
    o1 (comparable): Any value comparable to o1.
    message (str, optional): Message to display if comparison fails.

check_ne()

def scripts.render.glog_check.check_ne	(		o1,
			o2,
			message = None
	)

Validates o1 != o2. Produces error message if not.

Args:
    o1 (comparable): Any comparable value.
    o1 (comparable): Any value comparable to o1.
    message (str, optional): Message to display if comparison fails.

green()

def scripts.render.glog_check.green

(

msg

)

red()

def scripts.render.glog_check.red

(

msg

)

yellow()

def scripts.render.glog_check.yellow

(

msg

)