-
Notifications
You must be signed in to change notification settings - Fork 1
/
GRASSDescribtionParser.py
585 lines (514 loc) · 27.2 KB
/
GRASSDescribtionParser.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
from __future__ import print_function
import xml.etree.ElementTree
import os
import subprocess
import tempfile
import binascii
import sys
reload(sys)
sys.setdefaultencoding('utf8')
# os.environ['LC_ALL'] = 'C'
def findGRASS():
"""Find GRASS.
Find location of GRASS.
:todo: Avoid bat file calling.
"""
########### SOFTWARE
if sys.platform == 'win32':
# qgis_prefix_path = os.environ['QGIS_PREFIX_PATH'] # not working in OSGeo installation
# bin_path = os.path.join(os.path.split(
# os.path.split(qgis_prefix_path)[0])[0],
# 'bin'
# )
# grass7bin = None
# for grass_version in ['74', '72', '70']:
# gpath = os.path.join(bin_path, 'grass{}.bat'.format(grass_version))
# if os.path.exists(gpath):
# grass7bin = gpath
# break
grass7bin = r'C:\OSGeo4W\bin\grass74.bat'
if grass7bin is None:
raise ImportError("No grass74.bat, grass72.bat or grass70.bat found.")
si = subprocess.STARTUPINFO()
si.dwFlags |= subprocess.STARTF_USESHOWWINDOW
si.wShowWindow = subprocess.SW_HIDE
else:
grass7bin = '/usr/bin/grass'
startcmd = [grass7bin, '--config', 'path']
try:
p = subprocess.Popen(startcmd, shell=False,
stdout=subprocess.PIPE, stderr=subprocess.PIPE)
out, err = p.communicate()
except OSError as error:
sys.exit("ERROR: Cannot find GRASS GIS start script"
" {cmd}: {error}".format(cmd=startcmd[0], error=error))
if p.returncode != 0:
sys.exit("ERROR: Issues running GRASS GIS start script"
" {cmd}: {error}"
.format(cmd=' '.join(startcmd), error=err))
# p = subprocess.Popen(startcmd,
# stdout=subprocess.PIPE, stderr=subprocess.PIPE)
# out, err = p.communicate()
#
# if p.returncode != 0:
# raise ImportError("Reason: ({cmd}: {reason})".format(
# cmd=startcmd, reason=err)
# )
str_out = out.decode("utf-8")
gisbase = str_out.rstrip(os.linesep)
# Set GISBASE environment variable
os.environ['GISBASE'] = gisbase
# set language to english
os.environ['LC_ALL'] = 'C'
# define GRASS-Python environment
sys.path.append(os.path.join(gisbase, "etc", "python"))
return grass7bin
try:
grass7bin = findGRASS()
except (StandardError, ImportError) as e:
raise ImportError('Unable to find GRASS installation. {}'.format(e))
temp_dir = None
import grass.script as gscript
from grass.script import setup as gsetup
from grass.exceptions import ScriptError
# def set_location():
# """Set GRASS gisbase, location and mapset.
# """
gisdb = os.path.join(tempfile.gettempdir(), 'grassdata')
if not os.path.isdir(gisdb):
os.mkdir(gisdb)
# location/mapset: use random names for batch jobs
string_length = 16
location = binascii.hexlify(os.urandom(string_length))
mapset = 'PERMANENT'
# GRASS session must be initialized first
gsetup.init(os.environ['GISBASE'], gisdb, location, mapset)
print(gisdb + location + mapset) # for debug
# Create temporal location
try:
gscript.create_location(gisdb, location, overwrite=True)
except ScriptError as e:
raise StandardError('{}'.format(e))
# def main():
# set_location()
# find_moduls()
# info = gtask.command_info('v.surf.rst')
#
#
# if __name__ == "__main__":
# main()
def print_name_desc(modul, output):
if child.tag == 'flag':
print('-' + modul.attrib['name'].strip() + '|', end='', file=output)
elif child.tag == 'parameter':
print(modul.attrib['name'].strip() + '|', end='', file=output)
else:
pass
if modul.find("label") is not None:
print(modul.find("label").text.strip() + '|', end='', file=output)
elif modul.find("description") is not None:
print(modul.find("description").text.strip() + '|', end='', file=output)
else:
pass
def check_default(parameter):
for par in parameter:
if par.tag == 'default':
return True
def print_default(parameter, output):
if check_default(parameter):
for par in parameter:
if par.tag == 'default':
print(par.text.strip() + '|', end='', file=output)
else:
print('None|', end='', file=output)
def optional(parameter, output):
if parameter.attrib['required'] == 'yes':
print('', end='', file=output)
else:
print('*', end='', file=output)
def print_optional(parameter, output):
if parameter.attrib['required'] == 'yes':
print('False', end='', file=output)
else:
print('True', end='', file=output)
def print_name_def(parameter, output):
print_name_desc(parameter, output)
print_default(parameter, output)
def print_def_opt(parameter, output):
print_default(parameter, output)
print_optional(parameter, output)
def print_name_def_opt(parameter, output):
print_name_desc(parameter, output)
print_default(parameter, output)
print_optional(parameter, output)
def check_tag(tag, branch):
elemList = []
for elem in branch:
elemList.append(elem.tag)
# now I remove duplicities - by convertion to set and back to list
elemList = list(set(elemList))
if tag in elemList:
return True
else:
return False
from grass.script import core as gcore
# def find_moduls():
# """Find GRASS moduls.
# """
cmds = list(gcore.get_commands()[0])
cmds.sort()
# file_names = [cmd.replace('.', '_') for cmd in cmds]
from grass.script import task as gtask
# try to call method get_interface_description, see Issue #7
if sys.platform == 'win32':
gtask.get_interface_description('v.db.update')
for cmd in cmds:
try:
# def parser():
root = xml.etree.ElementTree.fromstring(gtask.get_interface_description('{}'.format(cmd)))
# print(tree)
#
# root = tree.getroot()
name = root.attrib['name']
if name[:2] == 'd.':
continue
elif name[:3] == 'db.':
continue
elif name[:3] == 'r3.':
continue
elif name[:2] == 't.':
continue
elif name[:3] == 'ps.':
continue
elif name[:2] == 'g.':
continue
elif name[:5] == 'test.':
continue
elif cmd == 'g.parser':
continue
# create directories 'xml' and 'desc'
xml_dir = r'xml'
if not os.path.exists(xml_dir):
os.makedirs(xml_dir)
desc_dir = r'desc'
if not os.path.exists(desc_dir):
os.makedirs(desc_dir)
desc_file = open('desc/{}.txt'.format(cmd), 'w+')
xml_file = open('xml/{}.txt'.format(cmd), 'w+')
# print(gtask.get_interface_description('v.surf.rst'), file=xml_file)
print(gtask.get_interface_description('{}'.format(cmd)), file=xml_file)
print(name, file=desc_file)
print(name)
for child in root:
if child.tag == 'label':
label = child.text.strip()
label = label.replace('-', '')
print(label, end=' ', file=desc_file)
elif child.tag == 'description':
desc = child.text.strip()
desc = desc.replace('-', '')
print(desc, end=' ', file=desc_file)
if child.tag == 'keywords':
keywords = child.text.strip()
print('- ' + keywords, end=' ', file=desc_file)
print('', file=desc_file)
if name[:2] == 'r.':
print('Raster (r.*)', file=desc_file)
elif name[:2] == 'i.':
print('Imagery (i.*)', file=desc_file)
elif name[:2] == 'v.':
print('Vector (v.*)', file=desc_file)
elif name[:2] == 'm.':
print('Miscellaneous (m.*)', file=desc_file)
# elif name[:2] == 'd.':
# print('Display (d.*)', file=desc_file)
# elif name[:3] == 'db.':
# print('Database (db.*)', file=desc_file)
# elif name[:3] == 'r3.':
# print('Raster3D (r3.*)', file=desc_file)
# elif name[:2] == 't.':
# print('Temporal (t.*)', file=desc_file)
# elif name[:3] == 'ps.':
# print('Postscript (ps.*)', file=desc_file)
# elif name[:2] == 'g.':
# print('General (g.*)', file=desc_file)
else:
print('Not in plugin - ' + name)
for child in root:
if child.tag == 'parameter':
if check_tag('gisprompt', child):
for k in child:
if k.tag == 'gisprompt':
if 'prompt' in k.attrib:
if k.attrib['prompt'] == 'raster_3d':
if child.attrib['required'] == 'yes':
print('Need of 3D raster for module >>> ' + name)
os.remove('desc/{}.txt'.format(cmd))
else:
pass
if child.attrib['type'] == 'integer':
if check_default(child):
for k in child:
if k.tag == 'default':
if ',' in k.text.strip():
optional(child, desc_file)
print('QgsProcessingParameterRange|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('QgsProcessingParameterNumber.Integer|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
else:
optional(child, desc_file)
print('QgsProcessingParameterNumber|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('QgsProcessingParameterNumber.Integer|', end='', file=desc_file)
print_def_opt(child, desc_file)
if k.tag == 'values':
for value in k:
if value.tag == 'value':
for name in value:
if name.tag == 'name':
limits = name.text.strip()
print_limits = limits.replace('-', '|')
print('|' + print_limits, end='', file=desc_file)
print('', file=desc_file)
else:
optional(child, desc_file)
print('QgsProcessingParameterNumber|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('QgsProcessingParameterNumber.Integer|', end='', file=desc_file)
print_def_opt(child, desc_file)
if k.tag == 'values':
for value in k:
if value.tag == 'value':
for name in value:
if name.tag == 'name':
limits = name.text.strip()
print_limits = limits.replace('-', '|')
print('|' + print_limits, end='', file=desc_file)
print('', file=desc_file)
elif child.attrib['type'] == 'float':
optional(child, desc_file)
print('QgsProcessingParameterNumber|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('QgsProcessingParameterNumber.Double|', end='', file=desc_file)
print_def_opt(child, desc_file)
for k in child:
if k.tag == 'values':
for value in k:
if value.tag == 'value':
for name in value:
if name.tag == 'name':
limits = name.text.strip()
print_limits = limits.replace('-', '|')
print('|' + print_limits, end='', file=desc_file)
print('', file=desc_file)
# else:
# print('Not recognized >>> ', end='')
# print(child.attrib['name'].strip())
elif check_tag('values', child):
optional(child, desc_file)
print('QgsProcessingParameterEnum|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('not selected', end='', file=desc_file)
for k in child:
if k.tag == 'values':
for value in k:
for name in value:
if name.tag == 'name':
print(';' + name.text.strip(), end='', file=desc_file)
if child.attrib['multiple'] == 'yes':
print('|True|', end='', file=desc_file)
else:
print('|False|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
elif child.attrib['multiple'] == 'yes':
if check_tag('gisprompt', child):
for k in child:
if k.tag == 'gisprompt':
# if k.tag == 'gisprompt':
if k.attrib['prompt'] == 'dbcolumn':
optional(child, desc_file)
print('QgsProcessingParameterField|', end='', file=desc_file)
print_name_def_opt(child, desc_file)
print('', file=desc_file)
else:
optional(child, desc_file)
print('QgsProcessingParameterMultipleLayers|', end='', file=desc_file)
print_name_desc(child, desc_file)
if k.attrib['prompt'] == 'raster':
print('3|', end='', file=desc_file)
print_def_opt(child, desc_file)
elif k.attrib['prompt'] == 'vector':
print('2|', end='', file=desc_file)
print_def_opt(child, desc_file)
else:
print('33|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
else:
optional(child, desc_file)
print('QgsProcessingParameterString|', end='', file=desc_file)
print_name_def(child, desc_file)
print('True|', end='', file=desc_file)
print_optional(child, desc_file)
print('', file=desc_file)
# else:
# print('Input layers|TypeMapLayer|', end='', file=desc_file)
# print_def_opt(child, desc_file)
elif child.attrib['multiple'] == 'no':
if child.attrib['type'] == 'string':
if check_tag('gisprompt', child):
for k in child:
if k.tag == 'gisprompt':
if k.attrib['age'] == 'old':
if k.attrib['prompt'] == 'raster':
optional(child, desc_file)
print('QgsProcessingParameterRasterLayer|', end='', file=desc_file)
print_name_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'vector':
optional(child, desc_file)
print('QgsProcessingParameterVectorLayer|', end='', file=desc_file)
print_name_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'dbcolumn':
optional(child, desc_file)
print('QgsProcessingParameterField|', end='', file=desc_file)
print_name_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'file' or k.attrib['prompt'] == 'sigfile' \
or child.attrib['name'] == 'signature':
optional(child, desc_file)
print('QgsProcessingParameterFile|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('QgsProcessingParameterFile.File|txt|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'datasource':
optional(child, desc_file)
print('QgsProcessingParameterFolder|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('QgsProcessingParameterFile.Folder|None|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'group' and child.attrib['name'] != 'subgroup':
if name == 'i.group':
optional(child, desc_file)
print('QgsProcessingParameterRasterDestination|group|Multiband raster', file=desc_file)
else:
optional(child, desc_file)
print('QgsProcessingParameterMultipleLayers|input|', end='', file=desc_file)
if name[:2] == 'r.':
print('Input rasters|3|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
elif name[:2] == 'v.':
print('Input vectors|2|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
else:
print('Input layers|3|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'separator' or k.attrib['prompt'] == 'color' \
or k.attrib['prompt'] == 'cats' or k.attrib['prompt'] == 'dbname' \
or k.attrib['prompt'] == 'dbtable':
optional(child, desc_file)
print('QgsProcessingParameterString|', end='', file=desc_file)
print_name_def(child, desc_file)
print('False|', end='', file=desc_file)
print_optional(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'layer':
pass
elif k.attrib['prompt'] == 'subgroup' or child.attrib['name'] == 'subgroup':
pass
else:
print('Not recognized >>> ', end='')
print(child.attrib['name'].strip())
print('', file=desc_file)
elif k.attrib['age'] == 'new':
if k.attrib['prompt'] == 'raster':
optional(child, desc_file)
print('QgsProcessingParameterRasterDestination|', end='', file=desc_file)
print_name_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'vector':
optional(child, desc_file)
print('QgsProcessingParameterVectorDestination|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('TypeVector|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'file' or k.attrib['prompt'] == 'sigfile':
optional(child, desc_file)
print('QgsProcessingParameterFileDestination|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('Txt files(*.txt)|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
elif k.attrib['prompt'] == 'layer':
pass
elif child.attrib['name'] == 'signature':
optional(child, desc_file)
print('QgsProcessingParameterFile|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('QgsProcessingParameterFile.File|txt|', end='', file=desc_file)
print_def_opt(child, desc_file)
print('', file=desc_file)
else:
# print('Not recognized >>> ', end='')
# print(child.attrib['name'].strip())
optional(child, desc_file)
print('QgsProcessingParameterString|', end='', file=desc_file)
print_name_def(child, desc_file)
print('True|', end='', file=desc_file)
print_optional(child, desc_file)
print('', file=desc_file)
# promt = child.find('gisprompt')
# if promt is None or promt == 'cats':
# print('QgsProcessingParameterString|', end='', file=desc_file)
# print_name_def(child, desc_file)
# print('True|', end='', file=desc_file)
# print_optional(child, desc_file)
# # else:
# print('Not recognized >>> ', end='')
# print(child.attrib['name'].strip())
# elif child.find('gisprompt') is None:
# if child.attrib['type'] == 'string':
# # promt = child.find('gisprompt')
# # if promt is None or promt == 'cats':
# print('QgsProcessingParameterString|', end='', file=desc_file)
# print_name_def(child, desc_file)
# print('True|', end='', file=desc_file)
# print_optional(child, desc_file)
# # else:
# # print('Not recognized >>> ', end='')
# # print(child.attrib['name'].strip())
#
# elif child.attrib['type'] == 'integer':
# print('QgsProcessingParameterNumber|', end='', file=desc_file)
# print_name_desc(child, desc_file)
# print('QgsProcessingParameterNumber.Integer|', end='', file=desc_file)
# print_def_opt(child, desc_file)
#
# elif child.attrib['type'] == 'float':
# print('QgsProcessingParameterNumber|', end='', file=desc_file)
# print_name_desc(child, desc_file)
# print('QgsProcessingParameterNumber.Double|', end='', file=desc_file)
# print_def_opt(child, desc_file)
# else:
# print('Not recognized >>> ', end='')
# print(child.attrib['name'].strip())
elif child.tag == 'flag':
# optional(child, desc_file)
print('*QgsProcessingParameterBoolean|', end='', file=desc_file)
print_name_desc(child, desc_file)
print('False|True', file=desc_file)
if cmd == 'r.colors':
print('QgsProcessingParameterFolderDestination|output_dir|Output Directory|None|False', file=desc_file)
except Exception, e:
print('{} - unable to create description, because: '.format(cmd) + str(e))
# print(gtask.get_interface_description('d.barscale'))