Project

General

Profile

1 11 aaronmk
# Useful functions and classes
2
3 1068 aaronmk
import collections
4
5 931 aaronmk
#### Function wrappers for statements
6
7
def noop(*args, **kw_args): pass
8
9
def and_(a, b): return a and b
10
11 791 aaronmk
#### Object metadata
12
13 341 aaronmk
def type_name(value): return type(value).__name__
14
15 135 aaronmk
def module(value): return type(value).__module__.split('.')
16
17
def root_module(value): return module(value)[0]
18
19 1233 aaronmk
#### Type checking and conversion
20 791 aaronmk
21
class ConstraintError(ValueError):
22
    def __init__(self, check_func, value):
23 795 aaronmk
        ValueError.__init__(self, str(value)+' must satisfy constraint '
24
            +check_func.__name__)
25 791 aaronmk
26 836 aaronmk
def cast(type_, val):
27 1046 aaronmk
    '''Passes None through. Does not cast a subclass to a superclass (which
28
    doesn't make sense in a dynamically-typed language).'''
29
    if val != None and not isinstance(val, type_): val = type_(val)
30 836 aaronmk
    return val
31
32 1233 aaronmk
def all_not_none(vals): return reduce(and_, map(lambda v: v != None, vals))
33
34 791 aaronmk
def is_str(val): return isinstance(val, basestring)
35
36 1007 aaronmk
def is_list(val): return isinstance(val, list)
37
38 1233 aaronmk
def bool2str(val):
39
    if val: return '1'
40
    else: return ''
41
42 1046 aaronmk
#### Basic types
43
44 1359 aaronmk
def do_ignore_none(do, val):
45
    if val == None: return val
46
    else: return do(val)
47
48 1373 aaronmk
def none_if(val, *none_vals):
49
    for none_val in none_vals:
50
        if cast(type(none_val), val) == none_val: return None
51
    return val
52 1046 aaronmk
53 791 aaronmk
#### Iterables
54
55 135 aaronmk
def first(iter_): return iter_.next()
56
57 133 aaronmk
def skip(iter_, func):
58
    # Advance iter while func is True
59
    try:
60
        while func(iter_.curr()): iter_.next()
61
    except StopIteration: pass # nothing after the matching elements
62
63 1147 aaronmk
class WrapIter:
64
    def __init__(self, wrap_func, iterable):
65
        self.wrap_func = wrap_func
66
        self.iter_ = iterable.__iter__()
67
68
    def __iter__(self): return self
69
70
    def next(self): return self.wrap_func(self.iter_.next())
71 934 aaronmk
72 791 aaronmk
class CheckedIter:
73
    def __init__(self, check_func, iterable):
74
        self.check_func = check_func
75
        self.iter_ = iterable.__iter__()
76
77
    def __iter__(self): return self
78
79
    def next(self):
80
        entry = self.iter_.next()
81
        if self.check_func(entry): return entry
82
        else: raise ConstraintError(self.check_func, entry)
83
84 1008 aaronmk
#### Lists
85
86
def list_get(list_, idx, default=None):
87
    try: return list_[idx]
88
    except IndexError: return default
89
90 1281 aaronmk
def list_set(list_, idx, value, default=None):
91
    extra_needed = idx + 1 - len(list_)
92
    if extra_needed > 0: list_ += extra_needed*[default]
93
    list_[idx] = value
94
95
def list_setdefault(list_, idx, default=None):
96
    try: return list_[idx]
97
    except IndexError:
98
        list_set(list_, idx, default, default)
99
        return default
100
101 1147 aaronmk
def list_subset(list_, idxs):
102
    subset = []
103
    for idx in idxs:
104
        try: subset.append(list_[idx])
105
        except IndexError: pass
106
    return subset
107
108 1012 aaronmk
def list_eq_is(list0, list1):
109
    '''Compares two lists using is'''
110
    if len(list0) != len(list1): return False
111
    for i in xrange(len(list0)):
112
        if list0[i] is not list1[i]: return False
113
    return True
114
115 1344 aaronmk
def list_replace(list_, repl_elem, with_slice):
116
    list_ = list_[:] # don't modify input!
117
    while True:
118
        try: idx = list_.index(repl_elem)
119
        except ValueError: break
120
        list_[idx:idx+1] = with_slice
121
    return list_
122
123 1145 aaronmk
def list_flip(list_): return dict((v, i) for i, v in enumerate(list_))
124
125 791 aaronmk
#### Dicts
126
127 330 aaronmk
def rename_key(dict_, orig, new): dict_[new] = dict_.pop(orig)
128 466 aaronmk
129 467 aaronmk
def dict_subset(dict_, keys):
130
    subset = dict()
131
    for key in keys:
132
        try: subset[key] = dict_[key]
133
        except KeyError: pass
134
    return subset
135 1068 aaronmk
136
class DefaultDict(collections.defaultdict):
137
    def __init__(self, dict_, default=None):
138
        collections.defaultdict.__init__(self, lambda: default, dict_)
139
140
def dict_subset_right_join(dict_, keys):
141
    '''Gets a subset of a dict, using None for subset keys that don't exist'''
142
    return dict_subset(DefaultDict(dict_), keys)
143 1147 aaronmk
144
class ListDict:
145
    '''Views a list as a dict, given a key->index mapping'''
146
    def __init__(self, list_, keys, key_idxs=None):
147
        assert len(keys) == len(list_)
148
        if key_idxs == None: key_idxs = list_flip(keys)
149
        self.list = list_
150
        self.keys = keys
151
        self.key_idxs = key_idxs
152
153
    def __getitem__(self, key): return self.list[self.key_idxs[key]]
154
155 1178 aaronmk
    def __str__(self): return '{\n'+(''.join(str(k)+': '+str(v)+'\n'
156
        for k, v in zip(self.keys, self.list)))+'}\n'