Project

General

Profile

1 73 aaronmk
# String manipulation
2
3 1295 aaronmk
import codecs
4 861 aaronmk
import re
5
6 1232 aaronmk
import util
7
8 1622 aaronmk
##### Parsing
9
10
def split(sep, str_):
11
    '''Returns [] if str_ == ""'''
12
    if str_ == '': return []
13
    else: return str_.split(sep)
14
15 2221 aaronmk
def remove_prefix(prefix, str_, removed_ref=None):
16
    if removed_ref == None: removed_ref = [False]
17
18
    removed_ref[0] = str_.startswith(prefix)
19
    if removed_ref[0]: return str_[len(prefix):]
20 1622 aaronmk
    else: return str_
21
22 1680 aaronmk
def remove_prefixes(prefixes, str_):
23
    for prefix in prefixes: str_ = remove_prefix(prefix, str_)
24
    return str_
25
26
def with_prefixes(prefixes, str_): return (p+str_ for p in prefixes)
27
28 2221 aaronmk
def remove_suffix(suffix, str_, removed_ref=None):
29
    if removed_ref == None: removed_ref = [False]
30
31
    removed_ref[0] = str_.endswith(suffix)
32
    if removed_ref[0]: return str_[:-len(suffix)]
33 1622 aaronmk
    else: return str_
34
35 1959 aaronmk
def contains_any(haystack, needles):
36
    for needle in needles:
37
        if haystack.find(needle) >= 0: return True
38
    return False
39
40 1622 aaronmk
def overlaps(str0, str1): return str0.find(str1) >= 0 or str1.find(str0) >= 0
41
42 1401 aaronmk
##### Unicode
43
44 1295 aaronmk
unicode_reader = codecs.getreader('utf_8')
45
46 73 aaronmk
def to_unicode(str_):
47
    if isinstance(str_, unicode): return str_
48
    encodings = ['utf_8', 'latin_1']
49
    for encoding in encodings:
50
        try: return unicode(str_, encoding)
51
        except UnicodeDecodeError, e: pass
52
    raise AssertionError(encoding+' is not a catch-all encoding')
53 340 aaronmk
54 1232 aaronmk
def ustr(val):
55
    '''Like built-in str() but converts to unicode object'''
56
    if not util.is_str(val): val = str(val)
57
    return to_unicode(val)
58
59 2502 aaronmk
def repr_no_u(value):
60
    '''Like built-in repr() but removes the "u" in `u'...'`'''
61 2582 aaronmk
    return re.sub(r"^u(?=')", r'', repr(value))
62 2502 aaronmk
63 1401 aaronmk
##### Line endings
64
65 1622 aaronmk
def extract_line_ending(line):
66
    '''@return tuple (contents, ending)'''
67
    contents = remove_suffix('\r', remove_suffix('\n', line))
68
    return (contents, line[len(contents):])
69 714 aaronmk
70 1622 aaronmk
def remove_line_ending(line): return extract_line_ending(line)[0]
71
72
def ensure_newl(str_): return remove_line_ending(str_)+'\n'
73
74 856 aaronmk
def is_multiline(str_):
75
    newl_idx = str_.find('\n')
76
    return newl_idx >= 0 and newl_idx != len(str_)-1 # has newline before end
77
78 860 aaronmk
def remove_extra_newl(str_):
79 856 aaronmk
    if is_multiline(str_): return str_
80 2480 aaronmk
    else: return str_.rstrip('\n')
81 856 aaronmk
82 714 aaronmk
def std_newl(str_): return str_.replace('\r\n', '\n').replace('\r', '\n')
83
84 1401 aaronmk
##### Whitespace
85
86 714 aaronmk
def cleanup(str_): return std_newl(str_.strip())
87 861 aaronmk
88 1364 aaronmk
def single_space(str_): return re.sub(r' {2,}', r' ', str_.strip())
89
90 861 aaronmk
def one_line(str_): return re.sub(r'\n *', r' ', cleanup(str_))
91 1761 aaronmk
92
##### Control characters
93
94
def is_ctrl(char):
95
    '''Whether char is a (non-printable) control character'''
96
    return ord(char) < 32 and not char.isspace()
97
98
def strip_ctrl(str_):
99
    '''Strips (non-printable) control characters'''
100
    return ''.join(filter(lambda c: not is_ctrl(c), str_))
101 2471 aaronmk
102
##### Formatting
103
104 2477 aaronmk
def as_tt(str_): return '@'+str_+'@'
105
106 2475 aaronmk
def as_code(str_, lang=None, multiline=True):
107 2471 aaronmk
    '''Wraps a string in Redmine tags to syntax-highlight it.'''
108 2480 aaronmk
    str_ = '\n'+str_.rstrip('\n')+'\n'
109 2471 aaronmk
    if lang != None: str_ = '<code class="'+lang+'">'+str_+'</code>'
110 2475 aaronmk
    if multiline: str_ = '<pre>'+str_+'</pre>'
111
    return str_
112 2477 aaronmk
113 2504 aaronmk
def as_inline_table(dict_, key_label='Output', value_label='Input', ustr=ustr):
114 2477 aaronmk
    '''Wraps a dict in Redmine tags to format it as a table.'''
115
    str_ = ''
116 2481 aaronmk
    def row(entry): return (': '.join(entry))+'\n'
117 2477 aaronmk
    str_ += row([key_label, value_label])
118 2481 aaronmk
    for entry in dict_.iteritems(): str_ += row([ustr(v) for v in entry])
119
    return '<pre>\n'+str_+'</pre>'
120 2482 aaronmk
121 2504 aaronmk
def as_table(dict_, key_label='Output', value_label='Input', ustr=ustr):
122 2482 aaronmk
    '''Wraps a dict in Redmine tags to format it as a table.'''
123
    str_ = ''
124
    def row(entry): return ('|'.join(['']+entry+['']))+'\n'# '' for outer border
125
    str_ += row([key_label, value_label])
126
    for entry in dict_.iteritems(): str_ += row([as_tt(ustr(v)) for v in entry])
127
    return '\n'+str_+' ' # space protects last \n so blank line ends table