-
Notifications
You must be signed in to change notification settings - Fork 2
/
SDTTool.py
247 lines (203 loc) · 9.08 KB
/
SDTTool.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
# SDTTool.py
#
# Main module for the SDTTool
from xml.etree.ElementTree import XMLParser, ParseError
from sdtv2 import *
from sdtv3 import *
from sdtv4 import *
from SDTPrinter import *
import io, sys, traceback, argparse, textwrap
version = '0.9'
description = 'SDTTool ' + version + ' - A tool to read and convert Smart Device Templates.'
epilog = 'Read arguments from one or more configuration files: @file1 @file2 ...|n |n See https://github.com/Homegateway for further information.'
#
# Helper method for loading arguments from file
#
def convertArgLineToArgs(arg_line):
for arg in arg_line.split():
if not arg.strip():
continue
yield arg
class MultilineFormatter(argparse.HelpFormatter):
def _fill_text(self, text, width, indent):
text = self._whitespace_matcher.sub(' ', text).strip()
paragraphs = text.split('|n ')
multiline_text = ''
for paragraph in paragraphs:
formatted_paragraph = textwrap.fill(paragraph, width, initial_indent=indent, subsequent_indent=indent) + '\n'
multiline_text = multiline_text + formatted_paragraph
return multiline_text
class LineNumberingParser(XMLParser):
def _start_list(self, *args, **kwargs):
# Here we assume the default XML parser which is expat
# and copy its element position attributes into output Elements
element = super(self.__class__, self)._start_list(*args, **kwargs)
element._start_line_number = self.parser.CurrentLineNumber
element._start_column_number = self.parser.CurrentColumnNumber
element._start_byte_index = self.parser.CurrentByteIndex
return element
def _end(self, *args, **kwargs):
element = super(self.__class__, self)._end(*args, **kwargs)
element._end_line_number = self.parser.CurrentLineNumber
element._end_column_number = self.parser.CurrentColumnNumber
element._end_byte_index = self.parser.CurrentByteIndex
return element
#
# Read data from the input file
#
def readDataFromFile(inFile):
# Read the input file
with open(inFile, 'r') as inputFile:
data = inputFile.read()
return data
#
# Parse the data with the given parser and handle errors
#
def parseData(target, data):
parser = XMLParser(target=target)
errormsg = ''
try:
try:
parser.feed(data)
except SyntaxError as err:
errormsg = str(err)
print(err)
except:
traceback.print_exc()
finally:
parser.close()
except ParseError as err:
formatted_e = errormsg
line = int(formatted_e[formatted_e.find("line ") + 5: formatted_e.find(",")])
column = int(formatted_e[formatted_e.find("column ") + 7:])
split_str = data.split("\n")
print("{}\n{}^".format(split_str[line - 1], len(split_str[line - 1][0:column])*"-"))
return target.domain, target.nameSpaces
#
# Read and parse an SDT2 XML
#
def readSDT2XML(inFile):
# open the file
data = readDataFromFile(inFile)
# Parse the data
return parseData(SDT2Parser(), data)
#
# Read and parse an SDT3 XML
#
def readSDT3XML(inFile):
# open the file
data = readDataFromFile(inFile)
# Parse the data
return parseData(SDT3Parser(), data)
#
# Read and parse an SDT4 XML
#
def readSDT4XML(inFile):
# open the file
data = readDataFromFile(inFile)
# Parse the data
return parseData(SDT4Parser(), data)
#
# Print the output to stdout or to a file
#
def outputResult(outFile, result):
if result == None:
return
if outFile == None:
print(result)
else:
try:
with open(outFile, 'w') as outputFile:
outputFile.write(result)
except IOError as err:
print(err)
#
# Check the available name spaces
#
def checkForNamespace(nameSpaces, checkNameSpace):
for ns in nameSpaces:
if (ns.find(checkNameSpace) > -1):
return True
return False
def main(argv):
outFile = None
# Read command line arguments
parser = argparse.ArgumentParser(description=description, epilog=epilog, fromfile_prefix_chars='@', formatter_class=MultilineFormatter)
parser.convert_arg_line_to_args = convertArgLineToArgs
parser.add_argument('-o', '--outfile', action='store', dest='outFile', help='The output file or directory for the result. The default is stdout')
parser.add_argument('-if', '--inputformat', choices=('sdt2', 'sdt3', 'sdt4'), action='store', dest='inputFormat', default='sdt4', help='The input format to read. The default is sdt4')
parser.add_argument('-of', '--outputformat', choices=('plain', 'opml', 'markdown', 'sdt3', 'sdt4', 'java', 'vorto-dsl', 'onem2m-svg', 'onem2m-xsd', 'swagger'), action='store', dest='outputFormat', default='markdown', help='The output format for the result. The default is markdown')
parser.add_argument('--hidedetails', action='store_true', help='Hide the details of module classes and devices when printing documentation')
parser.add_argument('--markdowntables', action='store_true', help='Format markdown output as tables for markdown')
parser.add_argument('--markdownpagebreak', action='store_true', help='Insert page breaks before ModuleClasse and Device definitions.')
parser.add_argument('-lf', '--licensefile', action='store', dest='licensefile', help='Add the text of license file to output files')
oneM2MArgs = parser.add_argument_group('oneM2M sepcific')
oneM2MArgs.add_argument('--domain', action='store', dest='domain', help='Set the domain for the model')
oneM2MArgs.add_argument('-ns', '--namespaceprefix', action='store', dest='namespaceprefix', help='Specify the name space prefix for the model')
oneM2MArgs.add_argument('--abbreviationsinfile', action='store', dest='abbreviationsinfile', help='Specify the file that contains a CSV table of alreadys existing abbreviations.')
oneM2MArgs.add_argument('--abbreviationlength', action='store', dest='abbreviationlength', default='5', help='Specify the maximum length for abbreviations. The default is 5.')
oneM2MArgs.add_argument('--xsdtargetnamespace', action='store', dest='xsdtargetnamespace', help='Specify the target namespace for the oneM2M XSD (a URI).')
oneM2MArgs.add_argument('-mv', '--modelversion', action='store', dest='modelversion', help='Specify the version of the model.')
oneM2MArgs.add_argument('--svg-with-attributes', action='store_true', dest='svgwithattributes', help='Generate SVG for ModuleClass attributes as well.')
requiredNamed = parser.add_argument_group('required arguments')
requiredNamed.add_argument('-i', '--infile', action='store', dest='inFile', required=True, help='The SDT input file to parse')
if len(sys.argv)==1:
parser.print_help()
sys.exit(1)
args = parser.parse_args()
inFile = args.inFile
outFile = args.outFile
inputFormat = args.inputFormat
moreOptions = {}
moreOptions['hideDetails'] = args.hidedetails
moreOptions['markdowntables'] = args.markdowntables
moreOptions['pageBreakBeforeMCandDevices'] = args.markdownpagebreak
moreOptions['markdownPageBreak'] = args.markdownpagebreak # renamed, therefore twice
moreOptions['licensefile'] = args.licensefile
moreOptions['domain'] = args.domain
moreOptions['namespaceprefix'] = args.namespaceprefix
moreOptions['abbreviationsinfile'] = args.abbreviationsinfile
moreOptions['abbreviationlength'] = args.abbreviationlength
moreOptions['xsdtargetnamespace'] = args.xsdtargetnamespace
moreOptions['modelversion'] = args.modelversion
moreOptions['outputFormat'] = args.outputFormat
moreOptions['svgwithattributes'] = args.svgwithattributes
# Read input file. Check for correct format
if inputFormat == 'sdt2':
domain, nameSpaces = readSDT2XML(inFile)
if not checkForNamespace(nameSpaces, 'http://homegatewayinitiative.org/xml/dal/2.0'):
print('ERROR: Namespace "http://homegatewayinitiative.org/xml/dal/2.0" not found in input file.')
return
elif inputFormat == 'sdt3':
domain, nameSpaces = readSDT3XML(inFile)
if not checkForNamespace(nameSpaces, 'http://homegatewayinitiative.org/xml/dal/3.0'):
print('ERROR: Namespace "http://homegatewayinitiative.org/xml/dal/3.0" not found in input file.')
return
elif inputFormat == 'sdt4':
domain, nameSpaces = readSDT4XML(inFile)
if not checkForNamespace(nameSpaces, 'http://www.onem2m.org/xml/sdt/4.0'):
print('ERROR: Namespace "http://www.onem2m.org/xml/sdt/4.0" not found in input file.')
return
# Output to destination format
if args.outputFormat == 'plain':
outputResult(outFile, printPlain(domain, moreOptions))
elif args.outputFormat == 'opml':
outputResult(outFile, printOPML(domain, moreOptions))
elif args.outputFormat == 'markdown':
outputResult(outFile, printMarkdown(domain, moreOptions))
elif args.outputFormat == 'sdt3':
outputResult(outFile, printSDT3(domain, inputFormat, moreOptions))
elif args.outputFormat == 'sdt4':
outputResult(outFile, printSDT4(domain, inputFormat, moreOptions))
elif args.outputFormat == 'java':
printJava(domain, inputFormat, outFile, moreOptions)
elif args.outputFormat == 'vorto-dsl':
printVortoDSL(domain, inputFormat, outFile, moreOptions)
elif args.outputFormat == 'onem2m-svg':
printOneM2MSVG(domain, inputFormat, outFile, moreOptions)
elif args.outputFormat == 'onem2m-xsd':
printOneM2MXSD(domain, inputFormat, outFile, moreOptions)
elif args.outputFormat == 'swagger':
printSwagger(domain, inputFormat, outFile, moreOptions)
if __name__ == "__main__":
main(sys.argv[1:])