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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
|
import shutil
from pathlib import Path
import aiohttp
import yaml
PKG_INIT = """__path__ = __import__("pkgutil").extend_path(__path__, __name__)"""
EXT_BY_TYPES = {
"scripts": ".js",
"styles": ".css",
}
async def generate_trame_package(config_path, output_path):
output = Path(output_path)
output.mkdir(parents=True, exist_ok=True)
with open(config_path) as f:
config = yaml.safe_load(f)
await create_base_structure(Path(config_path).parent.absolute(), config, output)
async def create_base_structure(ref_path, config, output):
trame_plugins = {}
# Trame structure
for package_name in ["modules", "widgets"]:
root_dir = output / "trame" / package_name
root_dir.mkdir(parents=True, exist_ok=True)
(root_dir / "__init__.py").write_text(PKG_INIT)
(output / "trame" / "__init__.py").write_text(PKG_INIT)
# Package structure
for name in config:
root_dir = output / name
root_dir.mkdir(parents=True, exist_ok=True)
(root_dir / "__init__.py").write_text("")
for sub_name in config[name]:
sub_package = root_dir / sub_name
sub_package.mkdir(parents=True, exist_ok=True)
(sub_package / "__init__.py").write_text("")
# Create files
for module in config[name][sub_name]:
if sub_name == "module":
module_root = sub_package / module
module_root.mkdir(parents=True, exist_ok=True)
module_root_init = module_root / "__init__.py"
module_conf_init = {}
for web_dir in config[name][sub_name][module]:
module_conf_init[web_dir] = await create_web_content(
ref_path,
(module_root / web_dir),
config[name][sub_name][module][web_dir],
)
# Register trame/modules/{webdir}
trame_plugins[f"trame/modules/{module}.py"] = (
f"from {name}.module.{module} import * # noqa F403\n"
)
create_module_init(module_root_init, module_conf_init)
elif sub_name == "widgets":
file_path = sub_package / f"{module}.py"
with file_path.open("w") as file:
file.write(
"from trame_client.widgets.core import AbstractElement, Template # noqa\n"
)
file.write(f"from ..module import {module}\n")
file.write("\nclass HtmlElement(AbstractElement):")
file.write(
"\n def __init__(self, _elem_name, children=None, **kwargs):"
)
file.write(
"\n super().__init__(_elem_name, children, **kwargs)"
)
file.write("\n if self.server:")
file.write(f"\n self.server.enable_module({module})")
file.write("\n\n")
all_class_names = []
for (
class_name,
class_info,
) in config[name][sub_name][module].items():
if class_name == "directives":
for entry in class_info:
if isinstance(entry, list):
file.write(
f'\nAbstractElement.register_directive("{entry[0]}", "{entry[1]}")'
)
else:
file.write(
f'\nAbstractElement.register_directive("{entry}")'
)
file.write("\n\n")
else:
all_class_names.append(class_name)
component = class_info.get("component")
properties = class_info.get("properties", [])
events = class_info.get("events", [])
file.write(f"\nclass {class_name}(HtmlElement):")
to_py_help(file, class_info, class_name)
if class_info.get("methods"):
file.write("\n _next_id = 0")
file.write(
"\n def __init__(self, children=None, **kwargs):"
)
file.write(
f'\n super().__init__("{component}", children, **kwargs)'
)
file.write("\n self._attr_names += [")
for item in properties:
to_py_attr(file, item, 4 * 3)
file.write("\n ]")
file.write("\n self._event_names += [")
for item in events:
to_py_attr(file, item, 4 * 3)
file.write("\n ]")
# Generate ref
if class_info.get("methods"):
file.write(
f"""\n {class_name}._next_id += 1"""
)
file.write(
f"""\n self.__ref = kwargs.get("ref", f"{
class_name
}_{{{class_name}._next_id}}")"""
)
file.write(
"""\n self._attributes["ref"] = f'ref="{self.__ref}"'"""
)
file.write("\n\n")
file.write("\n @property")
file.write("\n def ref(self):")
file.write("\n return self.__ref")
file.write("\n\n")
for entry in class_info.get("methods"):
method = entry.get("name")
help = entry.get("help")
if isinstance(
method,
(list, tuple),
):
py_m, js_m = method
else:
py_m = method
js_m = method
file.write(f"\n def {py_m}(self, *args):")
if help:
file.write(f'\n """{help}')
if help.endswith("\n"):
file.write(' """')
elif "\n" in help:
file.write('\n """')
else:
file.write('"""')
file.write(
f'\n self.server.js_call(self.ref, "{js_m}", *args)'
)
file.write("\n\n")
else:
file.write("\n\n")
file.write("\n__all__ = [")
for class_name in all_class_names:
file.write(f'\n{" " * 4}"{class_name}",')
file.write("\n]")
file.write("\n")
# Register trame/modules/{webdir}
trame_plugins[f"trame/widgets/{module}.py"] = (
f"from {name}.widgets.{module} import * # noqa F403\n"
"\n"
f"def initialize(server):\n"
f" from {name}.module import {module}\n"
"\n"
f" server.enable_module({module})\n"
)
# Create trame package connectors
for file, content in trame_plugins.items():
(output / file).write_text(content)
def create_module_init(init_path, init_conf):
for name in init_conf:
m_conf = init_conf[name]
m = init_path.with_name(f"{name}.py")
widget_name = init_path.parent.name
with m.open("w") as file:
file.write("from pathlib import Path\n")
file.write("\n")
file.write(
f'serve_path = str(Path(__file__).with_name("{name}").resolve())\n'
)
file.write(f'serve = {{"__trame_{widget_name}": serve_path }}\n')
for group in ["scripts", "styles"]:
if group in m_conf:
file.write(f"{group} = [\n")
for f_name in m_conf[group]:
file.write(f' "__trame_{widget_name}/{f_name}",\n')
file.write("]\n")
if "vue_use" in m_conf:
file.write("vue_use = [\n")
for name in m_conf["vue_use"]:
file.write(f' "{name}",\n')
file.write("]\n")
with init_path.open("w") as file:
file.write("def setup(server, **kargs):\n")
file.write(' client_type = "vue3"\n')
file.write(' if hasattr(server, "client_type"):\n')
file.write(" client_type = server.client_type\n")
if "vue2" in init_conf:
file.write(' if client_type == "vue2":\n')
file.write(" from . import vue2\n")
file.write(" server.enable_module(vue2)\n")
if "vue3" in init_conf:
file.write(
f' {"elif" if "vue2" in init_conf else "if"} client_type == "vue3":\n'
)
file.write(" from . import vue3\n")
file.write(" server.enable_module(vue3)\n")
file.write(" else:\n")
file.write(" raise TypeError(\n")
file.write(
' f"Trying to initialize trame_vuetify with unknown client_type={client_type}"\n'
)
file.write(" )\n")
async def create_web_content(ref_path, base_directory, web_config):
out_conf = {}
base_directory.mkdir(parents=True, exist_ok=True)
for key in web_config:
if key in ["scripts", "styles"]:
local_conf = []
out_conf[key] = local_conf
for item in web_config[key]:
if isinstance(item, str):
if item.startswith("http"):
local_conf.append(
await handle_url(
base_directory,
item,
EXT_BY_TYPES[key],
)
)
else:
local_conf.append(
handle_relative_path(
ref_path,
base_directory,
item,
)
)
else:
# in-line JS file
local_conf.append(handle_inline(base_directory, item))
else:
out_conf[key] = web_config[key]
return out_conf
URL_FILE_COUNT = 0
async def handle_url(base_directory, entry, ext):
global URL_FILE_COUNT
URL_FILE_COUNT += 1
file_name = f"{URL_FILE_COUNT}{ext}"
if "?" in file_name:
file_name = file_name.split("?")[0]
async with aiohttp.ClientSession() as session:
async with session.get(entry) as resp:
if resp.status == 200:
content = await resp.read()
with (base_directory / file_name).open(mode="wb") as f:
f.write(content)
return file_name
def handle_relative_path(ref_path, base_directory, entry):
src = ref_path / entry
file_name = src.name
dst = base_directory / file_name
shutil.copyfile(src, dst)
return file_name
def handle_inline(base_directory, entry):
file_name = entry.get("name")
content = entry.get("content")
dst = base_directory / file_name
with dst.open(mode="w") as f:
f.write(content)
return file_name
def to_py_attr(file, item, indent=4):
entry = item.get("name")
if isinstance(entry, (list, tuple)):
py_name, js_name = entry
file.write(f'\n{" " * indent}("{py_name}", "{js_name}"),')
else:
file.write(f'\n{" " * indent}"{entry}",')
def multi_line_help(help, indent):
help = help.strip()
if len(help) > 80:
tokens = help.split(" ")
description_lines = []
while len(tokens):
line = []
while len(" ".join(line)) < 60 and len(tokens):
line.append(tokens.pop(0))
description_lines.append(" ".join(line))
line = []
if len(line):
description_lines.append(" ".join(line))
help = f"\n{' ' * indent}".join(description_lines)
return help
def to_py_help(file, class_info, class_name):
indent = 4
file.write(f'\n{" " * indent}"""')
main_help = class_info.get("help", "")
properties = class_info.get("properties", [])
events = class_info.get("properties", [])
if len(main_help):
file.write(f"\n{' ' * indent}{main_help}")
else:
file.write(
f"\n{' ' * indent}Component {class_name} with the following properties\n"
)
if len(properties) + len(events) > 0:
file.write(f"\n{' ' * indent}Args:")
if len(properties):
for prop in properties:
name = prop.get("name")
help = prop.get("help", "").replace("\n", " ")
if isinstance(name, (list, tuple)):
name = name[0]
file.write(f"\n{' ' * (indent + 2)}{name}:\n{' ' * (indent + 4)}")
file.write(multi_line_help(help, indent + 4))
if len(events):
for prop in events:
name = prop.get("name")
help = prop.get("help", "").replace("\n", " ")
if isinstance(name, (list, tuple)):
name = name[0]
file.write(f"\n{' ' * (indent + 2)}{name} (event):\n{' ' * (indent + 4)}")
file.write(multi_line_help(help, indent + 4))
file.write(f'\n\n{" " * indent}"""')
|
