Skip to content

Various Function Protocols

It can be confusing to remember all function protocols used in gapper. Below, we list the function signatures and their docstrings for each use case.

gap_override_test

CustomTestFn

Bases: Protocol

The function type to be called for custom tests.

Source code in src/gapper/core/types.py 
129
130
131
132
133
134
135
136
137
138
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.
        """
        ...

__call__ 

__call__(data: CustomTestData[T]) -> None

Implement.

Parameters:

Name Type Description Default
data CustomTestData[T]

The CustomTestData instance.

 required

Raises:

Type Description
AssertionError

It should raise assertion error if test fails.
Source code in src/gapper/core/types.py 
132
133
134
135
136
137
138
def __call__[T](self, data: CustomTestData[T]) -> None:
    """Implement.

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

CustomTestData dataclass

Bases: _TCMixin, _SolSubMixin[T]

Source code in src/gapper/core/types.py 
79
80
81
82
83
84
@dataclass
class CustomTestData[T](_TCMixin, _SolSubMixin[T]):
    case: TestCaseWrapper
    result_proxy: TestResult
    solution: T
    submission: T

gap_override_check

CustomEqualityCheckFn

Bases: Protocol

The function type to be called for custom equality checks.

Source code in src/gapper/core/types.py 
141
142
143
144
145
146
147
148
149
150
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
        """
        ...

__call__ 

__call__(data: CustomEqualityTestData[T]) -> None

Implement.

Parameters:

Name Type Description Default
data CustomEqualityTestData[T]

The CustomEqualityTestData instance.

 required

Raises:

Type Description
AssertionError

It should raise assertion error if the equality check tails
Source code in src/gapper/core/types.py 
144
145
146
147
148
149
150
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
    """
    ...

CustomEqualityTestData dataclass

Source code in src/gapper/core/types.py 
87
88
89
90
91
@dataclass
class CustomEqualityTestData[T]:
    expected: T
    actual: T
    msg: str | None = field(default=None)

gap_pre_hook

PreHookFn

Bases: Protocol

The function type to be called for post checks all the equality check of a test case.

Source code in src/gapper/core/types.py 
153
154
155
156
157
158
159
160
161
162
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.
        """
        ...

__call__ 

__call__(data: PreHookData[T]) -> None

Implement.

Parameters:

Name Type Description Default
data PreHookData[T]

The PreTestHookData instance.

 required

Raises:

Type Description
AssertionError

It should raise assertion error if the pre hook fails.
Source code in src/gapper/core/types.py 
156
157
158
159
160
161
162
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.
    """
    ...

PreHookData dataclass

Bases: HookDataBase, _TCMixin, _SolSubMixin[T]

Source code in src/gapper/core/types.py 
 98
 99
100
101
102
103
@dataclass
class PreHookData[T](HookDataBase, _TCMixin, _SolSubMixin[T]):
    case: TestCaseWrapper
    result_proxy: TestResult
    solution: T
    submission: T

gap_post_hook

PostHookFn

Bases: Protocol

The function type to be called for post checks all the equality check of a test case.

Source code in src/gapper/core/types.py 
170
171
172
173
174
175
176
177
178
179
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.
        """
        ...

__call__ 

__call__(data: PostHookData[T]) -> None

Implement.

Parameters:

Name Type Description Default
data PostHookData[T]

The PostTestHookData instance.

 required

Raises:

Type Description
AssertionError

It should raise assertion error if the post hook fails.
Source code in src/gapper/core/types.py 
173
174
175
176
177
178
179
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.
    """
    ...

PostHookData dataclass

Bases: HookDataBase, _TCMixin, _SolSubMixin[T], _SolSubResultMixin[T]

Source code in src/gapper/core/types.py 
106
107
108
109
110
111
112
113
@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

pre_tests

PreTestsFn

Bases: Protocol

Source code in src/gapper/core/types.py 
182
183
184
185
186
187
188
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.
        """

__call__ 

__call__(data: PreTestsData) -> None

Implement.

Parameters:

Name Type Description Default
data PreTestsData

The PreTestsData instance.

 required

Raises:

Type Description
AssertionError

It should raise assertion error if the pre tests hook fail.
Source code in src/gapper/core/types.py 
183
184
185
186
187
188
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.
    """

PreTestsData dataclass

Bases: HookDataBase

Source code in src/gapper/core/types.py 
116
117
118
119
@dataclass
class PreTestsData[T](HookDataBase):
    result_proxy: TestResult | None = field(default=None)
    metadata: GradescopeSubmissionMetadata | None = field(default=None)

post_tests

PostTestsFn

Bases: Protocol

The function type to be called after all tests are run.

Source code in src/gapper/core/types.py 
191
192
193
194
195
196
197
198
199
200
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.
        """
        ...

__call__ 

__call__(data: PostTestsData) -> None

Implement.

Parameters:

Name Type Description Default
data PostTestsData

The PostTestsData instance.

 required

Raises:

Type Description
AssertionError

It should raise assertion error if the post tests hook fail.
Source code in src/gapper/core/types.py 
194
195
196
197
198
199
200
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.
    """
    ...

PostTestsData dataclass

Bases: HookDataBase

Source code in src/gapper/core/types.py 
122
123
124
125
126
@dataclass
class PostTestsData[T](HookDataBase):
    test_results: List[TestResult]
    result_proxy: TestResult | None = field(default=None)
    metadata: GradescopeSubmissionMetadata | None = field(default=None)