# Useful functions and classes

import locale

locale.setlocale(locale.LC_ALL, '') # needed to initialize locale

#### Function wrappers for statements

def noop(*args, **kw_args): pass

def and_(a, b): return a and b

#### Object metadata

def type_name(value): return type(value).__name__

def module(value): return type(value).__module__.split('.')

def root_module(value): return module(value)[0]

#### Basic types

class ConstraintError(ValueError):

    def __init__(self, check_func, value):

        ValueError.__init__(self, str(value)+' must satisfy constraint '

            +check_func.__name__)

def cast(type_, val):

    '''Passes None through'''

    if val != None: val = type_(val)

    return val

def is_str(val): return isinstance(val, basestring)

#### Strings

def format_str(format, val):

    return locale.format_string(format, val, grouping=True)

def to_percent(val, sig_figs=2):

    if val >= 1: sig_figs += 1

    return format_str('%#.'+str(sig_figs)+'g', val*100)+'%'

def to_si(val, sig_figs=3):

    '''Adds SI prefix to value'''

    prefix = ''

    if val < 1: prefix = 'm'; val *= 1000

    return format_str('%#.'+str(sig_figs)+'g', val)+' '+prefix

#### Iterables

def first(iter_): return iter_.next()

def skip(iter_, func):

    # Advance iter while func is True

    try:

        while func(iter_.curr()): iter_.next()

    except StopIteration: pass # nothing after the matching elements

def list_subset(list_, idxs):

    subset = []

    for idx in idxs:

        try: subset.append(list_[idx])

        except IndexError: pass

    return subset

class CheckedIter:

    def __init__(self, check_func, iterable):

        self.check_func = check_func

        self.iter_ = iterable.__iter__()

    def __iter__(self): return self

    def next(self):

        entry = self.iter_.next()

        if self.check_func(entry): return entry

        else: raise ConstraintError(self.check_func, entry)

#### Dicts

def rename_key(dict_, orig, new): dict_[new] = dict_.pop(orig)

def dict_subset(dict_, keys):

    subset = dict()

    for key in keys:

        try: subset[key] = dict_[key]

        except KeyError: pass

    return subset