-
Notifications
You must be signed in to change notification settings - Fork 1
/
generateDS.py
executable file
·4802 lines (4525 loc) · 183 KB
/
generateDS.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
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env python
"""
Synopsis:
Generate Python classes from XML Schema definition.
Input is read from in_xsd_file or, if "-" (dash) arg, from stdin.
Output is written to files named in "-o" and "-s" options.
Usage:
python generateDS.py [ options ] <xsd_file>
python generateDS.py [ options ] -
Options:
-h, --help Display this help information.
-o <outfilename> Output file name for data representation classes
-s <subclassfilename> Output file name for subclasses
-p <prefix> Prefix string to be pre-pended to the class names
-f Force creation of output files. Do not ask.
-a <namespaceabbrev> Namespace abbreviation, e.g. "xsd:".
Default = 'xs:'.
-b <behaviorfilename> Input file name for behaviors added to subclasses
-m Generate properties for member variables
--subclass-suffix="XXX" Append XXX to the generated subclass names.
Default="Sub".
--root-element="XXX" Assume XXX is root element of instance docs.
Default is first element defined in schema.
Also see section "Recognizing the top level
element" in the documentation.
--super="XXX" Super module name in subclass module. Default="???"
--validator-bodies=path Path to a directory containing files that provide
bodies (implementations) of validator methods.
--use-old-getter-setter Name getters and setters getVar() and setVar(),
instead of get_var() and set_var().
--user-methods= <module>,
-u <module> Optional module containing user methods. See
section "User Methods" in the documentation.
--no-dates Do not include the current date in the generated
files. This is useful if you want to minimize
the amount of (no-operation) changes to the
generated python code.
--no-versions Do not include the current version in the generated
files. This is useful if you want to minimize
the amount of (no-operation) changes to the
generated python code.
--no-process-includes Do not process included XML Schema files. By
default, generateDS.py will insert content
from files referenced by <include ... />
elements into the XML Schema to be processed.
--silence Normally, the code generated with generateDS
echoes the information being parsed. To prevent
the echo from occurring, use the --silence switch.
--namespacedef='xmlns:abc="http://www.abc.com"'
Namespace definition to be passed in as the
value for the namespacedef_ parameter of
the export() method by the generated
parse() and parseString() functions.
Default=''.
--external-encoding=<encoding>
Encode output written by the generated export
methods using this encoding. Default, if omitted,
is the value returned by sys.getdefaultencoding().
Example: --external-encoding='utf-8'.
--member-specs=list|dict
Generate member (type) specifications in each
class: a dictionary of instances of class
MemberSpec_ containing member name, type,
and array or not. Allowed values are
"list" or "dict". Default: do not generate.
-q, --no-questions Do not ask questios, for example,
force overwrite.
--session=mysession.session
Load and use options from session file. You can
create session file in generateds_gui.py. Or,
copy and edit sample.session from the
distribution.
--version Print version and exit.
"""
## LICENSE
## Copyright (c) 2003 Dave Kuhlman
## 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.
#from __future__ import generators # only needed for Python 2.2
import sys
import os.path
import time
import getopt
import urllib2
import imp
from xml.sax import handler, make_parser
import xml.sax.xmlreader
import logging
import keyword
import StringIO
import textwrap
# Default logger configuration
## logging.basicConfig(level=logging.DEBUG,
## format='%(asctime)s %(levelname)s %(message)s')
## import warnings
## warnings.warn('importing IPShellEmbed', UserWarning)
## from IPython.Shell import IPShellEmbed
## args = ''
## ipshell = IPShellEmbed(args,
## banner = 'Dropping into IPython',
## exit_msg = 'Leaving Interpreter, back to program.')
# Then use the following line where and when you want to drop into the
# IPython shell:
# ipshell('<some message> -- Entering ipshell.\\nHit Ctrl-D to exit')
#
# Global variables etc.
#
#
# Do not modify the following VERSION comments.
# Used by updateversion.py.
##VERSION##
VERSION = '2.5a'
##VERSION##
GenerateProperties = 0
UseOldGetterSetter = 0
MemberSpecs = None
DelayedElements = []
DelayedElements_subclass = []
AlreadyGenerated = []
AlreadyGenerated_subclass = []
PostponedExtensions = []
ElementsForSubclasses = []
ElementDict = {}
Force = False
NoQuestions = False
Dirpath = []
ExternalEncoding = sys.getdefaultencoding()
NamespacesDict = {}
Targetnamespace = ""
NameTable = {
'type': 'type_',
'float': 'float_',
'build': 'build_',
}
for kw in keyword.kwlist:
NameTable[kw] = '%sxx' % kw
SubclassSuffix = 'Sub'
RootElement = None
AttributeGroups = {}
ElementGroups = {}
SubstitutionGroups = {}
#
# SubstitutionGroups can also include simple types that are
# not (defined) elements. Keep a list of these simple types.
# These are simple types defined at top level.
SimpleElementDict = {}
SimpleTypeDict = {}
ValidatorBodiesBasePath = None
UserMethodsPath = None
UserMethodsModule = None
XsdNameSpace = ''
CurrentNamespacePrefix = 'xs:'
SchemaToPythonTypeMap = {}
def set_type_constants(nameSpace):
global CurrentNamespacePrefix, \
StringType, TokenType, \
IntegerType, DecimalType, \
PositiveIntegerType, NegativeIntegerType, \
NonPositiveIntegerType, NonNegativeIntegerType, \
BooleanType, FloatType, DoubleType, \
ElementType, ComplexTypeType, GroupType, SequenceType, ChoiceType, \
AttributeGroupType, AttributeType, SchemaType, \
DateTimeType, DateType, \
SimpleContentType, ComplexContentType, ExtensionType, \
IDType, IDREFType, IDREFSType, IDTypes, \
NameType, NCNameType, QNameType, NameTypes, \
AnyAttributeType, SimpleTypeType, RestrictionType, \
WhiteSpaceType, ListType, EnumerationType, UnionType, \
AnnotationType, DocumentationType, \
OtherSimpleTypes
CurrentNamespacePrefix = nameSpace
AttributeGroupType = nameSpace + 'attributeGroup'
AttributeType = nameSpace + 'attribute'
BooleanType = nameSpace + 'boolean'
ChoiceType = nameSpace + 'choice'
SimpleContentType = nameSpace + 'simpleContent'
ComplexContentType = nameSpace + 'complexContent'
ComplexTypeType = nameSpace + 'complexType'
GroupType = nameSpace + 'group'
SimpleTypeType = nameSpace + 'simpleType'
RestrictionType = nameSpace + 'restriction'
WhiteSpaceType = nameSpace + 'whiteSpace'
AnyAttributeType = nameSpace + 'anyAttribute'
DateTimeType = nameSpace + 'dateTime'
DateType = nameSpace + 'date'
IntegerType = (nameSpace + 'integer',
nameSpace + 'unsignedShort',
nameSpace + 'unsignedLong',
nameSpace + 'unsignedInt',
nameSpace + 'unsignedByte',
nameSpace + 'short',
nameSpace + 'long',
nameSpace + 'int',
)
DecimalType = nameSpace + 'decimal'
PositiveIntegerType = nameSpace + 'positiveInteger'
NegativeIntegerType = nameSpace + 'negativeInteger'
NonPositiveIntegerType = nameSpace + 'nonPositiveInteger'
NonNegativeIntegerType = nameSpace + 'nonNegativeInteger'
DoubleType = nameSpace + 'double'
ElementType = nameSpace + 'element'
ExtensionType = nameSpace + 'extension'
FloatType = nameSpace + 'float'
IDREFSType = nameSpace + 'IDREFS'
IDREFType = nameSpace + 'IDREF'
IDType = nameSpace + 'ID'
IDTypes = (IDREFSType, IDREFType, IDType, )
SchemaType = nameSpace + 'schema'
SequenceType = nameSpace + 'sequence'
StringType = (nameSpace + 'string',
nameSpace + 'duration',
nameSpace + 'anyURI',
nameSpace + 'normalizedString',
nameSpace + 'NMTOKEN',
nameSpace + 'ID',
nameSpace + 'Name',
)
TokenType = nameSpace + 'token'
NameType = nameSpace + 'Name'
NCNameType = nameSpace + 'NCName'
QNameType = nameSpace + 'QName'
NameTypes = (NameType, NCNameType, QNameType, )
ListType = nameSpace + 'list'
EnumerationType = nameSpace + 'enumeration'
UnionType = nameSpace + 'union'
AnnotationType = nameSpace + 'annotation'
DocumentationType = nameSpace + 'documentation'
OtherSimpleTypes = (
nameSpace + 'ENTITIES',
nameSpace + 'ENTITY',
nameSpace + 'ID',
nameSpace + 'IDREF',
nameSpace + 'IDREFS',
nameSpace + 'NCName',
nameSpace + 'NMTOKEN',
nameSpace + 'NMTOKENS',
nameSpace + 'NOTATION',
nameSpace + 'Name',
nameSpace + 'QName',
nameSpace + 'anyURI',
nameSpace + 'base64Binary',
nameSpace + 'boolean',
nameSpace + 'byte',
nameSpace + 'date',
nameSpace + 'dateTime',
nameSpace + 'decimal',
nameSpace + 'double',
nameSpace + 'duration',
nameSpace + 'float',
nameSpace + 'gDay',
nameSpace + 'gMonth',
nameSpace + 'gMonthDay',
nameSpace + 'gYear',
nameSpace + 'gYearMonth',
nameSpace + 'hexBinary',
nameSpace + 'int',
nameSpace + 'integer',
nameSpace + 'language',
nameSpace + 'long',
nameSpace + 'negativeInteger',
nameSpace + 'nonNegativeInteger',
nameSpace + 'nonPositiveInteger',
nameSpace + 'normalizedString',
nameSpace + 'positiveInteger',
nameSpace + 'short',
nameSpace + 'string',
nameSpace + 'time',
nameSpace + 'token',
nameSpace + 'unsignedByte',
nameSpace + 'unsignedInt',
nameSpace + 'unsignedLong',
nameSpace + 'unsignedShort',
nameSpace + 'anySimpleType',
)
global SchemaToPythonTypeMap
SchemaToPythonTypeMap = {
BooleanType : 'bool',
DecimalType : 'float',
DoubleType : 'float',
FloatType : 'float',
NegativeIntegerType : 'int',
NonNegativeIntegerType : 'int',
NonPositiveIntegerType : 'int',
PositiveIntegerType : 'int',
}
SchemaToPythonTypeMap.update(dict((x, 'int') for x in IntegerType))
#
# For debugging.
#
# Print only if DEBUG is true.
DEBUG = 0
def dbgprint(level, msg):
if DEBUG and level > 0:
print msg
def pplist(lst):
for count, item in enumerate(lst):
print '%d. %s' % (count, item)
#
# Representation of element definition.
#
def showLevel(outfile, level):
for idx in range(level):
outfile.write(' ')
class XschemaElementBase:
def __init__(self):
pass
class SimpleTypeElement(XschemaElementBase):
def __init__(self, name):
XschemaElementBase.__init__(self)
self.name = name
self.base = None
self.collapseWhiteSpace = 0
# Attribute definitions for the current attributeGroup, if there is one.
self.attributeGroup = None
# Attribute definitions for the currect element.
self.attributeDefs = {}
self.complexType = 0
# Enumeration values for the current element.
self.values = list()
# The other simple types this is a union of.
self.unionOf = list()
self.simpleType = 0
self.listType = 0
self.documentation = ''
def setName(self, name): self.name = name
def getName(self): return self.name
def setBase(self, base): self.base = base
def getBase(self): return self.base
def setSimpleType(self, simpleType): self.simpleType = simpleType
def getSimpleType(self): return self.simpleType
def getAttributeGroups(self): return self.attributeGroups
def setAttributeGroup(self, attributeGroup): self.attributeGroup = attributeGroup
def getAttributeGroup(self): return self.attributeGroup
def setListType(self, listType): self.listType = listType
def isListType(self): return self.listType
def __str__(self):
s1 = '<"%s" SimpleTypeElement instance at 0x%x>' % \
(self.getName(), id(self))
return s1
def __repr__(self):
s1 = '<"%s" SimpleTypeElement instance at 0x%x>' % \
(self.getName(), id(self))
return s1
def resolve_list_type(self):
if self.isListType():
return 1
elif self.getBase() in SimpleTypeDict:
base = SimpleTypeDict[self.getBase()]
return base.resolve_list_type()
else:
return 0
class XschemaElement(XschemaElementBase):
def __init__(self, attrs):
XschemaElementBase.__init__(self)
self.cleanName = ''
self.attrs = dict(attrs)
name_val = ''
type_val = ''
ref_val = ''
if 'name' in self.attrs:
name_val = strip_namespace(self.attrs['name'])
if 'type' in self.attrs:
if (len(XsdNameSpace) > 0 and
self.attrs['type'].startswith(XsdNameSpace)):
type_val = self.attrs['type']
else:
type_val = strip_namespace(self.attrs['type'])
if 'ref' in self.attrs:
ref_val = strip_namespace(self.attrs['ref'])
if type_val and not name_val:
name_val = type_val
if ref_val and not name_val:
name_val = ref_val
if ref_val and not type_val:
type_val = ref_val
if name_val:
self.attrs['name'] = name_val
if type_val:
self.attrs['type'] = type_val
if ref_val:
self.attrs['ref'] = ref_val
# fix_abstract
abstract_type = attrs.get('abstract', 'false').lower()
self.abstract_type = abstract_type in ('1', 'true')
self.default = self.attrs.get('default')
self.name = name_val
self.children = []
self.optional = False
self.minOccurs = 1
self.maxOccurs = 1
self.complex = 0
self.complexType = 0
self.type = 'NoneType'
self.mixed = 0
self.base = None
self.mixedExtensionError = 0
self.collapseWhiteSpace = 0
# Attribute definitions for the currect element.
self.attributeDefs = {}
# Attribute definitions for the current attributeGroup, if there is one.
self.attributeGroup = None
# List of names of attributes for this element.
# We will add the attribute defintions in each of these groups
# to this element in annotate().
self.attributeGroupNameList = []
# similar things as above, for groups of elements
self.elementGroup = None
self.topLevel = 0
# Does this element contain an anyAttribute?
self.anyAttribute = 0
self.explicit_define = 0
self.simpleType = None
# Enumeration values for the current element.
self.values = list()
# The parent choice for the current element.
self.choice = None
self.listType = 0
self.simpleBase = []
self.documentation = ''
self.restrictionBase = None
self.simpleContent = False
def addChild(self, element):
self.children.append(element)
def getChildren(self): return self.children
def getName(self): return self.name
def getCleanName(self): return self.cleanName
def getUnmappedCleanName(self): return self.unmappedCleanName
def setName(self, name): self.name = name
def getAttrs(self): return self.attrs
def setAttrs(self, attrs): self.attrs = attrs
def getMinOccurs(self): return self.minOccurs
def getMaxOccurs(self): return self.maxOccurs
def getOptional(self): return self.optional
def getRawType(self): return self.type
def setExplicitDefine(self, explicit_define):
self.explicit_define = explicit_define
def isExplicitDefine(self): return self.explicit_define
def isAbstract(self): return self.abstract_type
def setListType(self, listType): self.listType = listType
def isListType(self): return self.listType
def getType(self):
returnType = self.type
if ElementDict.has_key(self.type):
typeObj = ElementDict[self.type]
typeObjType = typeObj.getRawType()
if is_builtin_simple_type(typeObjType):
returnType = typeObjType
return returnType
def isComplex(self): return self.complex
def addAttributeDefs(self, attrs): self.attributeDefs.append(attrs)
def getAttributeDefs(self): return self.attributeDefs
def isMixed(self): return self.mixed
def setMixed(self, mixed): self.mixed = mixed
def setBase(self, base): self.base = base
def getBase(self): return self.base
def getMixedExtensionError(self): return self.mixedExtensionError
def getAttributeGroups(self): return self.attributeGroups
def addAttribute(self, name, attribute):
self.attributeGroups[name] = attribute
def setAttributeGroup(self, attributeGroup): self.attributeGroup = attributeGroup
def getAttributeGroup(self): return self.attributeGroup
def setElementGroup(self, elementGroup): self.elementGroup = elementGroup
def getElementGroup(self): return self.elementGroup
def setTopLevel(self, topLevel): self.topLevel = topLevel
def getTopLevel(self): return self.topLevel
def setAnyAttribute(self, anyAttribute): self.anyAttribute = anyAttribute
def getAnyAttribute(self): return self.anyAttribute
def setSimpleType(self, simpleType): self.simpleType = simpleType
def getSimpleType(self): return self.simpleType
def setDefault(self, default): self.default = default
def getDefault(self): return self.default
def getSimpleBase(self): return self.simpleBase
def setSimpleBase(self, simpleBase): self.simpleBase = simpleBase
def addSimpleBase(self, simpleBase): self.simpleBase.append(simpleBase)
def getRestrictionBase(self): return self.restrictionBase
def setRestrictionBase(self, base): self.restrictionBase = base
def getRestrictionBaseObj(self):
rBaseObj = None
rBaseName = self.getRestrictionBase()
if rBaseName and rBaseName in ElementDict:
rBaseObj = ElementDict[rBaseName]
return rBaseObj
def setSimpleContent(self, simpleContent):
self.simpleContent = simpleContent
def getSimpleContent(self):
return self.simpleContent
def show(self, outfile, level):
if self.name == 'Reference':
showLevel(outfile, level)
outfile.write('Name: %s Type: %s id: %d\n' % (self.name,
self.getType(), id(self),))
showLevel(outfile, level)
outfile.write(' - Complex: %d MaxOccurs: %d MinOccurs: %d\n' % \
(self.complex, self.maxOccurs, self.minOccurs))
showLevel(outfile, level)
outfile.write(' - Attrs: %s\n' % self.attrs)
showLevel(outfile, level)
#outfile.write(' - AttributeDefs: %s\n' % self.attributeDefs)
outfile.write(' - AttributeDefs:\n')
for key, value in self.getAttributeDefs().items():
showLevel(outfile, level + 1)
outfile.write('- key: %s value: %s\n' % (key, value, ))
for child in self.children:
child.show(outfile, level + 1)
def annotate(self):
# resolve group references within groups
for grp in ElementGroups.values():
expandGroupReferences(grp)
# Recursively expand group references
visited = set()
self.expandGroupReferences_tree(visited)
self.collect_element_dict()
self.annotate_find_type()
self.annotate_tree()
self.fix_dup_names()
self.coerce_attr_types()
self.checkMixedBases()
def expandGroupReferences_tree(self, visited):
if self.getName() in visited:
return
visited.add(self.getName())
expandGroupReferences(self)
for child in self.children:
child.expandGroupReferences_tree(visited)
def collect_element_dict(self):
base = self.getBase()
if self.getTopLevel() or len(self.getChildren()) > 0 or \
len(self.getAttributeDefs()) > 0 or base:
ElementDict[self.name] = self
for child in self.children:
child.collect_element_dict()
def build_element_dict(self, elements):
base = self.getBase()
if self.getTopLevel() or len(self.getChildren()) > 0 or \
len(self.getAttributeDefs()) > 0 or base:
if self.name not in elements:
elements[self.name] = self
for child in self.children:
child.build_element_dict(elements)
def get_element(self, element_name):
if self.element_dict is None:
self.element_dict = dict()
self.build_element_dict(self.element_dict)
return self.element_dict.get(element_name)
# If it is a mixed-content element and it is defined as
# an extension, then all of its bases (base, base of base, ...)
# must be mixed-content. Mark it as an error, if not.
def checkMixedBases(self):
self.rationalizeMixedBases()
self.collectSimpleBases()
self.checkMixedBasesChain(self, self.mixed)
for child in self.children:
child.checkMixedBases()
def collectSimpleBases(self):
if self.base:
self.addSimpleBase(self.base.encode('utf-8'))
if self.simpleBase:
base1 = SimpleTypeDict.get(self.simpleBase[0])
if base1:
base2 = base1.base or None
else:
base2 = None
while base2:
self.addSimpleBase(base2.encode('utf-8'))
base2 = SimpleTypeDict.get(base2)
if base2:
base2 = base2.getBase()
def rationalizeMixedBases(self):
mixed = self.hasMixedInChain()
if mixed:
self.equalizeMixedBases()
def hasMixedInChain(self):
if self.isMixed():
return True
base = self.getBase()
if base and base in ElementDict:
parent = ElementDict[base]
return parent.hasMixedInChain()
else:
return False
def equalizeMixedBases(self):
if not self.isMixed():
self.setMixed(True)
base = self.getBase()
if base and base in ElementDict:
parent = ElementDict[base]
parent.equalizeMixedBases()
def checkMixedBasesChain(self, child, childMixed):
base = self.getBase()
if base and base in ElementDict:
parent = ElementDict[base]
if childMixed != parent.isMixed():
self.mixedExtensionError = 1
return
parent.checkMixedBasesChain(child, childMixed)
def resolve_type(self):
self.complex = 0
# If it has any attributes, then it's complex.
attrDefs = self.getAttributeDefs()
if len(attrDefs) > 0:
self.complex = 1
# type_val = ''
type_val = self.resolve_type_1()
if type_val in SimpleTypeDict:
self.addSimpleBase(type_val.encode('utf-8'))
simple_type = SimpleTypeDict[type_val]
list_type = simple_type.resolve_list_type()
self.setListType(list_type)
if type_val:
if type_val in ElementDict:
type_val1 = type_val
# The following loop handles the case where an Element's
# reference element has no sub-elements and whose type is
# another simpleType (potentially of the same name). Its
# fundamental function is to avoid the incorrect
# categorization of "complex" to Elements which are not and
# correctly resolve the Element's type as well as its
# potential values. It also handles cases where the Element's
# "simpleType" is so-called "top level" and is only available
# through the global SimpleTypeDict.
i = 0
while True:
element = ElementDict[type_val1]
# Resolve our potential values if present
self.values = element.values
# If the type is available in the SimpleTypeDict, we
# know we've gone far enough in the Element hierarchy
# and can return the correct base type.
t = element.resolve_type_1()
if t in SimpleTypeDict:
type_val1 = SimpleTypeDict[t].getBase()
break
# If the type name is the same as the previous type name
# then we know we've fully resolved the Element hierarchy
# and the Element is well and truely "complex". There is
# also a need to handle cases where the Element name and
# its type name are the same (ie. this is our first time
# through the loop). For example:
# <xsd:element name="ReallyCool" type="ReallyCool"/>
# <xsd:simpleType name="ReallyCool">
# <xsd:restriction base="xsd:string">
# <xsd:enumeration value="MyThing"/>
# </xsd:restriction>
# </xsd:simpleType>
if t == type_val1 and i != 0:
break
if t not in ElementDict:
type_val1 = t
break
type_val1 = t
i += 1
if is_builtin_simple_type(type_val1):
type_val = type_val1
else:
self.complex = 1
elif type_val in SimpleTypeDict:
count = 0
type_val1 = type_val
while True:
element = SimpleTypeDict[type_val1]
type_val1 = element.getBase()
if type_val1 is None:
# Something seems wrong. Can't find base simple type.
# Give up and use default.
type_val = StringType[0]
break
if type_val1 in SimpleTypeDict:
count += 1
if count > 10:
# Give up. We're in a loop. Use default.
type_val = StringType[0]
break
else:
type_val = type_val1
break
else:
if is_builtin_simple_type(type_val):
pass
else:
type_val = StringType[0]
else:
type_val = StringType[0]
return type_val
def resolve_type_1(self):
type_val = ''
if 'type' in self.attrs:
type_val = self.attrs['type']
if type_val in SimpleTypeDict:
self.simpleType = type_val
elif 'ref' in self.attrs:
type_val = strip_namespace(self.attrs['ref'])
elif 'name' in self.attrs:
type_val = strip_namespace(self.attrs['name'])
#type_val = self.attrs['name']
return type_val
def annotate_find_type(self):
type_val = self.resolve_type()
self.attrs['type'] = type_val
self.type = type_val
if not self.complex:
SimpleElementDict[self.name] = self
for child in self.children:
child.annotate_find_type()
def annotate_tree(self):
# If there is a namespace, replace it with an underscore.
if self.base:
self.base = strip_namespace(self.base)
self.unmappedCleanName = cleanupName(self.name)
self.cleanName = mapName(self.unmappedCleanName)
self.replace_attributeGroup_names()
# Resolve "maxOccurs" attribute
if 'maxOccurs' in self.attrs.keys():
maxOccurs = self.attrs['maxOccurs']
elif self.choice and 'maxOccurs' in self.choice.attrs.keys():
maxOccurs = self.choice.attrs['maxOccurs']
else:
maxOccurs = 1
# Resolve "minOccurs" attribute
if 'minOccurs' in self.attrs.keys():
minOccurs = self.attrs['minOccurs']
elif self.choice and 'minOccurs' in self.choice.attrs.keys():
minOccurs = self.choice.attrs['minOccurs']
else:
minOccurs = 1
# Cleanup "minOccurs" and "maxOccurs" attributes
try:
minOccurs = int(minOccurs)
if minOccurs == 0:
self.optional = True
except ValueError:
err_msg('*** %s minOccurs must be integer.\n' % self.getName())
sys.exit(1)
try:
if maxOccurs == 'unbounded':
maxOccurs = 99999
else:
maxOccurs = int(maxOccurs)
except ValueError:
err_msg('*** %s maxOccurs must be integer or "unbounded".\n' % (
self.getName(), ))
sys.exit(1)
self.minOccurs = minOccurs
self.maxOccurs = maxOccurs
# If it does not have a type, then make the type the same as the name.
if self.type == 'NoneType' and self.name:
self.type = self.name
# Is it a mixed-content element definition?
if 'mixed' in self.attrs.keys():
mixed = self.attrs['mixed'].strip()
if mixed == '1' or mixed.lower() == 'true':
self.mixed = 1
# If this element has a base and the base is a simple type and
# the simple type is collapseWhiteSpace, then mark this
# element as collapseWhiteSpace.
base = self.getBase()
if base and base in SimpleTypeDict:
parent = SimpleTypeDict[base]
if isinstance(parent, SimpleTypeElement) and \
parent.collapseWhiteSpace:
self.collapseWhiteSpace = 1
# Do it recursively for all descendents.
for child in self.children:
child.annotate_tree()
#
# For each name in the attributeGroupNameList for this element,
# add the attributes defined for that name in the global
# attributeGroup dictionary.
def replace_attributeGroup_names(self):
for groupName in self.attributeGroupNameList:
key = None
if AttributeGroups.has_key(groupName):
key =groupName
else:
# Looking for name space prefix
keyList = groupName.split(':')
if len(keyList) > 1:
key1 = keyList[1]
if AttributeGroups.has_key(key1):
key = key1
if key is not None:
attrGroup = AttributeGroups[key]
for name in attrGroup.getKeys():
attr = attrGroup.get(name)
self.attributeDefs[name] = attr
else:
err_msg('*** Error. attributeGroup %s not defined.\n' % (
groupName, ))
def __str__(self):
s1 = '<XschemaElement name: "%s" type: "%s">' % \
(self.getName(), self.getType(), )
return s1
__repr__ = __str__
def fix_dup_names(self):
# Patch-up names that are used for both a child element and an attribute.
#
attrDefs = self.getAttributeDefs()
# Collect a list of child element names.
# Must do this for base (extension) elements also.
elementNames = []
self.collectElementNames(elementNames, 0)
replaced = []
# Create the needed new attributes.
keys = attrDefs.keys()
for key in keys:
attr = attrDefs[key]
name = attr.getName()
if name in elementNames:
newName = name + '_attr'
newAttr = XschemaAttribute(newName)
attrDefs[newName] = newAttr
replaced.append(name)
# Remove the old (replaced) attributes.
for name in replaced:
del attrDefs[name]
for child in self.children:
child.fix_dup_names()
def collectElementNames(self, elementNames, count):
for child in self.children:
elementNames.append(cleanupName(child.cleanName))
base = self.getBase()
if base and base in ElementDict:
parent = ElementDict[base]
count += 1
if count > 100:
msg = ('Extension/restriction recursion detected. ' +
'Suggest you check definitions of types ' +
'%s and %s.'
)
msg = msg % (self.getName(), parent.getName(), )
raise RuntimeError(msg)
parent.collectElementNames(elementNames, count)
def coerce_attr_types(self):
replacements = []
attrDefs = self.getAttributeDefs()
for idx, name in enumerate(attrDefs):
attr = attrDefs[name]
attrType = attr.getData_type()
if attrType == IDType or \
attrType == IDREFType or \
attrType == IDREFSType:
attr.setData_type(StringType[0])
for child in self.children:
child.coerce_attr_types()
# end class XschemaElement
class XschemaAttributeGroup:
def __init__(self, name='', group=None):
self.name = name
if group:
self.group = group
else:
self.group = {}
def setName(self, name): self.name = name
def getName(self): return self.name
def setGroup(self, group): self.group = group
def getGroup(self): return self.group
def get(self, name, default=None):
if self.group.has_key(name):
return self.group[name]
else:
return default
def getKeys(self):
return self.group.keys()
def add(self, name, attr):
self.group[name] = attr
def delete(self, name):
if has_key(self.group, name):
del self.group[name]
return 1
else:
return 0
# end class XschemaAttributeGroup
class XschemaGroup:
def __init__(self, ref):
self.ref = ref
# end class XschemaGroup
class XschemaAttribute:
def __init__(self, name, data_type='xs:string', use='optional', default=None):
self.name = name
self.data_type = data_type
self.use = use
self.default = default
# Enumeration values for the attribute.
self.values = list()
def setName(self, name): self.name = name
def getName(self): return self.name
def setData_type(self, data_type): self.data_type = data_type
def getData_type(self): return self.data_type
def getType(self):
returnType = self.data_type
if SimpleElementDict.has_key(self.data_type):
typeObj = SimpleElementDict[self.data_type]
typeObjType = typeObj.getRawType()
if typeObjType in StringType or \
typeObjType == TokenType or \
typeObjType == DateTimeType or \
typeObjType == DateType or \
typeObjType in IntegerType or \
typeObjType == DecimalType or \
typeObjType == PositiveIntegerType or \
typeObjType == NegativeIntegerType or \
typeObjType == NonPositiveIntegerType or \
typeObjType == NonNegativeIntegerType or \
typeObjType == BooleanType or \
typeObjType == FloatType or \
typeObjType == DoubleType:
returnType = typeObjType
return returnType
def setUse(self, use): self.use = use
def getUse(self): return self.use
def setDefault(self, default): self.default = default
def getDefault(self): return self.default
# end class XschemaAttribute
#
# SAX handler
#
class XschemaHandler(handler.ContentHandler):
def __init__(self):
handler.ContentHandler.__init__(self)