Currently job artifacts in CI/CD pipelines on LRZ GitLab never expire. Starting from Wed 26.1.2022 the default expiration time will be 30 days (GitLab default). Currently existing artifacts in already completed jobs will not be affected by the change. The latest artifacts for all jobs in the latest successful pipelines will be kept. More information: https://gitlab.lrz.de/help/user/admin_area/settings/continuous_integration.html#default-artifacts-expiration

dhparser.py 12 KB
Newer Older
1
#!/usr/bin/python
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

"""dhparser.py - command line tool for DHParser

Copyright 2016  by Eckhart Arnold (arnold@badw.de)
                Bavarian Academy of Sciences an Humanities (badw.de)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied.  See the License for the specific language governing
permissions and limitations under the License.
"""

21
#  TODO: This is still a stub...
22

23
24
25
import os
import sys

26
from DHParser.compile import compile_source
eckhart's avatar
eckhart committed
27
from DHParser.dsl import compileDSL, compile_on_disk, recompile_grammar
Eckhart Arnold's avatar
Eckhart Arnold committed
28
from DHParser.ebnf import get_ebnf_grammar, get_ebnf_transformer, get_ebnf_compiler
29
from DHParser.log import logging
30
from DHParser.toolkit import re
31

32
LOGGING = False
33

eckhart's avatar
eckhart committed
34
35
dhparserdir = os.path.dirname(os.path.realpath(__file__))

36
EBNF_TEMPLATE = r"""-grammar
37

38
39
40
41
42
43
#######################################################################
#
#  EBNF-Directives
#
#######################################################################

44
@ whitespace  = vertical        # implicit whitespace, includes any number of line feeds
45
@ literalws   = right           # literals have implicit whitespace on the right hand side
Eckhart Arnold's avatar
Eckhart Arnold committed
46
@ comment     = /#.*/           # comments range from a '#'-character to the end of the line
47
48
49
50
51
52
53
54
55
@ ignorecase  = False           # literals and regular expressions are case-sensitive


#######################################################################
#
#  Structure and Components
#
#######################################################################

56
document = ~ { WORD } §EOF    # root parser: a sequence of words preceded by whitespace
57
58
59
60
61
62
63
64
                                # until the end of file

#######################################################################
#
#  Regular Expressions
#
#######################################################################

65
66
WORD     =  /\w+/~      # a sequence of letters, optional trailing whitespace
EOF      =  !/./        # no more characters ahead, end of file reached
67
68
"""

69
TEST_WORD_TEMPLATE = r'''[match:WORD]
70
71
M1: word
M2: one_word_with_underscores
72
73

[fail:WORD]
74
F1: two words
75
76
77
'''

TEST_DOCUMENT_TEMPLATE = r'''[match:document]
78
79
M1: """This is a sequence of words
    extending over several lines"""
80
M2: """  This sequence contains leading whitespace"""
81

82
[fail:document]
83
84
F1: """This test should fail, because neither
    comma nor full have been defined anywhere."""
85
'''
86
87
88
89
90
91
92
93
94
95

README_TEMPLATE = """# {name}

PLACE A SHORT DESCRIPTION HERE

Author: AUTHOR'S NAME <EMAIL>, AFFILIATION


## License

96
{name} is open source software under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0)
97
98
99

Copyright YEAR AUTHOR'S NAME <EMAIL>, AFFILIATION

100
101
102
103
104
105
106
107
108
109
110
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
111
112
113
"""


