pyglove 0.4.5.dev20240319__py3-none-any.whl → 0.4.5.dev202501132210__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (145) hide show
  1. pyglove/core/__init__.py +54 -20
  2. pyglove/core/coding/__init__.py +42 -0
  3. pyglove/core/coding/errors.py +111 -0
  4. pyglove/core/coding/errors_test.py +98 -0
  5. pyglove/core/coding/execution.py +309 -0
  6. pyglove/core/coding/execution_test.py +333 -0
  7. pyglove/core/{object_utils/codegen.py → coding/function_generation.py} +10 -4
  8. pyglove/core/{object_utils/codegen_test.py → coding/function_generation_test.py} +5 -7
  9. pyglove/core/coding/parsing.py +153 -0
  10. pyglove/core/coding/parsing_test.py +150 -0
  11. pyglove/core/coding/permissions.py +100 -0
  12. pyglove/core/coding/permissions_test.py +93 -0
  13. pyglove/core/geno/base.py +54 -41
  14. pyglove/core/geno/base_test.py +2 -4
  15. pyglove/core/geno/categorical.py +37 -28
  16. pyglove/core/geno/custom.py +19 -16
  17. pyglove/core/geno/numerical.py +20 -17
  18. pyglove/core/geno/space.py +4 -5
  19. pyglove/core/hyper/base.py +6 -6
  20. pyglove/core/hyper/categorical.py +94 -55
  21. pyglove/core/hyper/custom.py +7 -7
  22. pyglove/core/hyper/custom_test.py +9 -10
  23. pyglove/core/hyper/derived.py +30 -22
  24. pyglove/core/hyper/derived_test.py +2 -4
  25. pyglove/core/hyper/dynamic_evaluation.py +5 -6
  26. pyglove/core/hyper/evolvable.py +57 -46
  27. pyglove/core/hyper/numerical.py +48 -24
  28. pyglove/core/hyper/numerical_test.py +9 -9
  29. pyglove/core/hyper/object_template.py +58 -46
  30. pyglove/core/io/__init__.py +1 -0
  31. pyglove/core/io/file_system.py +17 -7
  32. pyglove/core/io/file_system_test.py +2 -0
  33. pyglove/core/io/sequence.py +299 -0
  34. pyglove/core/io/sequence_test.py +124 -0
  35. pyglove/core/logging_test.py +0 -2
  36. pyglove/core/patching/object_factory.py +4 -4
  37. pyglove/core/patching/pattern_based.py +4 -4
  38. pyglove/core/patching/rule_based.py +17 -5
  39. pyglove/core/patching/rule_based_test.py +27 -4
  40. pyglove/core/symbolic/__init__.py +2 -7
  41. pyglove/core/symbolic/base.py +320 -183
  42. pyglove/core/symbolic/base_test.py +123 -19
  43. pyglove/core/symbolic/boilerplate.py +7 -13
  44. pyglove/core/symbolic/boilerplate_test.py +25 -23
  45. pyglove/core/symbolic/class_wrapper.py +48 -45
  46. pyglove/core/symbolic/class_wrapper_test.py +2 -2
  47. pyglove/core/symbolic/compounding.py +9 -15
  48. pyglove/core/symbolic/compounding_test.py +2 -4
  49. pyglove/core/symbolic/dict.py +154 -110
  50. pyglove/core/symbolic/dict_test.py +238 -130
  51. pyglove/core/symbolic/diff.py +199 -10
  52. pyglove/core/symbolic/diff_test.py +226 -0
  53. pyglove/core/symbolic/flags.py +1 -1
  54. pyglove/core/symbolic/functor.py +29 -26
  55. pyglove/core/symbolic/functor_test.py +102 -50
  56. pyglove/core/symbolic/inferred.py +2 -2
  57. pyglove/core/symbolic/list.py +81 -50
  58. pyglove/core/symbolic/list_test.py +119 -97
  59. pyglove/core/symbolic/object.py +225 -113
  60. pyglove/core/symbolic/object_test.py +320 -108
  61. pyglove/core/symbolic/origin.py +17 -14
  62. pyglove/core/symbolic/origin_test.py +4 -2
  63. pyglove/core/symbolic/pure_symbolic.py +4 -3
  64. pyglove/core/symbolic/ref.py +108 -21
  65. pyglove/core/symbolic/ref_test.py +93 -0
  66. pyglove/core/symbolic/symbolize_test.py +10 -2
  67. pyglove/core/tuning/local_backend.py +2 -2
  68. pyglove/core/tuning/protocols.py +3 -3
  69. pyglove/core/tuning/sample_test.py +3 -3
  70. pyglove/core/typing/__init__.py +14 -5
  71. pyglove/core/typing/annotation_conversion.py +43 -27
  72. pyglove/core/typing/annotation_conversion_test.py +23 -0
  73. pyglove/core/typing/callable_ext.py +241 -3
  74. pyglove/core/typing/callable_ext_test.py +255 -0
  75. pyglove/core/typing/callable_signature.py +510 -66
  76. pyglove/core/typing/callable_signature_test.py +619 -99
  77. pyglove/core/typing/class_schema.py +229 -154
  78. pyglove/core/typing/class_schema_test.py +149 -95
  79. pyglove/core/typing/custom_typing.py +5 -4
  80. pyglove/core/typing/inspect.py +63 -0
  81. pyglove/core/typing/inspect_test.py +39 -0
  82. pyglove/core/typing/key_specs.py +10 -11
  83. pyglove/core/typing/key_specs_test.py +7 -4
  84. pyglove/core/typing/type_conversion.py +4 -5
  85. pyglove/core/typing/type_conversion_test.py +12 -12
  86. pyglove/core/typing/typed_missing.py +6 -7
  87. pyglove/core/typing/typed_missing_test.py +7 -8
  88. pyglove/core/typing/value_specs.py +604 -362
  89. pyglove/core/typing/value_specs_test.py +328 -90
  90. pyglove/core/utils/__init__.py +164 -0
  91. pyglove/core/{object_utils → utils}/common_traits.py +3 -67
  92. pyglove/core/utils/common_traits_test.py +36 -0
  93. pyglove/core/{object_utils → utils}/docstr_utils.py +23 -0
  94. pyglove/core/{object_utils → utils}/docstr_utils_test.py +36 -4
  95. pyglove/core/{object_utils → utils}/error_utils.py +78 -9
  96. pyglove/core/{object_utils → utils}/error_utils_test.py +61 -5
  97. pyglove/core/utils/formatting.py +464 -0
  98. pyglove/core/utils/formatting_test.py +453 -0
  99. pyglove/core/{object_utils → utils}/hierarchical.py +23 -25
  100. pyglove/core/{object_utils → utils}/hierarchical_test.py +3 -5
  101. pyglove/core/{object_utils → utils}/json_conversion.py +177 -52
  102. pyglove/core/{object_utils → utils}/json_conversion_test.py +97 -16
  103. pyglove/core/{object_utils → utils}/missing.py +3 -3
  104. pyglove/core/{object_utils → utils}/missing_test.py +2 -4
  105. pyglove/core/utils/text_color.py +128 -0
  106. pyglove/core/utils/text_color_test.py +94 -0
  107. pyglove/core/{object_utils → utils}/thread_local_test.py +1 -3
  108. pyglove/core/utils/timing.py +236 -0
  109. pyglove/core/utils/timing_test.py +154 -0
  110. pyglove/core/{object_utils → utils}/value_location.py +275 -6
  111. pyglove/core/utils/value_location_test.py +707 -0
  112. pyglove/core/views/__init__.py +32 -0
  113. pyglove/core/views/base.py +804 -0
  114. pyglove/core/views/base_test.py +580 -0
  115. pyglove/core/views/html/__init__.py +27 -0
  116. pyglove/core/views/html/base.py +547 -0
  117. pyglove/core/views/html/base_test.py +830 -0
  118. pyglove/core/views/html/controls/__init__.py +35 -0
  119. pyglove/core/views/html/controls/base.py +275 -0
  120. pyglove/core/views/html/controls/label.py +207 -0
  121. pyglove/core/views/html/controls/label_test.py +157 -0
  122. pyglove/core/views/html/controls/progress_bar.py +183 -0
  123. pyglove/core/views/html/controls/progress_bar_test.py +97 -0
  124. pyglove/core/views/html/controls/tab.py +320 -0
  125. pyglove/core/views/html/controls/tab_test.py +87 -0
  126. pyglove/core/views/html/controls/tooltip.py +99 -0
  127. pyglove/core/views/html/controls/tooltip_test.py +99 -0
  128. pyglove/core/views/html/tree_view.py +1517 -0
  129. pyglove/core/views/html/tree_view_test.py +1461 -0
  130. {pyglove-0.4.5.dev20240319.dist-info → pyglove-0.4.5.dev202501132210.dist-info}/METADATA +18 -4
  131. pyglove-0.4.5.dev202501132210.dist-info/RECORD +214 -0
  132. {pyglove-0.4.5.dev20240319.dist-info → pyglove-0.4.5.dev202501132210.dist-info}/WHEEL +1 -1
  133. pyglove/core/object_utils/__init__.py +0 -154
  134. pyglove/core/object_utils/common_traits_test.py +0 -82
  135. pyglove/core/object_utils/formatting.py +0 -234
  136. pyglove/core/object_utils/formatting_test.py +0 -223
  137. pyglove/core/object_utils/value_location_test.py +0 -385
  138. pyglove/core/symbolic/schema_utils.py +0 -327
  139. pyglove/core/symbolic/schema_utils_test.py +0 -57
  140. pyglove/core/typing/class_schema_utils.py +0 -202
  141. pyglove/core/typing/class_schema_utils_test.py +0 -194
  142. pyglove-0.4.5.dev20240319.dist-info/RECORD +0 -185
  143. /pyglove/core/{object_utils → utils}/thread_local.py +0 -0
  144. {pyglove-0.4.5.dev20240319.dist-info → pyglove-0.4.5.dev202501132210.dist-info}/LICENSE +0 -0
  145. {pyglove-0.4.5.dev20240319.dist-info → pyglove-0.4.5.dev202501132210.dist-info}/top_level.txt +0 -0
