1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
|
#!/usr/bin/env python3
# --------------------( LICENSE )--------------------
# Copyright (c) 2014-2025 Beartype authors.
# See "LICENSE" for further details.
'''
Project-wide **type-checking function code snippets** (i.e., triple-quoted
pure-Python string constants formatted and concatenated together to dynamically
generate the implementations of functions type-checking arbitrary objects
against arbitrary PEP-compliant type hints).
This private submodule is *not* intended for importation by downstream callers.
'''
# ....................{ IMPORTS }....................
from beartype._data.code.datacodename import (
ARG_NAME_CHECK_META,
ARG_NAME_CONF,
ARG_NAME_EXCEPTION_PREFIX,
ARG_NAME_GET_VIOLATION,
ARG_NAME_HINT,
ARG_NAME_WARN,
VAR_NAME_PITH_ROOT,
VAR_NAME_RANDOM_INT,
VAR_NAME_VIOLATION,
)
# ....................{ CODE ~ signature }....................
CODE_CHECKER_SIGNATURE = f'''{{code_signature_prefix}}def {{func_name}}(
{VAR_NAME_PITH_ROOT},
{{code_signature_scope_args}}
):'''
'''
Code snippet declaring the signature of all type-checking tester functions
created by the :func:`beartype._data.code.datacodename.make_func_tester` factory.
Note that:
* This signature intentionally:
* Avoids annotating its parameters or return by type hints. Doing so would be:
* Pointless, as the type-checking functions dynamically created and returned
by factory functions defined by the "beartype._check.checkmake" submodule
are only privately called by the public beartype.door.is_bearable() and
beartype.door.die_if_unbearable() runtime type-checkers.
* Harmful, as doing so would prevent this common signature from being
generically reused as the signature for both raisers and testers.
* Names the single public parameter accepted by this tester function
``{VAR_NAME_PITH_ROOT}``. Doing so trivially ensures that the memoized
type-checking boolean expression generated by the
:func:`beartype._check.code.codemain.make_check_expr` code factory
implicitly type-checks the passed object *without* further modification
(e.g., global search-and-replacement), ensuring that memoized expression may
be efficiently reused as is *without* subsequent unmemoization. Clever, huh?
* ``code_signature_prefix`` is usually either:
* For synchronous callables, the empty string.
* For asynchronous callables (e.g., asynchronous generators, coroutines), the
space-suffixed keyword ``"async "``.
'''
# ....................{ CODE ~ check }....................
CODE_TESTER_CHECK_PREFIX = '''
# Return true only if the passed object satisfies this type hint.
return '''
'''
Code snippet prefixing the type-check of an arbitrary object passed to a
type-checking tester function against an arbitrary type hint passed to the same
function.
'''
# ....................{ CODE ~ check }....................
CODE_RAISER_HINT_OBJECT_CHECK_PREFIX = '''
# Type-check this object against this type hint.
if not '''
'''
Code snippet prefixing the type-check of an arbitrary object passed to a
type-checking raiser function against an arbitrary type hint passed to the same
function.
'''
CODE_RAISER_FUNC_PITH_CHECK_PREFIX = '''
# Type-check this parameter or return against this type hint.
if not '''
'''
Code snippet prefixing the type-check of a parameter or return of a decorated
callable against the type hint annotating that parameter or return.
'''
# ....................{ CODE ~ violation : get }....................
CODE_GET_HINT_OBJECT_VIOLATION = f''':
{VAR_NAME_VIOLATION} = {ARG_NAME_GET_VIOLATION}(
obj={VAR_NAME_PITH_ROOT},
hint={ARG_NAME_HINT},
conf={ARG_NAME_CONF},
exception_prefix={ARG_NAME_EXCEPTION_PREFIX},{{arg_random_int}}
)
'''
'''
Code snippet suffixing all code type-checking the **root pith** (i.e., arbitrary
object) against the root type hint annotating that pith by either raising a
fatal exception or emitting a non-fatal warning.
This snippet expects to be formatted with these named interpolations:
* ``{arg_random_int}``, whose value is either:
* If type-checking for the current type hint requires a pseudo-random integer,
:data:`.CODE_HINT_ROOT_SUFFIX_RANDOM_INT`.
* Else, the empty substring.
'''
CODE_GET_FUNC_PITH_VIOLATION = f''':
{VAR_NAME_VIOLATION} = {ARG_NAME_GET_VIOLATION}(
check_meta={ARG_NAME_CHECK_META},
pith_name={{pith_name}},
pith_value={VAR_NAME_PITH_ROOT},{{arg_random_int}}
)
'''
'''
Code snippet suffixing all code type-checking the **root pith** (i.e., value of
the current parameter or return of a :func:`beartype.beartype`-decorated
callable) against the root type hint annotating that pith by either raising a
fatal exception or emitting a non-fatal warning.
This snippet expects to be formatted with these named interpolations:
* ``{arg_random_int}``, whose value is either:
* If type-checking for the current type hint requires a pseudo-random integer,
:data:`.CODE_HINT_ROOT_SUFFIX_RANDOM_INT`.
* Else, the empty substring.
'''
CODE_GET_VIOLATION_RANDOM_INT = f'''
random_int={VAR_NAME_RANDOM_INT},'''
'''
Code snippet passing the value of the random integer previously
generated for the current call to the exception-handling function call embedded
in the :data:`.CODE_HINT_ROOT_SUFFIX` snippet.
'''
# ....................{ CODE ~ violation }....................
CODE_RAISE_VIOLATION = f'''
raise {VAR_NAME_VIOLATION}'''
'''
Code snippet raising the type-checking violation previously generated by the
:data:`.CODE_HINT_ROOT_SUFFIX` or
:data:`.PEP484_CODE_CHECK_NORETURN` code snippets as a fatal exception.
'''
CODE_WARN_VIOLATION = f'''
{ARG_NAME_WARN}(str({VAR_NAME_VIOLATION}), type({VAR_NAME_VIOLATION}))'''
'''
Code snippet emitting the type-checking violation previously generated by the
:data:`.CODE_HINT_ROOT_SUFFIX` or
:data:`.PEP484_CODE_CHECK_NORETURN` code snippets as a non-fatal warning.
'''
|
