Abstract class to evaluate and score integrity/validty. More...

Inheritance diagram for Python.Markopy.Evaluation.Evaluator:

Collaboration diagram for Python.Markopy.Evaluation.Evaluator:

Public Member Functions
None	__init__ (self, str filename)
	default constructor for evaluator More...

bool	evaluate (self)

def	success (self, checkname)
	pass a test More...

def	fail (self, checkname)
	fail a test More...

def	finalize (self)

Public Attributes
	filename

	checks

	TEST_PASS_SYMBOL

	TEST_FAIL_SYMBOL

	all_checks_passed

	files

	check_funcs

Private Member Functions
list	_evaluate (self, file)
	internal evaluation function for a single file More...

Detailed Description

Abstract class to evaluate and score integrity/validty.

Definition at line 22 of file evaluate.py.

Constructor & Destructor Documentation

◆ init()

None Python.Markopy.Evaluation.Evaluator.__init__	(		self,
		str	filename
	)

default constructor for evaluator

Parameters

filename filename to evaluate. Can be a pattern

Reimplemented in Python.Markopy.Evaluation.CorpusEvaluator, and Python.Markopy.Evaluation.ModelEvaluator.

Definition at line 27 of file evaluate.py.

     def __init__(self, filename: str) -> None:
         """! 
         @brief default constructor for evaluator
         @param filename filename to evaluate. Can be a pattern
         """
         self.filename = filename
         self.checks = []
         self.TEST_PASS_SYMBOL = b"\xe2\x9c\x85".decode()
         self.TEST_FAIL_SYMBOL = b"\xe2\x9d\x8c".decode()
         self.all_checks_passed = True
         self.files = []
         if("*" in filename):
             self.files = glob.glob(filename)
         else:
             self.files.append(filename)
         return True
  

Member Function Documentation

◆ _evaluate()

list Python.Markopy.Evaluation.Evaluator._evaluate	(	self,
		file
	)

private

internal evaluation function for a single file

Parameters

file	filename to evaluate

Reimplemented in Python.Markopy.Evaluation.CorpusEvaluator.

Definition at line 52 of file evaluate.py.

     def _evaluate(self, file) -> list:
         """! 
         @brief internal evaluation function for a single file
         @param file filename to evaluate
         """
         if(not os.path.isfile(file)):
             logging.pprint(f"Given file {file} is not a valid filename")
             return False
         else:
              return open(file, "rb").read().split(b"\n")
         
         
  

Referenced by Python.Markopy.Evaluation.Evaluator.evaluate(), and Python.Markopy.Evaluation.ModelEvaluator.evaluate().

Here is the caller graph for this function:

◆ evaluate()

bool Python.Markopy.Evaluation.Evaluator.evaluate ( self )

Reimplemented in Python.Markopy.Evaluation.CorpusEvaluator, and Python.Markopy.Evaluation.ModelEvaluator.

Definition at line 44 of file evaluate.py.

     def evaluate(self) -> bool:
         "! @brief base evaluation function"
         for file in self.files:
             self._evaluate(file)
         
         self.check_funcs = [func for func in dir(self) if (callable(getattr(self, func)) and func.startswith("check_"))]
  

References Python.Markopy.Evaluation.Evaluator._evaluate(), Python.Markopy.Evaluation.CorpusEvaluator._evaluate(), and Python.Markopy.Evaluation.Evaluator.files.

Referenced by Python.Markopy.MarkopyCLI.parse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fail()

def Python.Markopy.Evaluation.Evaluator.fail	(	self,
		checkname
	)

fail a test

Parameters

checkname text to display with the check

Definition at line 72 of file evaluate.py.

     def fail(self, checkname):
         """!
         @brief fail a test
         @param checkname text to display with the check
         """
  
         self.all_checks_passed = False
         self.checks.append((checkname, self.TEST_FAIL_SYMBOL))
  

References Python.Markopy.Evaluation.Evaluator.all_checks_passed, Python.Markopy.Evaluation.Evaluator.checks, and Python.Markopy.Evaluation.Evaluator.TEST_FAIL_SYMBOL.

