toolkit.py 12.7 KB
Newer Older
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
"""toolkit.py - utility functions 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.


Module ``toolkit`` contains utility functions and cross-sectional
functionality like logging support that is needed across several 
of the the other DHParser-Modules.

For logging functionality, the global variable LOGGING is defined which
contains the name of a directory where log files shall be placed. By
setting its value to the empty string "" logging can be turned off.

To read the directory name function ``LOGS_DIR()`` should be called
rather than reading the variable LOGGING. ``LOGS_DIR()`` makes sure
the directory exists and raises an error if a file with the same name
already exists.
"""

33
import codecs
34
import collections
Eckhart Arnold's avatar
Eckhart Arnold committed
35
import contextlib
36
37
import hashlib
import os
38

di68kap's avatar
di68kap committed
39
40
41
42
try:
    import regex as re
except ImportError:
    import re
43
import sys
44

45
try:
46
    from typing import Any, List, Tuple
47
except ImportError:
48
    from .typing34 import Any, List, Tuple
49

50
__all__ = ('logging',
Eckhart Arnold's avatar
Eckhart Arnold committed
51
52
           'is_logging',
           'log_dir',
53
           'logfile_basename',
54
55
           # 'supress_warnings',
           # 'warnings',
56
           # 'repr_call',
57
           'line_col',
58
           'error_messages',
59
           'escape_re',
Eckhart Arnold's avatar
Eckhart Arnold committed
60
           'is_filename',
61
62
           'load_if_file',
           'is_python_code',
63
64
           'md5',
           'expand_table',
65
           'smart_list',
66
           'sane_parser_name')
67
68


Eckhart Arnold's avatar
Eckhart Arnold committed
69
70
71
def log_dir() -> str:
    """Creates a directory for log files (if it does not exist) and
    returns its path.
72

Eckhart Arnold's avatar
Eckhart Arnold committed
73
74
75
    WARNING: Any files in the log dir will eventually be overwritten.
    Don't use a directory name that could be the name of a directory
    for other purposes than logging.
76
77
78
79

    Returns:
        name of the logging directory
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
80
    # the try-except clauses in the following are precautions for multiprocessing
81
    global LOGGING
Eckhart Arnold's avatar
Eckhart Arnold committed
82
    try:
83
        dirname = LOGGING  # raises a name error if LOGGING is not defined
Eckhart Arnold's avatar
Eckhart Arnold committed
84
85
86
87
88
89
90
91
        if not dirname:
            raise NameError  # raise a name error if LOGGING evaluates to False
    except NameError:
        raise NameError("No access to log directory before logging has been turned "
                        "on within the same thread/process.")
    if os.path.exists(dirname) and not os.path.isdir(dirname):
        raise IOError('"' + dirname + '" cannot be used as log directory, '
                                      'because it is not a directory!')
92
    else:
Eckhart Arnold's avatar
Eckhart Arnold committed
93
94
95
96
97
        try:
            os.mkdir(dirname)
        except FileExistsError:
            pass
    info_file_name = os.path.join(dirname, 'info.txt')
98
99
100
101
    if not os.path.exists(info_file_name):
        with open(info_file_name, 'w') as f:
            f.write("This directory has been created by DHParser to store log files from\n"
                    "parsing. ANY FILE IN THIS DIRECTORY CAN BE OVERWRITTEN! Therefore,\n"
102
103
                    "do not place any files here and do not bother editing files in this\n"
                    "directory as any changes will get lost.\n")
104
105
106
    return dirname


Eckhart Arnold's avatar
Eckhart Arnold committed
107
@contextlib.contextmanager
108
def logging(dirname="LOGS"):
Eckhart Arnold's avatar
Eckhart Arnold committed
109
110
111
112
113
114
115
116
    """Context manager. Log files within this context will be stored in
    directory ``dirname``. Logging is turned off if name is empty.
    
    Args:
        dirname: the name for the log directory or the empty string to
            turn logging of
    """
    global LOGGING
117
    if dirname and not isinstance(dirname, str):  dirname = "LOGS"  # be fail tolerant here...
Eckhart Arnold's avatar
Eckhart Arnold committed
118
119
120
121
122
123
124
125
126
    try:
        save = LOGGING
    except NameError:
        save = ""
    LOGGING = dirname
    yield
    LOGGING = save


127
def is_logging() -> bool:
Eckhart Arnold's avatar
Eckhart Arnold committed
128
129
130
131
132
133
134
135
    """-> True, if logging is turned on."""
    global LOGGING
    try:
        return bool(LOGGING)
    except NameError:
        return False


Eckhart Arnold's avatar
Eckhart Arnold committed
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def clear_logs(logfile_types={'.cst', '.ast', '.log'}):
    """Removes all logs from the log-directory and removes the
    log-directory if it is empty.
    """
    log_dirname = log_dir()
    files = os.listdir(log_dirname)
    only_log_files = True
    for file in files:
        path = os.path.join(log_dirname, file)
        if os.path.splitext(file)[1] in logfile_types or file == 'info.txt':
            os.remove(path)
        else:
            only_log_files = False
    if only_log_files:
        os.rmdir(log_dirname)


153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# def repr_call(f, parameter_list) -> str:
#     """Turns a list of items into a string resembling the parameter
#     list of a function call by omitting default values at the end:
#     >>> def f(a, b=1):    print(a, b)
#     >>> repr_call(f, (5,1))
#     'f(5)'
#     >>> repr_call(f, (5,2))
#     'f(5, 2)'
#     """
#     i = 0
#     defaults = f.__defaults__ if f.__defaults__ is not None else []
#     for parameter, default in zip(reversed(parameter_list), reversed(defaults)):
#         if parameter != default:
#             break
#         i -= 1
#     if i < 0:
#         parameter_list = parameter_list[:i]
#     name = f.__self__.__class__.__name__ if f.__name__ == '__init__' else f.__name__
171
#     return "%s(%s)" % (name, ", ".merge_children(repr(item) for item in parameter_list))
172
173