114
GRAMMAR_TEST_TEMPLATE = r'''#!/usr/bin/python3
115
116
117
118

"""tst_{name}_grammar.py - runs the unit tests for the {name}-grammar
"""

119
import os
120
121
import sys

di68kap's avatar
di68kap committed
122
123
LOGGING = False

124
sys.path.append(r'{dhparserdir}')
125

126
scriptpath = os.path.dirname(__file__)
127

eckhart's avatar
eckhart committed
128

129
130
131
132
133
134
135
try:
    from DHParser import dsl
    import DHParser.log
    from DHParser import testing
except ModuleNotFoundError:
    print('Could not import DHParser. Please adjust sys.path in file '
          '"%s" manually' % __file__)
136
    sys.exit(1)
137
138
139


def recompile_grammar(grammar_src, force):
di68kap's avatar
di68kap committed
140
    with DHParser.log.logging(LOGGING):
141
142
143
144
145
146
147
148
149
150
        # recompiles Grammar only if it has changed
        if not dsl.recompile_grammar(grammar_src, force=force):
            print('\nErrors while recompiling "%s":' % grammar_src +
                  '\n--------------------------------------\n\n')
            with open('{name}_ebnf_ERRORS.txt') as f:
                print(f.read())
            sys.exit(1)


def run_grammar_tests(glob_pattern):
di68kap's avatar
di68kap committed
151
    with DHParser.log.logging(LOGGING):
152
        error_report = testing.grammar_suite(
eckhart's avatar
eckhart committed
153
154
            os.path.join(scriptpath, 'grammar_tests'),
            get_grammar, get_transformer,
155
156
157
158
159
            fn_patterns=[glob_pattern], report=True, verbose=True)
    return error_report


if __name__ == '__main__':
di68kap's avatar
di68kap committed
160
161
162
163
164
165
    argv = sys.argv[:]
    if len(argv) > 1 and sys.argv[1] == "--debug":
        LOGGING = True
        del argv[1]
    if (len(argv) >= 2 and (argv[1].endswith('.ebnf') or
        os.path.splitext(argv[1])[1].lower() in testing.TEST_READERS.keys())):
di68kap's avatar
di68kap committed
166
167
        # if called with a single filename that is either an EBNF file or a known
        # test file type then use the given argument
di68kap's avatar
di68kap committed
168
        arg = argv[1]
di68kap's avatar
di68kap committed
169
170
171
    else: 
        # otherwise run all tests in the test directory
        arg = '*_test_*.ini'
172
173
174
    if arg.endswith('.ebnf'):
        recompile_grammar(arg, force=True)
    else:
eckhart's avatar
eckhart committed
175
        recompile_grammar(os.path.join(scriptpath, '{name}.ebnf'),
176
177
178
179
180
181
182
183
184
                          force=False)
        sys.path.append('.')
        from {name}Compiler import get_grammar, get_transformer
        error_report = run_grammar_tests(glob_pattern=arg)
        if error_report:
            print('\n')
            print(error_report)
            sys.exit(1)
        print('ready.\n')
185
'''
186
187


188
189
190
def create_project(path: str):
    """Creates the a new DHParser-project in the given `path`.
    """
191
    def create_file(name, content):
192
        """Create a file with `name` and write `content` to file."""
193
194
        if not os.path.exists(name):
            print('Creating file "%s".' % name)
195
            with open(name, 'w', encoding='utf-8') as f:
196
197
198
199
                f.write(content)
        else:
            print('"%s" already exists! Not overwritten.' % name)

200
    name = os.path.basename(path)
eckhart's avatar
eckhart committed
201
    if not re.match(r'(?!\d)\w+', name):
202
203
        print('Project name "%s" is not a valid identifier! Aborting.' % name)
        sys.exit(1)
204
    if os.path.exists(path) and not os.path.isdir(path):
205
        print('Cannot create new project, because a file named "%s" already exists!' % path)
206
        sys.exit(1)
207
208
209
210
    print('Creating new DHParser-project "%s".' % name)
    if not os.path.exists(path):
        os.mkdir(path)
    curr_dir = os.getcwd()
211
    os.chdir(path)
212
213
214
215
216
217
218
219
220
221
222
    if os.path.exists('grammar_tests'):
        if not os.path.isdir('grammar_tests'):
            print('Cannot overwrite existing file "grammar_tests"')
            sys.exit(1)
    else:
        os.mkdir('grammar_tests')

    create_file(os.path.join('grammar_tests', '01_test_word.ini'), TEST_WORD_TEMPLATE)
    create_file(os.path.join('grammar_tests', '02_test_document.ini'), TEST_DOCUMENT_TEMPLATE)
    create_file(name + '.ebnf', '# ' + name + EBNF_TEMPLATE)
    create_file('README.md', README_TEMPLATE.format(name=name))
eckhart's avatar
eckhart committed
223
224
    create_file('tst_%s_grammar.py' % name,
                GRAMMAR_TEST_TEMPLATE.format(name=name, dhparserdir=dhparserdir))
Eckhart Arnold's avatar
Eckhart Arnold committed
225
    create_file('example.dsl', 'Life is but a walking shadow\n')
226
    os.chmod('tst_%s_grammar.py' % name, 0o755)
eckhart's avatar
eckhart committed
227
228
229
230
231
    # The following is left to the user as an exercise
    # print('Creating file "%s".' % (name + 'Compiler.py'))
    # recompile_grammar(name + '.ebnf', force=True)
    print('\nNow generate a DSL compiler from the EBNF-grammar by running\n'
          '\n    python tst_%s_gramar.py\n' % name)
232
    os.chdir(curr_dir)
233

234

