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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
#!/usr/bin/env python3
#
# This file is part of m.css.
#
# Copyright © 2017, 2018, 2019, 2020, 2021, 2022, 2023
# Vladimír Vondruš <mosra@centrum.cz>
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
#
import os
from _search import searchdata_filename, pretty_print
from python import EntryType
from test_python import BaseInspectTestCase
class Search(BaseInspectTestCase):
def test(self):
self.run_python({
'SEARCH_DISABLED': False,
'SEARCH_DOWNLOAD_BINARY': True,
'SEARCH_FILENAME_PREFIX': 'secretblob',
'PYBIND11_COMPATIBILITY': True
})
with open(os.path.join(self.path, 'output', searchdata_filename.format(search_filename_prefix='secretblob')), 'rb') as f:
serialized = f.read()
search_data_pretty = pretty_print(serialized, entryTypeClass=EntryType)[0]
#print(search_data_pretty)
self.assertEqual(len(serialized), 2274)
self.assertEqual(search_data_pretty, """
21 symbols
search [14]
|| .$
|| foo [7]
|| || .$
|| || enum [0]
|| || || .$
|| || || a_value [1]
|| || || nother [2]
|| || |a_method [3]
|| || || | ($
|| || || | ) [4]
|| || || property [5]
|| || |data_declaration [6]
|| || withslots [9]
|| || | .$
|| || | im_a_sloth [8]
|| |unc_with_params [12]
|| || ($
|| || ) [13]
|| a_function [10]
|| | ($
|| | ) [11]
|| pybind [26]
|| | .$
|| | foo [21]
|| | | .$
|| | | overloaded_method [17, 19, 15]
|| | | ($
|| | | ) [18, 20, 16]
|| | unction [22]
|| | | ($
|| | | ) [23]
|| | | _with_params [24]
|| | | | ($
|| | | | ) [25]
|| sub [28]
|| | .$
|| | data_in_a_submodule [27]
|ub [28]
|| .$
|| data_in_a_submodule [27]
foo [7, 21]
|| .$
|| enum [0]
|| || .$
|| || a_value [1]
|| || nother [2]
|| |a_method [3]
|| || | ($
|| || | ) [4]
|| || property [5]
|| |data_declaration [6]
|| |overloaded_method [17, 19, 15]
|| || ($
|| || ) [18, 20, 16]
|| withslots [9]
|| | .$
|| | im_a_sloth [8]
|unc_with_params [12]
|| | ($
|| | ) [13]
|| tion [22]
|| | ($
|| | ) [23]
|| | _with_params [24]
|| | | ($
|| | | ) [25]
enum [0]
| .$
| a_value [1]
| nother [2]
a_value [1]
||method [3]
||| ($
||| ) [4]
||property [5]
||function [10]
||| ($
||| ) [11]
|nother [2]
data_declaration [6]
| in_a_submodule [27]
im_a_sloth [8]
pybind [26]
| .$
| foo [21]
| | .$
| | overloaded_method [17, 19, 15]
| | ($
| | ) [18, 20, 16]
| unction [22]
| | ($
| | ) [23]
| | _with_params [24]
| | | ($
| | | ) [25]
overloaded_method [17, 19, 15]
| ($
| ) [18, 20, 16]
0: .Enum [prefix=7[:15], type=ENUM] -> #Enum
1: .A_VALUE [prefix=0[:20], type=ENUM_VALUE] -> -A_VALUE
2: .ANOTHER [prefix=0[:20], type=ENUM_VALUE] -> -ANOTHER
3: .a_method() [prefix=7[:15], suffix_length=2, type=FUNCTION] -> #a_method
4: [prefix=3[:24], type=FUNCTION] ->
5: .a_property [prefix=7[:15], type=PROPERTY] -> #a_property
6: .DATA_DECLARATION [prefix=7[:15], type=DATA] -> #DATA_DECLARATION
7: .Foo [prefix=14[:7], type=CLASS] -> Foo.html
8: .im_a_sloth [prefix=9[:24], type=PROPERTY] -> #im_a_sloth
9: WithSlots [prefix=7[:10], type=CLASS] -> WithSlots.html
10: .a_function() [prefix=14[:11], suffix_length=2, type=FUNCTION] -> #a_function
11: [prefix=10[:22], type=FUNCTION] ->
12: .func_with_params() [prefix=14[:11], suffix_length=2, type=FUNCTION] -> #func_with_params
13: [prefix=12[:28], type=FUNCTION] ->
14: search [type=MODULE] -> search.html
15: .overloaded_method(self, first: int, second: float) [prefix=21[:22], suffix_length=33, type=FUNCTION] -> #overloaded_method-27269
16: [prefix=15[:46], suffix_length=31, type=FUNCTION] ->
17: .overloaded_method(self, arg0: int) [prefix=21[:22], suffix_length=17, type=FUNCTION] -> #overloaded_method-745a3
18: [prefix=17[:46], suffix_length=15, type=FUNCTION] ->
19: .overloaded_method(self, arg0: int, arg1: Foo) [prefix=21[:22], suffix_length=28, type=FUNCTION] -> #overloaded_method-41cfb
20: [prefix=19[:46], suffix_length=26, type=FUNCTION] ->
21: .Foo [prefix=26[:14], type=CLASS] -> Foo.html
22: .function() [prefix=26[:18], suffix_length=2, type=FUNCTION] -> #function
23: [prefix=22[:27], type=FUNCTION] ->
24: .function_with_params() [prefix=26[:18], suffix_length=2, type=FUNCTION] -> #function_with_params
25: [prefix=24[:39], type=FUNCTION] ->
26: .pybind [prefix=14[:7], type=MODULE] -> pybind.html
27: .DATA_IN_A_SUBMODULE [prefix=28[:15], type=DATA] -> #DATA_IN_A_SUBMODULE
28: .sub [prefix=14[:7], type=MODULE] -> sub.html
(EntryType.PAGE, CssClass.SUCCESS, 'page'),
(EntryType.MODULE, CssClass.PRIMARY, 'module'),
(EntryType.CLASS, CssClass.PRIMARY, 'class'),
(EntryType.FUNCTION, CssClass.INFO, 'func'),
(EntryType.PROPERTY, CssClass.WARNING, 'property'),
(EntryType.ENUM, CssClass.PRIMARY, 'enum'),
(EntryType.ENUM_VALUE, CssClass.DEFAULT, 'enum val'),
(EntryType.DATA, CssClass.DEFAULT, 'data')
""".strip())
def test_byte_sizes(self):
for config, bytes, size in [
('SEARCH_RESULT_ID_BYTES', 3, 2333),
('SEARCH_RESULT_ID_BYTES', 4, 2392),
('SEARCH_FILE_OFFSET_BYTES', 4, 2525),
('SEARCH_NAME_SIZE_BYTES', 2, 2313)
]:
with self.subTest(config=config, bytes=bytes, size=size):
self.run_python({
'SEARCH_DISABLED': False,
'SEARCH_DOWNLOAD_BINARY': True,
config: bytes,
'PYBIND11_COMPATIBILITY': True
})
with open(os.path.join(self.path, 'output', searchdata_filename.format(search_filename_prefix='searchdata')), 'rb') as f:
serialized = f.read()
self.assertEqual(len(serialized), size)
class LongSuffixLength(BaseInspectTestCase):
def test(self):
self.run_python({
'SEARCH_DISABLED': False,
'SEARCH_DOWNLOAD_BINARY': True,
'PYBIND11_COMPATIBILITY': True
})
with open(os.path.join(self.path, 'output', searchdata_filename.format(search_filename_prefix='searchdata')), 'rb') as f:
serialized = f.read()
search_data_pretty = pretty_print(serialized, entryTypeClass=EntryType)[0]
#print(search_data_pretty)
self.assertEqual(len(serialized), 638)
# The parameters get cut off with an ellipsis
self.assertEqual(search_data_pretty, """
3 symbols
search_long_suffix_length [4]
| .$
| many_parameters [0, 2]
| ($
| ) [1, 3]
many_parameters [0, 2]
| ($
| ) [1, 3]
0: .many_parameters(arg0: typing.Tuple[float, int, str, typing.List[…) [prefix=4[:30], suffix_length=53, type=FUNCTION] -> #many_parameters-06151
1: [prefix=0[:52], suffix_length=51, type=FUNCTION] ->
2: .many_parameters(arg0: typing.Tuple[int, float, str, typing.List[…) [prefix=4[:30], suffix_length=53, type=FUNCTION] -> #many_parameters-31300
3: [prefix=2[:52], suffix_length=51, type=FUNCTION] ->
4: search_long_suffix_length [type=MODULE] -> search_long_suffix_length.html
(EntryType.PAGE, CssClass.SUCCESS, 'page'),
(EntryType.MODULE, CssClass.PRIMARY, 'module'),
(EntryType.CLASS, CssClass.PRIMARY, 'class'),
(EntryType.FUNCTION, CssClass.INFO, 'func'),
(EntryType.PROPERTY, CssClass.WARNING, 'property'),
(EntryType.ENUM, CssClass.PRIMARY, 'enum'),
(EntryType.ENUM_VALUE, CssClass.DEFAULT, 'enum val'),
(EntryType.DATA, CssClass.DEFAULT, 'data')
""".strip())
|