Referenced by Python.Markopy.Evaluation.ModelEvaluator.check_dangling(), Python.Markopy.Evaluation.ModelEvaluator.check_lean(), Python.Markopy.Evaluation.ModelEvaluator.check_min(), Python.Markopy.Evaluation.ModelEvaluator.check_structure(), and Python.Markopy.Evaluation.CorpusEvaluator.evaluate().

Here is the caller graph for this function:

◆ finalize()

def Python.Markopy.Evaluation.Evaluator.finalize ( self )

Definition at line 81 of file evaluate.py.

     def finalize(self):
         "! @brief finalize an evaluation and print checks"
         print("\n################ Checks ################ ")
         for test in self.checks:
             logging.pprint(f"{test[0]:30}:{test[1]} ")
         print("\n")
         self.checks = []
         return self.all_checks_passed
  

References Python.Markopy.Evaluation.Evaluator.all_checks_passed, and Python.Markopy.Evaluation.Evaluator.checks.

Referenced by Python.Markopy.Evaluation.CorpusEvaluator.evaluate().

Here is the caller graph for this function:

◆ success()

def Python.Markopy.Evaluation.Evaluator.success	(	self,
		checkname
	)

pass a test

Parameters

checkname text to display with the check

Definition at line 65 of file evaluate.py.

     def success(self, checkname):
         """!
         @brief pass a test
         @param checkname text to display with the check
         """
         self.checks.append((checkname, self.TEST_PASS_SYMBOL))
  

References Python.Markopy.Evaluation.Evaluator.checks, and Python.Markopy.Evaluation.Evaluator.TEST_PASS_SYMBOL.

Referenced by Python.Markopy.Evaluation.ModelEvaluator.check_dangling(), Python.Markopy.Evaluation.ModelEvaluator.check_lean(), Python.Markopy.Evaluation.ModelEvaluator.check_min(), Python.Markopy.Evaluation.ModelEvaluator.check_structure(), and Python.Markopy.Evaluation.CorpusEvaluator.evaluate().

Here is the caller graph for this function:

Member Data Documentation

◆ all_checks_passed

Python.Markopy.Evaluation.Evaluator.all_checks_passed

Definition at line 36 of file evaluate.py.

Referenced by Python.Markopy.Evaluation.Evaluator.fail(), and Python.Markopy.Evaluation.Evaluator.finalize().

◆ check_funcs

Python.Markopy.Evaluation.Evaluator.check_funcs

Definition at line 49 of file evaluate.py.

◆ checks

Python.Markopy.Evaluation.Evaluator.checks

Definition at line 33 of file evaluate.py.

Referenced by Python.Markopy.Evaluation.Evaluator.fail(), Python.Markopy.Evaluation.Evaluator.finalize(), and Python.Markopy.Evaluation.Evaluator.success().

◆ filename

Python.Markopy.Evaluation.Evaluator.filename

Definition at line 32 of file evaluate.py.

◆ files

Python.Markopy.Evaluation.Evaluator.files

Definition at line 37 of file evaluate.py.

Referenced by Python.Markopy.Evaluation.Evaluator.evaluate(), Python.Markopy.Evaluation.ModelEvaluator.evaluate(), and Python.Markopy.Evaluation.CorpusEvaluator.evaluate().

◆ TEST_FAIL_SYMBOL

Python.Markopy.Evaluation.Evaluator.TEST_FAIL_SYMBOL

Definition at line 35 of file evaluate.py.

Referenced by Python.Markopy.Evaluation.Evaluator.fail().

◆ TEST_PASS_SYMBOL

Python.Markopy.Evaluation.Evaluator.TEST_PASS_SYMBOL

Definition at line 34 of file evaluate.py.

Referenced by Python.Markopy.Evaluation.Evaluator.success().

The documentation for this class was generated from the following file:

Markopy/Markopy/src/CLI/evaluate.py

Public Member Functions

Public Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ _evaluate()

◆ evaluate()

◆ fail()

◆ finalize()

◆ success()

Member Data Documentation

◆ all_checks_passed

◆ check_funcs

◆ checks

◆ filename

◆ files

◆ TEST_FAIL_SYMBOL

◆ TEST_PASS_SYMBOL

◆ init()