Eckhart Arnold's avatar
Eckhart Arnold committed
235
def selftest() -> bool:
236
237
    """Run a simple self-text of DHParser.
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
238
239
240
241
242
243
    print("DHParser selftest...")
    print("\nSTAGE I:  Trying to compile EBNF-Grammar:\n")
    builtin_ebnf_parser = get_ebnf_grammar()
    ebnf_src = builtin_ebnf_parser.__doc__[builtin_ebnf_parser.__doc__.find('#'):]
    ebnf_transformer = get_ebnf_transformer()
    ebnf_compiler = get_ebnf_compiler('EBNF')
244
245
    generated_ebnf_parser, errors, _ = compile_source(
        ebnf_src, None,
Eckhart Arnold's avatar
Eckhart Arnold committed
246
247
248
249
        builtin_ebnf_parser, ebnf_transformer, ebnf_compiler)

    if errors:
        print("Selftest FAILED :-(")
250
        print("\n\n".join(str(err) for err in errors))
Eckhart Arnold's avatar
Eckhart Arnold committed
251
252
        return False
    print(generated_ebnf_parser)
253
254
    print("\n\nSTAGE 2: Selfhosting-test: "
          "Trying to compile EBNF-Grammar with generated parser...\n")
Eckhart Arnold's avatar
Eckhart Arnold committed
255
256
257
258
259
260
261
    selfhosted_ebnf_parser = compileDSL(ebnf_src, None, generated_ebnf_parser,
                                        ebnf_transformer, ebnf_compiler)
    ebnf_compiler.gen_transformer_skeleton()
    print(selfhosted_ebnf_parser)
    return True


262
def cpu_profile(func, repetitions=1):
263
264
265
266
267
268
    """Profile the function `func`.
    """
    import cProfile
    import pstats
    profile = cProfile.Profile()
    profile.enable()
269
    success = True
270
    for _ in range(repetitions):
271
272
273
        success = func()
        if not success:
            break
274
    profile.disable()
275
    # after your program ends
276
277
278
    stats = pstats.Stats(profile)
    stats.strip_dirs()
    stats.sort_stats('time').print_stats(40)
279
    return success
280
281


282
283
284
def mem_profile(func):
    """Profile memory usage of `func`.
    """
285
286
287
288
289
290
291
292
293
294
295
    import tracemalloc
    tracemalloc.start()
    success = func()
    snapshot = tracemalloc.take_snapshot()
    top_stats = snapshot.statistics('lineno')
    print("[ Top 20 ]")
    for stat in top_stats[:20]:
        print(stat)
    return success


296
297
298
299
def main():
    """Creates a project (if a project name has been passed as command line
    parameter) or runs a quick self-test.
    """
300
    if len(sys.argv) > 1:
301
302
303
304
305
306
        if sys.argv[1].lower() == "--selftest":
            if not selftest():
                print("Selftest FAILED :-(\n")
                sys.exit(1)
            print("Selftest SUCCEEDED :-)\n")
        elif os.path.exists(sys.argv[1]) and os.path.isfile(sys.argv[1]):
307
308
309
            _errors = compile_on_disk(sys.argv[1],
                                      sys.argv[2] if len(sys.argv) > 2 else "")
            if _errors:
310
                print('\n\n'.join(str(err) for err in _errors))
311
312
313
                sys.exit(1)
        else:
            create_project(sys.argv[1])
314
    else:
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
        print('Usage: \n'
              '    dhparser.py DSL_FILENAME [COMPILER]  - to compile a file\n'
              '    dhparser.py PROJECTNAME  - to create a new project\n\n')
        choice = input('Would you now like to ...\n'
                       '  [1] create a new project\n'
                       '  [2] compile an ebnf-grammar or a dsl-file\n'
                       '  [3] run a self-test\n'
                       '  [q] to quit\n'
                       'Please chose 1, 2 or 3> ')
        if choice.strip() == '1':
            project_name = input('Please project name or path > ')
            create_project(project_name)
        elif choice.strip() == '2':
            file_path = input('Please enter a file path for compilation > ')
            if os.path.exists(file_path) and os.path.isfile(file_path):
                compiler_suite = input('Compiler suite or ENTER (for ebnf) > ')
                if (not compiler_suite or (os.path.exists(compiler_suite)
                        and os.path.isfile(compiler_suite))):
                    _errors = compile_on_disk(file_path, compiler_suite)
                    if _errors:
                        print('\n\n'.join(str(err) for err in _errors))
                        sys.exit(1)
                else:
                    print('Compiler suite %s not found! Aborting' % compiler_suite)
            else:
                print('File %s not found! Aborting.' % file_path)
341
                sys.exit(1)
342
        elif choice.strip() == '3':
343
            with logging(LOGGING):
344
345
346
347
348
349
                if not cpu_profile(selftest, 1):
                    print("Selftest FAILED :-(\n")
                    sys.exit(1)
                print("Selftest SUCCEEDED :-)\n")
        elif choice.strip().lower() not in {'q', 'quit', 'exit'}:
            print('No valid choice. Goodbye!')
350

351

352
353
if __name__ == "__main__":
    main()