@@ -0,0 +1,830 @@
1
+ # Copyright 2024 The PyGlove Authors
2
+ #
3
+ # Licensed under the Apache License, Version 2.0 (the "License");
4
+ # you may not use this file except in compliance with the License.
5
+ # You may obtain a copy of the License at
6
+ #
7
+ # http://www.apache.org/licenses/LICENSE-2.0
8
+ #
9
+ # Unless required by applicable law or agreed to in writing, software
10
+ # distributed under the License is distributed on an "AS IS" BASIS,
11
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12
+ # See the License for the specific language governing permissions and
13
+ # limitations under the License.
14
+ import inspect
15
+ import unittest
16
+
17
+ from pyglove.core.views.html import base
18
+
19
+ Html = base.Html
20
+
21
+ # pylint: disable=line-too-long
22
+
23
+
24
+ class TestCase(unittest.TestCase):
25
+
26
+ def assert_html(self, actual, expected):
27
+ expected = inspect.cleandoc(expected).strip()
28
+ actual = actual.strip()
29
+ if actual != expected:
30
+ print(actual)
31
+ self.assertEqual(actual.strip(), expected)
32
+
33
+
34
+ class SharedPartTest(TestCase):
35
+
36
+ def test_styles(self):
37
+ self.assert_html(Html.Styles().content, '')
38
+ styles = Html.Styles('h1 {color: red;}', 'h2 {color: blue;}')
39
+ self.assert_html(
40
+ styles.content,
41
+ """
42
+ <style>
43
+ h1 {color: red;}
44
+ h2 {color: blue;}
45
+ </style>
46
+ """
47
+ )
48
+ self.assertTrue(styles.add('h3 {color: green;}'))
49
+ self.assertFalse(styles.add('h1 {color: red;}'))
50
+ self.assertEqual(
51
+ styles.parts,
52
+ {
53
+ 'h1 {color: red;}': 2,
54
+ 'h2 {color: blue;}': 1,
55
+ 'h3 {color: green;}': 1,
56
+ },
57
+ )
58
+ self.assert_html(
59
+ styles.content,
60
+ """
61
+ <style>
62
+ h1 {color: red;}
63
+ h2 {color: blue;}
64
+ h3 {color: green;}
65
+ </style>
66
+ """
67
+ )
68
+ styles2 = Html.Styles('h1 {color: red;}', 'h4 {color: yellow;}')
69
+ styles.add(styles2)
70
+ self.assert_html(
71
+ styles.content,
72
+ """
73
+ <style>
74
+ h1 {color: red;}
75
+ h2 {color: blue;}
76
+ h3 {color: green;}
77
+ h4 {color: yellow;}
78
+ </style>
79
+ """
80
+ )
81
+ self.assertEqual(
82
+ styles.parts,
83
+ {
84
+ 'h1 {color: red;}': 3,
85
+ 'h2 {color: blue;}': 1,
86
+ 'h3 {color: green;}': 1,
87
+ 'h4 {color: yellow;}': 1,
88
+ },
89
+ )
90
+ self.assertTrue(styles)
91
+ self.assertFalse(Html.Styles())
92
+ self.assertIn('h1 {color: red;}', styles)
93
+ self.assertNotIn('h3 {color: red;}', styles)
94
+ self.assertEqual(
95
+ list(styles),
96
+ [
97
+ 'h1 {color: red;}',
98
+ 'h2 {color: blue;}',
99
+ 'h3 {color: green;}',
100
+ 'h4 {color: yellow;}',
101
+ ]
102
+ )
103
+ self.assertEqual(
104
+ styles,
105
+ Html.Styles(
106
+ 'h1 {color: red;}',
107
+ 'h2 {color: blue;}',
108
+ 'h3 {color: green;}',
109
+ 'h4 {color: yellow;}'
110
+ )
111
+ )
112
+ self.assertNotEqual(
113
+ styles,
114
+ Html.Styles(
115
+ 'h1 {color: red;}',
116
+ )
117
+ )
118
+ self.assertNotEqual(styles, Html.Scripts())
119
+ self.assertEqual(
120
+ repr(styles),
121
+ """Styles(parts={'h1 {color: red;}': 3, 'h2 {color: blue;}': 1, 'h3 {color: green;}': 1, 'h4 {color: yellow;}': 1})"""
122
+ )
123
+ self.assert_html(
124
+ str(styles),
125
+ """
126
+ <style>
127
+ h1 {color: red;}
128
+ h2 {color: blue;}
129
+ h3 {color: green;}
130
+ h4 {color: yellow;}
131
+ </style>
132
+ """
133
+ )
134
+
135
+ def test_style_files(self):
136
+ self.assert_html(Html.StyleFiles().content, '')
137
+ style_files = Html.StyleFiles('./a.css', 'https://x/y.css')
138
+ self.assert_html(
139
+ style_files.content,
140
+ """
141
+ <link rel="stylesheet" href="./a.css">
142
+ <link rel="stylesheet" href="https://x/y.css">
143
+ """
144
+ )
145
+ self.assertTrue(style_files.add('./b.css'))
146
+ self.assertFalse(style_files.add('./a.css'))
147
+ self.assertEqual(
148
+ style_files.parts,
149
+ {
150
+ './a.css': 2,
151
+ 'https://x/y.css': 1,
152
+ './b.css': 1,
153
+ },
154
+ )
155
+ self.assert_html(
156
+ style_files.content,
157
+ """
158
+ <link rel="stylesheet" href="./a.css">
159
+ <link rel="stylesheet" href="https://x/y.css">
160
+ <link rel="stylesheet" href="./b.css">
161
+ """
162
+ )
163
+ style_files2 = Html.StyleFiles('./a.css', './c.css')
164
+ style_files.add(style_files2)
165
+ self.assert_html(
166
+ style_files.content,
167
+ """
168
+ <link rel="stylesheet" href="./a.css">
169
+ <link rel="stylesheet" href="https://x/y.css">
170
+ <link rel="stylesheet" href="./b.css">
171
+ <link rel="stylesheet" href="./c.css">
172
+ """
173
+ )
174
+ self.assertEqual(
175
+ style_files.parts,
176
+ {
177
+ './a.css': 3,
178
+ 'https://x/y.css': 1,
179
+ './b.css': 1,
180
+ './c.css': 1,
181
+ },
182
+ )
183
+ self.assertTrue(style_files)
184
+ self.assertFalse(Html.StyleFiles())
185
+ self.assertIn('./a.css', style_files)
186
+ self.assertNotIn('./d.css}', style_files)
187
+ self.assertEqual(
188
+ list(style_files),
189
+ [
190
+ './a.css',
191
+ 'https://x/y.css',
192
+ './b.css',
193
+ './c.css',
194
+ ]
195
+ )
196
+ self.assertEqual(
197
+ style_files,
198
+ Html.StyleFiles(
199
+ './a.css',
200
+ 'https://x/y.css',
201
+ './b.css',
202
+ './c.css',
203
+ )
204
+ )
205
+ self.assertNotEqual(
206
+ style_files,
207
+ Html.StyleFiles(
208
+ './a.css',
209
+ )
210
+ )
211
+ self.assertNotEqual(style_files, Html.Scripts())
212
+ self.assertEqual(
213
+ repr(style_files),
214
+ """StyleFiles(parts={'./a.css': 3, 'https://x/y.css': 1, './b.css': 1, './c.css': 1})"""
215
+ )
216
+ self.assert_html(
217
+ str(style_files),
218
+ """
219
+ <link rel="stylesheet" href="./a.css">
220
+ <link rel="stylesheet" href="https://x/y.css">
221
+ <link rel="stylesheet" href="./b.css">
222
+ <link rel="stylesheet" href="./c.css">
223
+ """
224
+ )
225
+
226
+ def test_scripts(self):
227
+ self.assert_html(Html.Scripts().content, '')
228
+ scripts = Html.Scripts(
229
+ 'function myFun1(p1, p2) { return p1 * p2; }',
230
+ 'console.log("hi");'
231
+ )
232
+ self.assert_html(
233
+ scripts.content,
234
+ """
235
+ <script>
236
+ function myFun1(p1, p2) { return p1 * p2; }
237
+ console.log("hi");
238
+ </script>
239
+ """
240
+ )
241
+ self.assertTrue(scripts.add('function myFun2(p1, p2) { return p1 * p2; }'))
242
+ self.assertFalse(scripts.add('console.log("hi");'))
243
+ self.assertEqual(
244
+ scripts.parts,
245
+ {
246
+ 'function myFun1(p1, p2) { return p1 * p2; }': 1,
247
+ 'function myFun2(p1, p2) { return p1 * p2; }': 1,
248
+ 'console.log("hi");': 2,
249
+ },
250
+ )
251
+ self.assert_html(
252
+ scripts.content,
253
+ """
254
+ <script>
255
+ function myFun1(p1, p2) { return p1 * p2; }
256
+ console.log("hi");
257
+ function myFun2(p1, p2) { return p1 * p2; }
258
+ </script>
259
+ """
260
+ )
261
+ scripts2 = Html.Scripts(
262
+ 'function myFun3(p1, p2) { return p1 * p2; }',
263
+ 'console.log("hi");'
264
+ )
265
+ self.assertTrue(scripts.add(scripts2))
266
+ self.assert_html(
267
+ scripts.content,
268
+ """
269
+ <script>
270
+ function myFun1(p1, p2) { return p1 * p2; }
271
+ console.log("hi");
272
+ function myFun2(p1, p2) { return p1 * p2; }
273
+ function myFun3(p1, p2) { return p1 * p2; }
274
+ </script>
275
+ """
276
+ )
277
+ self.assertEqual(
278
+ scripts.parts,
279
+ {
280
+ 'function myFun1(p1, p2) { return p1 * p2; }': 1,
281
+ 'console.log("hi");': 3,
282
+ 'function myFun2(p1, p2) { return p1 * p2; }': 1,
283
+ 'function myFun3(p1, p2) { return p1 * p2; }': 1,
284
+ },
285
+ )
286
+ self.assertTrue(scripts)
287
+ self.assertFalse(Html.Scripts())
288
+ self.assertIn('function myFun1(p1, p2) { return p1 * p2; }', scripts)
289
+ self.assertNotIn('function myFun4(p1, p2) { return p1 * p2; }', scripts)
290
+ self.assertEqual(
291
+ list(scripts),
292
+ [
293
+ 'function myFun1(p1, p2) { return p1 * p2; }',
294
+ 'console.log("hi");',
295
+ 'function myFun2(p1, p2) { return p1 * p2; }',
296
+ 'function myFun3(p1, p2) { return p1 * p2; }',
297
+ ]
298
+ )
299
+ self.assertEqual(
300
+ scripts,
301
+ Html.Scripts(
302
+ 'function myFun1(p1, p2) { return p1 * p2; }',
303
+ 'console.log("hi");',
304
+ 'function myFun2(p1, p2) { return p1 * p2; }',
305
+ 'function myFun3(p1, p2) { return p1 * p2; }',
306
+ )
307
+ )
308
+ self.assertNotEqual(
309
+ scripts,
310
+ Html.Scripts(
311
+ 'function myFun1(p1, p2) { return p1 * p2; }'
312
+ )
313
+ )
314
+ self.assertNotEqual(scripts, Html.ScriptFiles())
315
+ self.assertEqual(
316
+ repr(scripts),
317
+ """Scripts(parts={'function myFun1(p1, p2) { return p1 * p2; }': 1, 'console.log("hi");': 3, 'function myFun2(p1, p2) { return p1 * p2; }': 1, 'function myFun3(p1, p2) { return p1 * p2; }': 1})"""
318
+ )
319
+ self.assert_html(
320
+ str(scripts),
321
+ """
322
+ <script>
323
+ function myFun1(p1, p2) { return p1 * p2; }
324
+ console.log("hi");
325
+ function myFun2(p1, p2) { return p1 * p2; }
326
+ function myFun3(p1, p2) { return p1 * p2; }
327
+ </script>
328
+ """
329
+ )
330
+
331
+ def test_script_files(self):
332
+ self.assert_html(Html.ScriptFiles().content, '')
333
+ script_files = Html.ScriptFiles('./a.js', 'https://x/y.js')
334
+ self.assert_html(
335
+ script_files.content,
336
+ """
337
+ <script src="./a.js"></script>
338
+ <script src="https://x/y.js"></script>
339
+ """
340
+ )
341
+ self.assertTrue(script_files.add('./b.js'))
342
+ self.assertFalse(script_files.add('./a.js'))
343
+ self.assertEqual(
344
+ script_files.parts,
345
+ {
346
+ './a.js': 2,
347
+ 'https://x/y.js': 1,
348
+ './b.js': 1,
349
+ },
350
+ )
351
+ self.assert_html(
352
+ script_files.content,
353
+ """
354
+ <script src="./a.js"></script>
355
+ <script src="https://x/y.js"></script>
356
+ <script src="./b.js"></script>
357
+ """
358
+ )
359
+ script_files2 = Html.ScriptFiles('./a.js', './c.js')
360
+ script_files.add(script_files2)
361
+ self.assert_html(
362
+ script_files.content,
363
+ """
364
+ <script src="./a.js"></script>
365
+ <script src="https://x/y.js"></script>
366
+ <script src="./b.js"></script>
367
+ <script src="./c.js"></script>
368
+ """
369
+ )
370
+ self.assertEqual(
371
+ script_files.parts,
372
+ {
373
+ './a.js': 3,
374
+ 'https://x/y.js': 1,
375
+ './b.js': 1,
376
+ './c.js': 1,
377
+ },
378
+ )
379
+ self.assertTrue(script_files)
380
+ self.assertFalse(Html.StyleFiles())
381
+ self.assertIn('./a.js', script_files)
382
+ self.assertNotIn('./d.js}', script_files)
383
+ self.assertEqual(
384
+ list(script_files),
385
+ [
386
+ './a.js',
387
+ 'https://x/y.js',
388
+ './b.js',
389
+ './c.js',
390
+ ]
391
+ )
392
+ self.assertEqual(
393
+ script_files,
394
+ Html.ScriptFiles(
395
+ './a.js',
396
+ 'https://x/y.js',
397
+ './b.js',
398
+ './c.js',
399
+ )
400
+ )
401
+ self.assertNotEqual(
402
+ script_files,
403
+ Html.StyleFiles(
404
+ './a.js',
405
+ )
406
+ )
407
+ self.assertNotEqual(script_files, Html.Scripts())
408
+ self.assertEqual(
409
+ repr(script_files),
410
+ """ScriptFiles(parts={'./a.js': 3, 'https://x/y.js': 1, './b.js': 1, './c.js': 1})"""
411
+ )
412
+ self.assert_html(
413
+ str(script_files),
414
+ """
415
+ <script src="./a.js"></script>
416
+ <script src="https://x/y.js"></script>
417
+ <script src="./b.js"></script>
418
+ <script src="./c.js"></script>
419
+ """
420
+ )
421
+
422
+
423
+ class HtmlTest(TestCase):
424
+
425
+ class Foo(base.HtmlConvertible):
426
+ def to_html(self, **kwargs):
427
+ return base.Html('<h1>foo</h1>')
428
+
429
+ def test_content_init(self):
430
+ html = Html()
431
+ self.assertEqual(html, Html())
432
+
433
+ html = Html('abc')
434
+ self.assertEqual(html, Html('abc'))
435
+
436
+ html = Html(None)
437
+ self.assertEqual(html, Html())
438
+
439
+ html = Html(lambda: 'abc')
440
+ self.assertEqual(html, Html('abc'))
441
+
442
+ html = Html(Html('abc'))
443
+ self.assertEqual(html, Html('abc'))
444
+
445
+ html = Html(
446
+ 'abc',
447
+ lambda: 'def',
448
+ None,
449
+ Html('ghi')
450
+ )
451
+ self.assertEqual(html, Html('abcdefghi'))
452
+
453
+ html = Html(HtmlTest.Foo())
454
+ self.assertEqual(html, Html('<h1>foo</h1>'))
455
+
456
+ def test_basics(self):
457
+ html = Html(
458
+ '<h1>foo</h1>',
459
+ styles=['h1 {color: red;}'],
460
+ scripts=['function myFun1(p1, p2) { return p1 * p2; }']
461
+ )
462
+ self.assert_html(html.content, '<h1>foo</h1>')
463
+ self.assert_html(
464
+ html.style_section,
465
+ """
466
+ <style>
467
+ h1 {color: red;}
468
+ </style>
469
+ """,
470
+ )
471
+ self.assert_html(
472
+ html.script_section,
473
+ """
474
+ <script>
475
+ function myFun1(p1, p2) { return p1 * p2; }
476
+ </script>
477
+ """,
478
+ )
479
+
480
+ # Adding the same style.
481
+ html.styles.add('h1 {color: red;}')
482
+ self.assertEqual(list(html.styles), ['h1 {color: red;}'])
483
+
484
+ html.add_style_file('./style1.css')
485
+ self.assertEqual(list(html.style_files), ['./style1.css'])
486
+ self.assert_html(
487
+ html.style_section,
488
+ """
489
+ <link rel="stylesheet" href="./style1.css">
490
+ <style>
491
+ h1 {color: red;}
492
+ </style>
493
+ """,
494
+ )
495
+
496
+ html.scripts.add('function myFun1(p1, p2) { return p1 * p2; }')
497
+ self.assertEqual(
498
+ list(html.scripts),
499
+ ['function myFun1(p1, p2) { return p1 * p2; }']
500
+ )
501
+ html.add_script_file('./script1.js')
502
+ self.assertEqual(list(html.script_files), ['./script1.js'])
503
+ self.assert_html(
504
+ html.script_section,
505
+ """
506
+ <script src="./script1.js"></script>
507
+ <script>
508
+ function myFun1(p1, p2) { return p1 * p2; }
509
+ </script>
510
+ """,
511
+ )
512
+
513
+ html.write('<h2>bar</h2>')
514
+ html.add_style('h2 {color: blue;}')
515
+ html.add_script('function myFun2(p1, p2) { return p1 + p2; }')
516
+ self.assert_html(
517
+ html._repr_html_(),
518
+ """
519
+ <html>
520
+ <head>
521
+ <link rel="stylesheet" href="./style1.css">
522
+ <style>
523
+ h1 {color: red;}
524
+ h2 {color: blue;}
525
+ </style>
526
+ <script src="./script1.js"></script>
527
+ <script>
528
+ function myFun1(p1, p2) { return p1 * p2; }
529
+ function myFun2(p1, p2) { return p1 + p2; }
530
+ </script>
531
+ </head>
532
+ <body>
533
+ <h1>foo</h1><h2>bar</h2>
534
+ </body>
535
+ </html>
536
+ """,
537
+ )
538
+ self.assertEqual(
539
+ repr(html),
540
+ """Html(content='<h1>foo</h1><h2>bar</h2>', style_files=StyleFiles(parts={'./style1.css': 1}), styles=Styles(parts={'h1 {color: red;}': 2, 'h2 {color: blue;}': 1}), script_files=ScriptFiles(parts={'./script1.js': 1}), scripts=Scripts(parts={'function myFun1(p1, p2) { return p1 * p2; }': 2, 'function myFun2(p1, p2) { return p1 + p2; }': 1}))"""
541
+ )
542
+ self.assert_html(
543
+ str(html),
544
+ """
545
+ <html>
546
+ <head>
547
+ <link rel="stylesheet" href="./style1.css">
548
+ <style>
549
+ h1 {color: red;}
550
+ h2 {color: blue;}
551
+ </style>
552
+ <script src="./script1.js"></script>
553
+ <script>
554
+ function myFun1(p1, p2) { return p1 * p2; }
555
+ function myFun2(p1, p2) { return p1 + p2; }
556
+ </script>
557
+ </head>
558
+ <body>
559
+ <h1>foo</h1><h2>bar</h2>
560
+ </body>
561
+ </html>
562
+ """,
563
+ )
564
+
565
+ def test_eq(self):
566
+ def make_test_html(style_file):
567
+ return Html(
568
+ '<h1>foo</h1>',
569
+ styles=['h1 {color: red;}'],
570
+ style_files=[f'./{style_file}.css'],
571
+ scripts=['function myFun1(p1, p2) { return p1 * p2; }'],
572
+ script_files=['./script1.js'],
573
+ )
574
+ html = make_test_html('style1')
575
+ self.assertEqual(html, make_test_html('style1'))
576
+ self.assertNotEqual(html, make_test_html('style2'))
577
+ self.assertEqual(hash(html), hash(make_test_html('style1')))
578
+
579
+ def test_write(self):
580
+ html1 = Html()
581
+ html1.scripts.add('function myFun1(p1, p2) { return p1 * p2; }')
582
+ html1.styles.add('div.a { color: red; }')
583
+ html1.styles.add('div.b { color: red; }')
584
+
585
+ html2 = Html()
586
+ html2.styles.add('div.a { color: red; }')
587
+ html2.styles.add('div.b { color: green; }')
588
+ html2.styles.add('div.c { color: blue; }')
589
+ html1.scripts.add('function myFun1(p1, p2) { return p1 * p2; }')
590
+ html2.write('<div class="c">bar</div>')
591
+ html2.write('\n<script>\nconsole.log("bar");\n</script>')
592
+
593
+ html1.write(HtmlTest.Foo())
594
+ html1.write('\n<script>\nconsole.log("foo");\n</script>\n')
595
+ html1.write(html2)
596
+
597
+ self.assert_html(
598
+ html1._repr_html_(),
599
+ """
600
+ <html>
601
+ <head>
602
+ <style>
603
+ div.a { color: red; }
604
+ div.b { color: red; }
605
+ div.b { color: green; }
606
+ div.c { color: blue; }
607
+ </style>
608
+ <script>
609
+ function myFun1(p1, p2) { return p1 * p2; }
610
+ </script>
611
+ </head>
612
+ <body>
613
+ <h1>foo</h1>
614
+ <script>
615
+ console.log("foo");
616
+ </script>
617
+ <div class="c">bar</div>
618
+ <script>
619
+ console.log("bar");
620
+ </script>
621
+ </body>
622
+ </html>
623
+ """,
624
+ )
625
+ self.assert_html(
626
+ html1.to_str(content_only=True),
627
+ """
628
+ <h1>foo</h1>
629
+ <script>
630
+ console.log("foo");
631
+ </script>
632
+ <div class="c">bar</div>
633
+ <script>
634
+ console.log("bar");
635
+ </script>
636
+ """
637
+ )
638
+
639
+ def test_from_value(self):
640
+ html = Html(
641
+ 'hi', styles=['h1 {color: red;}'], scripts=['console.log("hi");']
642
+ )
643
+ self.assertIs(Html.from_value(html), html)
644
+ self.assertIsNone(Html.from_value(None))
645
+ self.assertEqual(
646
+ Html.from_value('abc'), Html('abc')
647
+ )
648
+ html2 = Html.from_value(html, copy=True)
649
+ self.assertIsNot(html2, html)
650
+ self.assertEqual(html2, html)
651
+ html3 = Html.from_value(HtmlTest.Foo())
652
+ self.assertEqual(html3, Html('<h1>foo</h1>'))
653
+
654
+ with self.assertRaises(TypeError):
655
+ Html.from_value(1)
656
+
657
+ def test_add_and_radd(self):
658
+ s1 = Html('<h1>foo</h1>', styles=['h1 {color: red;}'])
659
+ s2 = Html('<h2>bar</h2>', styles=['h2 {color: blue;}'])
660
+ s3 = s1 + s2
661
+ self.assertIsNot(s3, s1)
662
+ self.assertIsNot(s3, s2)
663
+ self.assertEqual(
664
+ s3,
665
+ Html(
666
+ '<h1>foo</h1><h2>bar</h2>',
667
+ styles=['h1 {color: red;}', 'h2 {color: blue;}'],
668
+ )
669
+ )
670
+ s4 = s1 + '<h3>baz</h3>'
671
+ self.assertEqual(
672
+ s4,
673
+ Html(
674
+ '<h1>foo</h1><h3>baz</h3>',
675
+ styles=['h1 {color: red;}'],
676
+ )
677
+ )
678
+ s5 = '<h3>baz</h3>' + s1
679
+ self.assertIsNot(s5, s1)
680
+ self.assertEqual(
681
+ s5,
682
+ Html(
683
+ '<h3>baz</h3><h1>foo</h1>',
684
+ styles=['h1 {color: red;}'],
685
+ )
686
+ )
687
+
688
+ s6 = Html('<hr>')
689
+ self.assertIs(s6 + None, s6)
690
+ self.assertIs(s6, s6 + None)
691
+
692
+ self.assertEqual(
693
+ Html('<hr>') + (lambda: '<div>bar</div>'),
694
+ Html('<hr><div>bar</div>')
695
+ )
696
+ self.assertEqual(
697
+ (lambda: '<div>bar</div>') + Html('<hr>'),
698
+ Html('<div>bar</div><hr>')
699
+ )
700
+
701
+ def test_escape(self):
702
+ self.assertIsNone(Html.escape(None))
703
+ self.assertEqual(Html.escape('foo'), 'foo')
704
+ self.assertEqual(Html.escape('foo"bar'), 'foo&quot;bar')
705
+ self.assertEqual(Html.escape(Html('foo"bar')), Html('foo&quot;bar'))
706
+ self.assertEqual(Html.escape(HtmlTest.Foo()), Html('&lt;h1&gt;foo&lt;/h1&gt;'))
707
+ self.assertEqual(Html.escape(lambda: 'foo"bar'), 'foo&quot;bar')
708
+ self.assertEqual(Html.escape('"x=y"', javascript_str=True), '\\"x=y\\"')
709
+ self.assertEqual(Html.escape('x\n"', javascript_str=True), 'x\\n\\"')
710
+ self.assertEqual(
711
+ Html.escape(HtmlTest.Foo(), javascript_str=True), Html('<h1>foo</h1>')
712
+ )
713
+
714
+ def test_concate(self):
715
+ self.assertIsNone(Html.concate(None))
716
+ self.assertIsNone(Html.concate([None, [None, [None, None]]]))
717
+ self.assertEqual(Html.concate('a'), 'a')
718
+ self.assertEqual(Html.concate(['a']), 'a')
719
+ self.assertEqual(Html.concate(['a', 'a']), 'a')
720
+ self.assertEqual(Html.concate(['a', 'a'], dedup=False), 'a a')
721
+ self.assertEqual(Html.concate(['a', None, 'b']), 'a b')
722
+ self.assertEqual(
723
+ Html.concate(['a', 'b', [None, 'c', [None, 'd']]]), 'a b c d')
724
+
725
+ def test_element(self):
726
+ # Empty element.
727
+ self.assertEqual(Html.element('div').content, '<div></div>')
728
+ # CSS class as list.
729
+ self.assertEqual(
730
+ Html.element('div', css_classes=['a', 'b', None]).content,
731
+ '<div class="a b"></div>',
732
+ )
733
+ self.assertEqual(
734
+ Html.element('div', css_classes=[None, None]).content,
735
+ '<div></div>',
736
+ )
737
+ # Style as string.
738
+ self.assertEqual(
739
+ Html.element('div', style='color:red;').content,
740
+ '<div style="color:red;"></div>',
741
+ )
742
+ # Style as dictionary.
743
+ self.assertEqual(
744
+ Html.element(
745
+ 'div',
746
+ styles=dict(
747
+ color='red', background_color='blue', width=None,
748
+ )
749
+ ).content,
750
+ '<div style="color:red;background-color:blue;"></div>',
751
+ )
752
+ self.assertEqual(
753
+ Html.element(
754
+ 'div',
755
+ styles=dict(
756
+ color=None,
757
+ )
758
+ ).content,
759
+ '<div></div>',
760
+ )
761
+ # Properties as kwargs
762
+ self.assertEqual(
763
+ Html.element(
764
+ 'details',
765
+ options='open',
766
+ css_classes='my_class',
767
+ id='my_id',
768
+ custom_property='1'
769
+ ).content,
770
+ (
771
+ '<details open class="my_class" id="my_id" custom-property="1">'
772
+ '</details>'
773
+ )
774
+ )
775
+ self.assertEqual(
776
+ Html.element(
777
+ 'details',
778
+ options=[None],
779
+ css_classes='my_class',
780
+ id='my_id',
781
+ custom_property='1'
782
+ ).content,
783
+ (
784
+ '<details class="my_class" id="my_id" custom-property="1">'
785
+ '</details>'
786
+ )
787
+ )
788
+ # Child.
789
+ self.assertEqual(
790
+ Html.element(
791
+ 'div',
792
+ css_classes='my_class',
793
+ inner_html='<h1>foo</h1>'
794
+ ).content,
795
+ '<div class="my_class"><h1>foo</h1></div>',
796
+ )
797
+ # Children.
798
+ self.assert_html(
799
+ str(Html.element(
800
+ 'div',
801
+ [
802
+ '<hr>',
803
+ lambda: '<div>bar</div>',
804
+ None,
805
+ Html.element(
806
+ 'div',
807
+ css_classes='my_class',
808
+ ).add_style('div.my_class { color: red; }')
809
+ ]
810
+ )),
811
+ """
812
+ <html>
813
+ <head>
814
+ <style>
815
+ div.my_class { color: red; }
816
+ </style>
817
+ </head>
818
+ <body>
819
+ <div><hr><div>bar</div><div class="my_class"></div></div>
820
+ </body>
821
+ </html>
822
+ """
823
+ )
824
+
825
+
826
+ # pylint: enable=line-too-long
827
+
828
+
829
+ if __name__ == '__main__':
830
+ unittest.main()