-
Notifications
You must be signed in to change notification settings - Fork 1
/
loader.py
671 lines (471 loc) · 20.2 KB
/
loader.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
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
# -*- coding: utf-8 -*-
# This file is part of the pymfony package.
#
# (c) Alexandre Quercia <[email protected]>
#
# For the full copyright and license information, please view the LICENSE
# file that was distributed with this source code.
from __future__ import absolute_import;
import sys;
from pymfony.component.dependency.interface import ContainerInterface
if sys.version_info[0] >= 3:
from configparser import ConfigParser;
else:
from ConfigParser import ConfigParser;
import os.path;
import json;
from pymfony.component.system.oop import abstract;
from pymfony.component.system.types import String;
from pymfony.component.config import FileLocatorInterface;
from pymfony.component.config.loader import FileLoader as BaseFileLoader;
from pymfony.component.config.resource import FileResource;
from pymfony.component.dependency import ContainerBuilder;
from pymfony.component.dependency import Definition;
from pymfony.component.dependency import Reference;
from pymfony.component.dependency.definition import Alias;
from pymfony.component.dependency.definition import DefinitionDecorator
from pymfony.component.dependency.exception import InvalidArgumentException;
from pymfony.component.yaml import Yaml;
"""
"""
@abstract
class FileLoader(BaseFileLoader):
def __init__(self, container, locator):
assert isinstance(container, ContainerBuilder);
assert isinstance(locator, FileLocatorInterface);
self._container = container;
BaseFileLoader.__init__(self, locator);
class IniFileLoader(FileLoader):
"""IniFileLoader loads parameters from INI files."""
def load(self, resource, resourceType=None):
path = self._locator.locate(resource);
self._container.addResource(FileResource(path));
content = self._parseFile(path);
if not content:
return;
self.__parseParameters(content);
def supports(self, resource, resourceType=None):
if isinstance(resource, String):
if os.path.basename(resource).endswith(".ini"):
return True;
return False;
def _parseFile(self, filename):
"""Parses a INI file.
@param filename: string The path file
@return: dict The file content
@raise InvalidArgumentException: When INI file is not valid
"""
content = dict();
cfgParser = ConfigParser();
result = cfgParser.read(filename);
if not result:
raise InvalidArgumentException(
'The "{0]" file is not valid.'.format(filename)
);
for section in cfgParser.sections():
content[section] = dict();
for key, value in cfgParser.items(section):
content[section][key] = value;
return content;
def __parseParameters(self, content):
if 'parameters' in content:
for key, value in dict(content['parameters']).items():
self._container.setParameter(key, value);
class JsonFileLoader(FileLoader):
"""JsonFileLoader loads parameters from JSON files."""
def load(self, resource, resourceType = None):
path = self._locator.locate(resource);
content = self._parseFile(path);
self._container.addResource(FileResource(path));
# empty file
if content is None:
return;
# imports
self.__parseImports(content, path);
# parameters
if 'parameters' in content:
for key, value in content['parameters'].items():
self._container.setParameter(key, self.__resolveServices(value));
# extensions
self.__loadFromExtensions(content);
# services
self.__parseDefinitions(content, resource);
def supports(self, resource, resourceType = None):
"""Returns true if this class supports the given resource.
@param resource: mixed A resource
@param resourceType: string The resource type
@return Boolean true if this class supports the given resource,
false otherwise
"""
return isinstance(resource, String) and resource.endswith("{0}json".format(os.path.extsep));
def _parseFile(self, filename):
"""Parses a JSON file.
@param filename: string The path file
@return: dict The file content
@raise InvalidArgumentException: When JSON file is not valid
"""
f = open(filename);
s = f.read().strip();
f.close();
del f;
if not s:
return None;
try:
result = json.loads(s);
except ValueError as e:
raise InvalidArgumentException(e);
return self.__validate(result, filename);
def __validate(self, content, resource):
"""Validates a YAML file.
@param content: mixed
@param resource: string
@return: dict
@raise InvalidArgumentException: When service file is not valid
"""
if content is None:
return;
if not isinstance(content, dict):
raise InvalidArgumentException('The "{0}" file is not valid.'.format(
resource
));
for namespace in content.keys():
if namespace in ['imports', 'parameters', 'services']:
continue;
if not self._container.hasExtension(namespace):
extensionNamespaces = filter(None, map(lambda e: e.getAlias(), self._container.getExtensions()));
raise InvalidArgumentException(
'There is no extension able to load the configuration '
'for "{0}" (in {1}). Looked for namespace "{0}", found "{2}"'
''.format(
namespace,
resource,
'", "'.join(extensionNamespaces)
));
return content;
def __parseImports(self, content, resource):
"""Parses all imports
@param content: dict
@param resource: string
"""
if 'imports' not in content:
return;
for imports in content['imports']:
self.setCurrentDir(os.path.dirname(resource));
self.imports(imports['resource'], None, bool(imports['ignore_errors']) if 'ignore_errors' in imports else False, resource);
def __parseDefinitions(self, content, resource):
"""Parses definitions
@param content: dict
@param resource: string
"""
if not 'services' in content:
return;
for identifier, service in content['services'].items():
self.__parseDefinition(identifier, service, resource);
def __parseDefinition(self, identifier, service, resource):
"""Parses a definition.
@param identifier: string
@param service: dict
@param resource: string
@raise InvalidArgumentException: When tags are invalid
"""
if isinstance(service, String) and service.startswith('@') :
self._container.setAlias(identifier, service[1:]);
return;
elif 'alias' in service :
public = 'public' not in service or bool(service['public']);
self._container.setAlias(identifier, Alias(service['alias'], public));
return;
if 'parent' in service :
definition = DefinitionDecorator(service['parent']);
else :
definition = Definition();
if 'class' in service:
definition.setClass(service['class']);
if 'scope' in service:
definition.setScope(service['scope']);
if 'synthetic' in service:
definition.setSynthetic(service['synthetic']);
if 'public' in service:
definition.setPublic(service['public']);
if 'abstract' in service:
definition.setAbstract(service['abstract']);
if 'factory_class' in service:
definition.setFactoryClass(service['factory_class']);
if 'factory_method' in service:
definition.setFactoryMethod(service['factory_method']);
if 'factory_service' in service:
definition.setFactoryService(service['factory_service']);
if 'file' in service:
definition.setFile(service['file']);
if 'arguments' in service:
definition.setArguments(self.__resolveServices(service['arguments']));
if 'properties' in service:
definition.setProperties(self.__resolveServices(service['properties']));
if 'configurator' in service:
if isinstance(service['configurator'], String):
definition.setConfigurator(service['configurator']);
else:
definition.setConfigurator([
self.__resolveServices(service['configurator'][0]),
service['configurator'][1]
]);
if 'calls' in service:
for call in service['calls']:
args = self.__resolveServices(call[1]) if len(call) >= 2 else [];
definition.addMethodCall(call[0], args);
if 'tags' in service:
if not isinstance(service['tags'], list):
raise InvalidArgumentException(
'Parameter "tags" must be a list for service '
'"{0}" in {1}.'.format(identifier, resource)
);
for tag in service['tags']:
if not isinstance(tag, dict) or 'name' not in tag:
raise InvalidArgumentException(
'A "tags" entry is missing a "name" key for service '
'"{0}" in {1}.'.format(identifier, resource)
);
name = tag['name'];
del tag['name'];
for value in tag.values():
if not isinstance(value, (type(None),String,int,float,bool)):
raise InvalidArgumentException(
'A "tags" attribute must be of a scalar-type '
'for service "{0}", tag "{1}" in {2}.'
''.format(identifier, name, resource)
);
definition.addTag(name, tag);
self._container.setDefinition(identifier, definition);
def __resolveServices(self, value):
"""Resolves services.
@param value: string
@return: Reference
"""
if isinstance(value, list):
value = list(map(self.__resolveServices, value));
if isinstance(value, String) and value.startswith("@"):
if value.startswith('@@'):
value = value[1:];
invalidBehavior = None;
elif value.startswith("@?"):
value = value[2:];
invalidBehavior = ContainerInterface.IGNORE_ON_INVALID_REFERENCE;
else:
value = value[1:];
invalidBehavior = ContainerInterface.EXCEPTION_ON_INVALID_REFERENCE;
if value.endswith("="):
value = value[:-1];
strict = False;
else:
strict = True;
if None is not invalidBehavior:
value = Reference(value, invalidBehavior, strict);
return value;
def __loadFromExtensions(self, content):
"""Loads from Extensions
@param content: dict
"""
assert isinstance(content, dict);
for namespace, values in content.items():
if namespace in ['imports', 'parameters', 'services']:
continue;
if not isinstance(values, dict) :
values = {};
self._container.loadFromExtension(namespace, values);
class YamlFileLoader(FileLoader):
"""YamlFileLoader loads YAML files service definitions.
The YAML format does not support anonymous services (cf. the XML loader).
@author Fabien Potencier <[email protected]>
"""
def load(self, resource, resourceType = None):
"""Loads a Yaml file.
@param resource: mixed The resource
@param resourceType: string The resource type
"""
path = self._locator.locate(resource);
content = self._loadFile(path);
self._container.addResource(FileResource(path));
# empty file
if content is None:
return;
# imports
self.__parseImports(content, path);
# parameters
if 'parameters' in content:
for key, value in content['parameters'].items():
self._container.setParameter(key, self.__resolveServices(value));
# extensions
self.__loadFromExtensions(content);
# services
self.__parseDefinitions(content, resource);
def supports(self, resource, resourceType = None):
"""Returns true if this class supports the given resource.
@param resource: mixed A resource
@param resourceType: string The resource type
@return Boolean true if this class supports the given resource,
false otherwise
"""
return isinstance(resource, String) and resource.endswith("{0}yml".format(os.path.extsep));
def __parseImports(self, content, resource):
"""Parses all imports
@param content: dict
@param resource: string
"""
if 'imports' not in content:
return;
for imports in content['imports']:
self.setCurrentDir(os.path.dirname(resource));
self.imports(imports['resource'], None, bool(imports['ignore_errors']) if 'ignore_errors' in imports else False, resource);
def __parseDefinitions(self, content, resource):
"""Parses definitions
@param content: dict
@param resource: string
"""
if not 'services' in content:
return;
for identifier, service in content['services'].items():
self.__parseDefinition(identifier, service, resource);
def __parseDefinition(self, identifier, service, resource):
"""Parses a definition.
@param identifier: string
@param service: dict
@param resource: string
@raise InvalidArgumentException: When tags are invalid
"""
if isinstance(service, String) and service.startswith('@') :
self._container.setAlias(identifier, service[1:]);
return;
elif 'alias' in service :
public = 'public' not in service or bool(service['public']);
self._container.setAlias(identifier, Alias(service['alias'], public));
return;
if 'parent' in service :
definition = DefinitionDecorator(service['parent']);
else :
definition = Definition();
if 'class' in service:
definition.setClass(service['class']);
if 'scope' in service:
definition.setScope(service['scope']);
if 'synthetic' in service:
definition.setSynthetic(service['synthetic']);
if 'public' in service:
definition.setPublic(service['public']);
if 'abstract' in service:
definition.setAbstract(service['abstract']);
if 'factory_class' in service:
definition.setFactoryClass(service['factory_class']);
if 'factory_method' in service:
definition.setFactoryMethod(service['factory_method']);
if 'factory_service' in service:
definition.setFactoryService(service['factory_service']);
if 'file' in service:
definition.setFile(service['file']);
if 'arguments' in service:
definition.setArguments(self.__resolveServices(service['arguments']));
if 'properties' in service:
definition.setProperties(self.__resolveServices(service['properties']));
if 'configurator' in service:
if isinstance(service['configurator'], String):
definition.setConfigurator(service['configurator']);
else:
definition.setConfigurator([
self.__resolveServices(service['configurator'][0]),
service['configurator'][1]
]);
if 'calls' in service:
for call in service['calls']:
args = self.__resolveServices(call[1]) if len(call) >= 2 else [];
definition.addMethodCall(call[0], args);
if 'tags' in service:
if not isinstance(service['tags'], list):
raise InvalidArgumentException(
'Parameter "tags" must be a list for service '
'"{0}" in {1}.'.format(identifier, resource)
);
for tag in service['tags']:
if not isinstance(tag, dict) or 'name' not in tag:
raise InvalidArgumentException(
'A "tags" entry is missing a "name" key for service '
'"{0}" in {1}.'.format(identifier, resource)
);
name = tag['name'];
del tag['name'];
for value in tag.values():
if not isinstance(value, (type(None),String,int,float,bool)):
raise InvalidArgumentException(
'A "tags" attribute must be of a scalar-type '
'for service "{0}", tag "{1}" in {2}.'
''.format(identifier, name, resource)
);
definition.addTag(name, tag);
self._container.setDefinition(identifier, definition);
def _loadFile(self, resource):
"""Loads a YAML file.
@param resource: string
@return dict The file content
"""
return self.__validate(Yaml.parse(resource), resource);
def __validate(self, content, resource):
"""Validates a YAML file.
@param content: mixed
@param resource: string
@return: dict
@raise InvalidArgumentException: When service file is not valid
"""
if content is None:
return;
if not isinstance(content, dict):
raise InvalidArgumentException('The "{0}" file is not valid.'.format(
resource
));
for namespace in content.keys():
if namespace in ['imports', 'parameters', 'services']:
continue;
if not self._container.hasExtension(namespace):
extensionNamespaces = filter(None, map(lambda e: e.getAlias(), self._container.getExtensions()));
raise InvalidArgumentException(
'There is no extension able to load the configuration '
'for "{0}" (in {1}). Looked for namespace "{0}", found "{2}"'
''.format(
namespace,
resource,
'", "'.join(extensionNamespaces)
));
return content;
def __resolveServices(self, value):
"""Resolves services.
@param value: string
@return: Reference
"""
if isinstance(value, list):
value = list(map(self.__resolveServices, value));
if isinstance(value, String) and value.startswith("@"):
if value.startswith('@@'):
value = value[1:];
invalidBehavior = None;
elif value.startswith("@?"):
value = value[2:];
invalidBehavior = ContainerInterface.IGNORE_ON_INVALID_REFERENCE;
else:
value = value[1:];
invalidBehavior = ContainerInterface.EXCEPTION_ON_INVALID_REFERENCE;
if value.endswith("="):
value = value[:-1];
strict = False;
else:
strict = True;
if None is not invalidBehavior:
value = Reference(value, invalidBehavior, strict);
return value;
def __loadFromExtensions(self, content):
"""Loads from Extensions
@param content: dict
"""
assert isinstance(content, dict);
for namespace, values in content.items():
if namespace in ['imports', 'parameters', 'services']:
continue;
if not isinstance(values, dict) :
values = {};
self._container.loadFromExtension(namespace, values);