"""
A module to generate ready to use evaluators.
AHBicht, in the first place, is designed to do the content evaluation itself with actual code that checks if conditions
are fulfilled, format constraints are met and gets hints from somewhere. However, AHBicht can also be used to do a
"fake" content evaluation where the single truth values of conditions are already known.
Then the approach with implementing single methods whose outcomes are already known/hardcoded at compile time
seems like a big overhead. The code representation of "all outcomes are already known" is an instance of the
ContentEvaluationResult. Now the methods below are useful. Simply provide a content evaluation result (the data) and
the evaluators are created based on the already known outcomes. You do not have to actually touch any evaluator code.
"""
from typing import Iterable, Optional, Protocol
from efoli import EdifactFormat, EdifactFormatVersion
from ahbicht.content_evaluation.fc_evaluators import (
ContentEvaluationResultBasedFcEvaluator,
DictBasedFcEvaluator,
FcEvaluator,
)
from ahbicht.content_evaluation.rc_evaluators import (
ContentEvaluationResultBasedRcEvaluator,
DictBasedRcEvaluator,
RcEvaluator,
)
from ahbicht.expressions.hints_provider import (
ContentEvaluationResultBasedHintsProvider,
DictBasedHintsProvider,
HintsProvider,
)
from ahbicht.expressions.package_expansion import (
ContentEvaluationResultBasedPackageResolver,
DictBasedPackageResolver,
PackageResolver,
)
from ahbicht.models.content_evaluation_result import ContentEvaluationResult
# pylint:disable=too-few-public-methods
class _HasEdifactFormatAndFormatVersion(Protocol):
edifact_format: EdifactFormat
edifact_format_version: EdifactFormatVersion
def _set_edifact_format_and_version(
logic_providers: Iterable[_HasEdifactFormatAndFormatVersion],
edifact_format: Optional[EdifactFormat],
edifact_format_version: Optional[EdifactFormatVersion],
) -> None:
for logic_provider in logic_providers:
if edifact_format is not None:
logic_provider.edifact_format = edifact_format
if edifact_format_version is not None:
logic_provider.edifact_format_version = edifact_format_version
[docs]
def create_hardcoded_evaluators(
content_evaluation_result: ContentEvaluationResult,
edifact_format: Optional[EdifactFormat] = None,
edifact_format_version: Optional[EdifactFormatVersion] = None,
) -> tuple[RcEvaluator, FcEvaluator, HintsProvider, PackageResolver]:
"""
Creates evaluators based on the given content_evaluation_result
:param content_evaluation_result:
:return:
"""
rc_evaluator = DictBasedRcEvaluator(content_evaluation_result.requirement_constraints)
fc_evaluator = DictBasedFcEvaluator(content_evaluation_result.format_constraints)
hints_provider = DictBasedHintsProvider(content_evaluation_result.hints)
package_resolver = DictBasedPackageResolver(content_evaluation_result.packages or {})
_set_edifact_format_and_version(
[rc_evaluator, fc_evaluator, hints_provider, package_resolver], edifact_format, edifact_format_version
)
return rc_evaluator, fc_evaluator, hints_provider, package_resolver
[docs]
def create_content_evaluation_result_based_evaluators(
edifact_format: Optional[EdifactFormat] = None,
edifact_format_version: Optional[EdifactFormatVersion] = None,
) -> tuple[RcEvaluator, FcEvaluator, HintsProvider, PackageResolver]:
"""
Creates evaluators that expect the content evaluation result to be present in the evaluatble data
"""
rc_evaluator = ContentEvaluationResultBasedRcEvaluator()
fc_evaluator = ContentEvaluationResultBasedFcEvaluator()
hints_provider = ContentEvaluationResultBasedHintsProvider()
package_resolver = ContentEvaluationResultBasedPackageResolver()
_set_edifact_format_and_version(
[rc_evaluator, fc_evaluator, hints_provider, package_resolver], edifact_format, edifact_format_version
)
return rc_evaluator, fc_evaluator, hints_provider, package_resolver