confutil.py

# -*- coding: UTF-8 -*-

import codecs   ## Encoding is a nightmare that never ends
import io       ## - || -

def cVars(confile):
    """Returns a dictionary with the keys and values specified in a separate config file."""
    configs = open(confile, 'r')
    cf = {}
    lines = [l for l in configs if l and l[:2] != '##' and l.strip()]
    if lines[0].startswith(codecs.BOM_UTF8): ## Byte order markers sometimes are interpreted as characters
        lines[0] = lines[0][len(codecs.BOM_UTF8):]
        if lines[0][:2] == '##' or not lines[0].strip():
            del lines[0]
        lines = [unicode(line, 'utf-8') for line in lines]
    for line in lines:
        key, value = line.split("=")
        if not value.strip()[0:3] == '[l]':
            cf[key.strip()] = value.strip()
        else:
            value = [e.strip() for e in value.strip()[3:].split(',') if e.strip()]
            cf[key.strip()] = value
    configs.close()
    return cf

def tabCount(key):
    """Returns enough tabs to reach the third indent level, based on string 'key'."""
    if   len(key) >= 24:
        return ''
    elif len(key) >= 16:
        return '\t' * 1
    elif len(key) >=  8:
        return '\t' * 2
    else:
        return '\t' * 3

def createConfig(config, filename):
    """Creates a config file 'filename' based on a dictionary or tuple/list."""
    with io.open(filename, 'w', encoding='utf-8-sig') as confile: ##vpmgoöe
        if type(config) == dict: ## Allows for a dictionary to be written to file, sorted alphabetically
            for key in config.keys():
                tabs = tabCount(key)
                if not type(config[key]) == list:
                    confile.write((str(key) + tabs + '=\t' + str(config[key]) + '\n').decode('utf-8'))
                else:
                    confile.write((str(key) + tabs + '=\t[l] ' + ', '.join(config[key]).strip() + "\n").decode('utf-8'))
            lineSort(filename)
        else:   ## Allows for tuples or lists to be written to config
                ## Must be a tuple/list of tuples and/or lists. The second value
                ## will be used as the value, the first one as the key
            for pair in config:
                if type(pair) == str or type(pair) == unicode: ## Allows for comments
                    confile.write((pair + '\n').decode('utf-8'))
                else: ## Writes cVars()-compatible files
                    key = str(pair[0])
                    if type(pair[1]) == list:
                        value = str(', '.join(pair[1]))
                        value = '[l] ' + value
                    else:
                        value = str(pair[1])
                    tabs = tabCount(key)
                    confile.write((key + tabs + '=\t' + value + '\n').decode('utf-8'))
                
    #confile.close() ## Took me way too long to add this

def lineSort(filename):
    """Sorts the lines in file 'filename' alphabetically."""
    sortfile = open(filename, 'r')
    lines = sortfile.read().split('\n') ## Creates sortable list
    sortfile.close()
    nonempty = [line.rstrip() for line in lines if line.strip() and line.strip()[0:2] != '##']
    nonempty.sort()
    sortfile = io.open(filename, 'w', encoding='utf-8-sig')
    sortfile.write(('\n'.join(nonempty) + '\n').decode('utf-8'))
    sortfile.close()

def stringToBool(s):
    return s.lower() == 'true' ## All variations of "True" return True, everything else returns False