Useful Types¶

class CustomTestFn(Protocol):
    """The function type to be called for custom tests."""

    def __call__[T](self, data: CustomTestData[T]) -> None:
        """Implement.

        :param data: The CustomTestData instance.
        :raises AssertionError: It should raise assertion error if test fails.
        """
        ...

@dataclass
class CustomTestData[T](_TCMixin, _SolSubMixin[T]):
    case: TestCaseWrapper
    result_proxy: TestResult
    solution: T
    submission: T

class CustomEqualityCheckFn(Protocol):
    """The function type to be called for custom equality checks."""

    def __call__[T](self, data: CustomEqualityTestData[T]) -> None:
        """Implement.

        :param data: The CustomEqualityTestData instance.
        :raises AssertionError: It should raise assertion error if the equality check tails
        """
        ...

@dataclass
class CustomEqualityTestData[T]:
    expected: T
    actual: T
    msg: str | None = field(default=None)

class PreHookFn(Protocol):
    """The function type to be called for post checks all the equality check of a test case."""

    def __call__[T](self, data: PreHookData[T]) -> None:
        """Implement.

        :param data: The PreTestHookData instance.
        :raises AssertionError: It should raise assertion error if the pre hook fails.
        """
        ...

@dataclass
class PreHookData[T](HookDataBase, _TCMixin, _SolSubMixin[T]):
    case: TestCaseWrapper
    result_proxy: TestResult
    solution: T
    submission: T

class PostHookFn(Protocol):
    """The function type to be called for post checks all the equality check of a test case."""

    def __call__[T](self, data: PostHookData[T]) -> None:
        """Implement.

        :param data: The PostTestHookData instance.
        :raises AssertionError: It should raise assertion error if the post hook fails.
        """
        ...

@dataclass
class PostHookData[T](HookDataBase, _TCMixin, _SolSubMixin[T], _SolSubResultMixin[T]):
    case: TestCaseWrapper
    result_proxy: TestResult
    solution: T
    submission: T
    expected_results: ResultBundle
    actual_results: ResultBundle

class PreTestsFn(Protocol):
    def __call__(self, data: PreTestsData) -> None:
        """Implement.

        :param data: The PreTestsData instance.
        :raises AssertionError: It should raise assertion error if the pre tests hook fail.
        """

@dataclass
class PreTestsData[T](HookDataBase):
    result_proxy: TestResult | None = field(default=None)
    metadata: GradescopeSubmissionMetadata | None = field(default=None)

class PostTestsFn(Protocol):
    """The function type to be called after all tests are run."""

    def __call__(self, data: PostTestsData) -> None:
        """Implement.

        :param data: The PostTestsData instance.
        :raises AssertionError: It should raise assertion error if the post tests hook fail.
        """
        ...

@dataclass
class PostTestsData[T](HookDataBase):
    test_results: List[TestResult]
    result_proxy: TestResult | None = field(default=None)
    metadata: GradescopeSubmissionMetadata | None = field(default=None)