-
Notifications
You must be signed in to change notification settings - Fork 78
/
registration.py
365 lines (303 loc) · 11.4 KB
/
registration.py
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
"""
Languages and generators registration and discovery API.
"""
import fnmatch
import sys
if sys.version_info < (3, 10):
from importlib_metadata import entry_points
else:
from importlib.metadata import entry_points
from textx.exceptions import TextXRegistrationError
class LanguageDesc:
"""
A class used in language registration/discovery.
Attributes:
name (str): the name/ID of the language (must be unique)
pattern (str): filename pattern for models (e.g. "*.data")
description (str): A short description of the language
metamodel (callable): A callable that returns configured meta-model
or the metamodel itself (if a single specific instance is
desired)
project_name (str): Read-only attribute available on registrations from
`pyproject.toml`. Keeps the Python project name of the project that
registered this language.
project_version (str): Read-only attribute available on registrations
from `pyproject.toml`. Keeps the Python project name of the project that
registered this language.
"""
def __init__(self, name, pattern=None, description="", metamodel=None):
self.name = name
self.pattern = pattern
self.description = description
self.metamodel = metamodel
self.project_name = None
self.project_version = None
class GeneratorDesc:
"""
A class used in generators registration/discovery.
Attributes:
language (str): The name/ID of the language this generator is for.
If the generators is generic (applicable to any model)
use "any".
target (str): A short name of the target stack/technology.
description (str): A short description of the generator.
generator (callable): A callable of the form:
def generator(metamodel, model, output_path,
overwrite, debug, **custom_args)
project_name (str): Read-only attribute available on registrations from
`pyproject.toml`. Keeps the Python project name of the project that
registered this generator.
project_version (str): Read-only attribute available on registrations
from `pyproject.toml`. Keeps the Python project name of the project that
registered this language.
"""
def __init__(self, language, target, description="", generator=None):
self.language = language
self.target = target
self.description = description
self.generator = generator
self.project_name = None
self.project_version = None
metamodels = {}
languages = None
generators = None
def language_descriptions():
"""
Return a dict of `LanguageDesc` instances keyed by language name.
"""
global languages
if languages is None:
languages = {}
for language in entry_points(group="textx_languages"):
register_language_with_project(
language.load(), language.dist.name, language.dist.version
)
return languages
def generator_descriptions():
"""
Return a dict of `GeneratorDesc` instances keyed by language name.
"""
global generators
if generators is None:
generators = {}
for generator in entry_points(group="textx_generators"):
register_generator_with_project(
generator.load(), generator.dist.name, generator.dist.version
)
return generators
def language_description(language_name):
"""
Return `LanguageDesc` for the given language name.
"""
global languages
language_name = language_name.lower()
if languages is None:
language_descriptions()
try:
return languages[language_name]
except KeyError as e:
raise TextXRegistrationError(f'Language "{language_name}" not registered.') from e
def generator_description(language_name, target_name, any_permitted=False):
"""
Return `GeneratorDesc` instance for the given target and language name.
If `any_permitted` is `True` return generator for language `any` if
generator for the `language_name` doesn't exist.
"""
global generators
language_name = language_name.lower()
target_name = target_name.lower()
if generators is None:
generator_descriptions()
try:
try:
generators_for_language = generators[language_name]
return generators_for_language[target_name]
except KeyError:
if not any_permitted:
raise
generators_for_language = generators["any"]
return generators_for_language[target_name]
except KeyError as e:
raise TextXRegistrationError(
"No generators registered for language "
f'"{language_name}" and target "{target_name}".'
) from e
def generator_for_language_target(language_name, target_name, any_permitted=False):
"""
Return generator callable for the given language name and target name.
"""
generator_desc = generator_description(
language_name, target_name, any_permitted=any_permitted
)
return generator_desc.generator
def register_language(
language_desc_or_name, pattern=None, description="", metamodel=None
):
"""
Programmatically register a language.
Args:
language_desc_or_name (LanguageDesc or str): If LanguageDesc is given
other parameters are not used.
For other parameters see `LanguageDesc`.
"""
global languages
if languages is None:
language_descriptions()
if not isinstance(language_desc_or_name, LanguageDesc):
language_desc = LanguageDesc(
name=language_desc_or_name,
pattern=pattern,
description=description,
metamodel=metamodel,
)
else:
language_desc = language_desc_or_name
if language_desc.name.lower() in languages:
raise TextXRegistrationError(
f'Language "{language_desc.name}" already registered.'
)
languages[language_desc.name.lower()] = language_desc
def register_language_with_project(language_desc, project_name, project_version):
"""
Register language with Python project name.
"""
language_desc.project_name = project_name
language_desc.project_version = project_version
register_language(language_desc)
def clear_language_registrations():
"""
Clear all registered languages.
"""
global languages, metamodels
languages = None
metamodels = {}
def register_generator(
generator_desc_or_language, target=None, description="", generator=None
):
"""
Programmatically register a generator.
Args:
generator_desc_or_language (GeneratorDesc or str): If GeneratorDesc is
given other parameters are not used.
For other parameters see `GeneratorDesc`.
"""
global generators
if generators is None:
generator_descriptions()
if not isinstance(generator_desc_or_language, GeneratorDesc):
generator_desc = GeneratorDesc(
language=generator_desc_or_language,
target=target,
description=description,
generator=generator,
)
else:
generator_desc = generator_desc_or_language
lang_gens = generators.setdefault(generator_desc.language.lower(), {})
if generator_desc.target.lower() in lang_gens:
raise TextXRegistrationError(
f'Generator "{generator_desc.language}->'
f'{generator_desc.target}" already registered.'
)
lang_gens[generator_desc.target.lower()] = generator_desc
def register_generator_with_project(generator_desc, project_name, project_version):
"""
Register generator with Python project name.
"""
generator_desc.project_name = project_name
generator_desc.project_version = project_version
register_generator(generator_desc)
def clear_generator_registrations():
"""
Clear all registered generators.
"""
global generators
generators = None
def metamodel_for_language(language_name, **kwargs):
"""
Load and return the meta-model for the given language.
Cache it for further use.
"""
language_name = language_name.lower()
if language_name not in metamodels or kwargs:
from textx.metamodel import TextXMetaMetaModel, TextXMetaModel
language = language_description(language_name)
if isinstance(language.metamodel, (TextXMetaModel, TextXMetaMetaModel)):
metamodels[language_name] = language.metamodel
else:
metamodel = language.metamodel(**kwargs)
if not (isinstance(metamodel, (TextXMetaModel, TextXMetaMetaModel))):
raise TextXRegistrationError(
"Meta-model type for language "
f'"{language_name}" is "{metamodel.__class__.__name__}".'
)
metamodels[language_name] = metamodel
return metamodels[language_name]
def languages_for_file(file_name_or_pattern):
"""
Return a list of `LanguageDesc` registered for the given file pattern.
"""
file_languages = []
for language in language_descriptions().values():
if file_name_or_pattern == language.pattern or fnmatch.fnmatch(
file_name_or_pattern, language.pattern
):
file_languages.append(language)
return file_languages
def language_for_file(file_name_or_pattern):
"""
Return an instance of `LanguageDesc` that can parse the given file or raise
`TextXRegistrationError` if more than one is registered.
"""
languages = languages_for_file(file_name_or_pattern)
if len(languages) > 1:
raise TextXRegistrationError(
f'Multiple languages can parse "{file_name_or_pattern}".'
)
elif len(languages) == 0:
raise TextXRegistrationError(
"No language registered that can parse" f' "{file_name_or_pattern}".'
)
return languages[0]
def metamodels_for_file(file_name_or_pattern):
"""
Return meta-models that can parse the given file .
"""
return [
metamodel_for_language(language.name)
for language in languages_for_file(file_name_or_pattern)
]
def metamodel_for_file(file_name_or_pattern, **kwargs):
"""
Return a meta-model that can parse the given file or raise
`TextXRegistrationError` if more than one is registered.
"""
return metamodel_for_language(language_for_file(file_name_or_pattern).name, **kwargs)
def generator(language, target):
"""
Decorator factory used to create `GeneratorDesc` instances suitable for
entry point registration.
The target function docstring is used for the description.
"""
def _generator(gen_f):
return GeneratorDesc(
language=language,
target=target,
description=gen_f.__doc__ if gen_f.__doc__ is not None else "",
generator=gen_f,
)
return _generator
def language(name, pattern=None):
"""
Decorator factory used to create `LanguageDesc` instances suitable for
entry point registration.
The target function docstring is used for the description.
"""
def language(gen_f):
return LanguageDesc(
name=name,
pattern=pattern,
description=gen_f.__doc__.strip() if gen_f.__doc__ is not None else "",
metamodel=gen_f,
)
return language