174
def line_col(text: str, pos: int) -> Tuple[int, int]:
175
176
    """Returns the position within a text as (line, column)-tuple.
    """
177
    assert pos <= len(text), str(pos) + " > " + str(len(text))  # can point one character after EOF
178
179
180
181
182
    line = text.count("\n", 0, pos) + 1
    column = pos - text.rfind("\n", 0, pos)
    return line, column


183
def error_messages(source_text, errors) -> List[str]:
184
185
186
187
188
189
190
191
192
193
194
    """Returns the sequence or iterator of error objects as an intertor
    of error messages with line and column numbers at the beginning.
    
    Args:
        source_text (str):  The source text on which the errors occurred.
            (Needed in order to determine the line and column numbers.)
        errors (list):  The list of errors as returned by the method 
            ``collect_errors()`` of a Node object     
    Returns:
        a list that contains all error messages in string form. Each
        string starts with "line: [Line-No], column: [Column-No]
195
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
196
    return ["line: %3i, column: %2i" % line_col(source_text, err.pos) + ", error: %s" % err.msg
197
            for err in sorted(list(errors))]
198
199


200
def escape_re(s) -> str:
201
202
203
204
205
206
207
208
209
    """Returns `s` with all regular expression special characters escaped.
    """
    assert isinstance(s, str)
    re_chars = r"\.^$*+?{}[]()#<>=|!"
    for esc_ch in re_chars:
        s = s.replace(esc_ch, '\\' + esc_ch)
    return s


210
def is_filename(s) -> bool:
Eckhart Arnold's avatar
Eckhart Arnold committed
211
212
213
214
215
    """Tries to guess whether string ``s`` is a file name."""
    return s.find('\n') < 0 and s[:1] != " " and s[-1:] != " " \
           and s.find('*') < 0 and s.find('?') < 0


216
def logfile_basename(filename_or_text, function_or_class_or_instance) -> str:
Eckhart Arnold's avatar
Eckhart Arnold committed
217
218
219
220
221
222
223
224
225
226
227
228
229
230
    """Generates a reasonable logfile-name (without extension) based on
    the given information.
    """
    if is_filename(filename_or_text):
        return os.path.basename(os.path.splitext(filename_or_text)[0])
    else:
        try:
            s = function_or_class_or_instance.__qualname.__
        except AttributeError:
            s = function_or_class_or_instance.__class__.__name__
        i = s.find('.')
        return s[:i] + '_out' if i >= 0 else s


231
232
233
def load_if_file(text_or_file) -> str:
    """Reads and returns content of a text-file if parameter
    `text_or_file` is a file name (i.e. a single line string),
234
    otherwise (i.e. if `text_or_file` is a multi-line string)
235
    `text_or_file` is returned.
236
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
237
    if is_filename(text_or_file):
238
239
240
241
        try:
            with open(text_or_file, encoding="utf-8") as f:
                content = f.read()
            return content
242
        except FileNotFoundError:
243
            if re.fullmatch(r'[\w/:. \\]+', text_or_file):
244
245
                raise FileNotFoundError('Not a valid file: ' + text_or_file + '!\n(Add "\\n" '
                                        'to distinguish source data from a file name.)')
246
247
            else:
                return text_or_file
248
249
250
251
    else:
        return text_or_file


252
def is_python_code(text_or_file) -> bool:
253
254
255
    """Checks whether 'text_or_file' is python code or the name of a file that
    contains python code.
    """
Eckhart Arnold's avatar
Eckhart Arnold committed
256
    if is_filename(text_or_file):
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
        return text_or_file[-3:].lower() == '.py'
    try:
        compile(text_or_file, '<string>', 'exec')
        return True
    except (SyntaxError, ValueError, OverflowError):
        pass
    return False


def md5(*txt):
    """Returns the md5-checksum for `txt`. This can be used to test if
    some piece of text, for example a grammar source file, has changed.
    """
    md5_hash = hashlib.md5()
    for t in txt:
        md5_hash.update(t.encode('utf8'))
    return md5_hash.hexdigest()


276
277
def smart_list(arg) -> list:
    """Returns the argument as list, depending on its type and content.
278
279
280
281
    
    If the argument is a string, it will be interpreted as a list of
    comma separated values, trying ';', ',', ' ' as possible delimiters
    in this order, e.g.
282
283
284
285
286
287
288
    >>> smart_list('1; 2, 3; 4')
    ['1', '2, 3', '4']
    >>> smart_list('2, 3')
    ['2', '3']
    >>> smart_list('a b cd')
    ['a', 'b', 'cd']

289
290
    If the argument is a collection other than a string, it will be
    returned as is, e.g.
291
292
293
294
295
    >>> smart_list((1, 2, 3))
    (1, 2, 3)
    >>> smart_list({1, 2, 3})
    {1, 2, 3}

296
297
    If the argument is another iterable than a collection, it will
    be converted into a list, e.g.
298
299
300
    >>> smart_list(i for i in {1,2,3})
    [1, 2, 3]

301
302
    Finally, if none of the above is true, the argument will be 
    wrapped in a list and returned, e.g.
303
304
    >>> smart_list(125)
    [125]
305
306
307
308
309
    """
    if isinstance(arg, str):
        for delimiter in (';', ','):
            lst = arg.split(delimiter)
            if len(lst) > 1:
310
311
                return [s.strip() for s in lst]
        return [s.strip() for s in arg.strip().split(' ')]
312
313
    elif isinstance(arg, collections.abc.Container):
        return arg
314
    elif isinstance(arg, collections.abc.Iterable):
315
        return list(arg)
316
317
318
319
    else:
        return [arg]


320
321
322
323
324
def expand_table(compact_table):
    """Expands a table by separating keywords that are tuples or strings
    containing comma separated words into single keyword entries with
    the same values. Returns the expanded table.
    Example:
325
326
    >>> expand_table({"a, b": 1, ('d','e','f'):5, "c":3})
    {'a': 1, 'b': 1, 'd': 5, 'e': 5, 'f': 5, 'c': 3}
327
328
329
330
331
    """
    expanded_table = {}
    keys = list(compact_table.keys())
    for key in keys:
        value = compact_table[key]
332
        for k in smart_list(key):
333
            if k in expanded_table:
334
                raise KeyError('Key "%s" used more than once in compact table!' % key)
335
            expanded_table[k] = value
336
    return expanded_table
337
338


339
def sane_parser_name(name) -> bool:
340
    """Checks whether given name is an acceptable parser name. Parser names
341
    must not be preceded or succeeded by a double underscore '__'!
342
    """
di68kap's avatar
di68kap committed
343
344
345
    return name and name[:2] != '__' and name[-2:] != '__'


346
347
348
349
def compile_python_object(python_src, catch_obj_regex=""):
    """Compiles the python source code and returns the (first) object 
    the name of which is matched by ``catch_obj_regex``. If catch_obj
    is the empty string, the namespace dictionary will be returned.
di68kap's avatar
di68kap committed
350
351
352
353
354
355
    """
    if isinstance(catch_obj_regex, str):
        catch_obj_regex = re.compile(catch_obj_regex)
    code = compile(python_src, '<string>', 'exec')
    namespace = {}
    exec(code, namespace)  # safety risk?
356
357
358
359
360
361
    if catch_obj_regex:
        matches = [key for key in namespace.keys() if catch_obj_regex.match(key)]
        if len(matches) == 0:
            raise ValueError("No object matching /%s/ defined in source code." %
                             catch_obj_regex.pattern)
        elif len(matches) > 1:
362
            raise ValueError("Ambiguous matches for %s : %s" %
363
364
365
366
                             (str(catch_obj_regex), str(matches)))
        return namespace[matches[0]] if matches else None
    else:
        return namespace
367
368


369
370
371
372
def identity(anything: Any) -> Any:
    return anything


373
374
375
376
377
378
379
380
try:
    if sys.stdout.encoding.upper() != "UTF-8":
        # make sure that `print()` does not raise an error on 
        # non-ASCII characters:
        sys.stdout = codecs.getwriter("utf-8")(sys.stdout.detach())
except AttributeError:
    # somebody has already taken care of this !?
    pass