dh.py

# dh.py
#
# digital history module from Turkel & MacEachern,
# The Programming Historian (2007-08)
#
# contents:
#
# stopwords LIST
# normalizeFrenchAccents(STRING) -> STRING
# stripTags(HTML_STRING) -> TEXT_STRING
# stripNonAlphaNum(TEXT_STRING) -> ALPHANUMERIC_STRING
# webPageToText(URL_STRING) -> LOWERCASE_TEXT_STRING
# removeStopwords(WORD_LIST, STOPWORD_LIST) -> WORD_LIST
# wordListToFreqDict(WORD_LIST) -> DICTIONARY(WORD -> FREQUENCY)
# sortFreqDict(DICTIONARY(WORD -> FREQUENCY)) -> SORTED_DICTIONARY(WORD -> FREQUENCY)
# reSortFreqDictAlpha(DICTIONARY(WORD -> FREQUENCY)) -> SORTED_DICTIONARY(WORD -> FREQUENCY)
# wrapStringInHTML(STRING, URL_STRING, STRING) -> HTML_STRING
# keywordListToGoogleSearchLink(WORD_LIST, STRING) -> HTML_STRING
# undecoratedHyperlink(URL_STRING, STRING) -> HTML_CSS_STRING
# getNGrams(WORD_LIST, INTEGER) -> NGRAM_LIST
# nGramsToKWICDict(NGRAM_LIST) -> DICTIONARY(KEYWORD_STRING -> KWIC_LIST)
# prettyPrintKWIC(KWIC_LIST) -> STRING
# defaultCSSDiv(STRING, STRING) -> HTML_CSS_STRING
# scaledFontSizeSpan(STRING, INTEGER) -> HTML_CSS_STRING
# scaledFontShadeSpan(STRING, INTEGER) -> HTML_CSS_STRING
# scaledFontHeatmapSpan(STRING, INTEGER) -> HTML_CSS_STRING
# getFileNames(STRING) -> LIST
# localWebPageToText(HTML_STRING) -> STRING
# replaceStopwords(WORD_LIST, STOPWORD_LIST, STRING) -> WORD_LIST

stopwords = ['a', 'about', 'above', 'across', 'after', 'afterwards']
stopwords += ['again', 'against', 'all', 'almost', 'alone', 'along']
stopwords += ['already', 'also', 'although', 'always', 'am', 'among']
stopwords += ['amongst', 'amoungst', 'amount', 'an', 'and', 'another']
stopwords += ['any', 'anyhow', 'anyone', 'anything', 'anyway', 'anywhere']
stopwords += ['are', 'around', 'as', 'at', 'back', 'be', 'became']
stopwords += ['because', 'become', 'becomes', 'becoming', 'been']
stopwords += ['before', 'beforehand', 'behind', 'being', 'below']
stopwords += ['beside', 'besides', 'between', 'beyond', 'bill', 'both']
stopwords += ['bottom', 'but', 'by', 'call', 'can', 'cannot', 'cant']
stopwords += ['co', 'computer', 'con', 'could', 'couldnt', 'cry', 'de']
stopwords += ['describe', 'detail', 'did', 'do', 'done', 'down', 'due']
stopwords += ['during', 'each', 'eg', 'eight', 'either', 'eleven', 'else']
stopwords += ['elsewhere', 'empty', 'enough', 'etc', 'even', 'ever']
stopwords += ['every', 'everyone', 'everything', 'everywhere', 'except']
stopwords += ['few', 'fifteen', 'fifty', 'fill', 'find', 'fire', 'first']
stopwords += ['five', 'for', 'former', 'formerly', 'forty', 'found']
stopwords += ['four', 'from', 'front', 'full', 'further', 'get', 'give']
stopwords += ['go', 'had', 'has', 'hasnt', 'have', 'he', 'hence', 'her']
stopwords += ['here', 'hereafter', 'hereby', 'herein', 'hereupon', 'hers']
stopwords += ['herself', 'him', 'himself', 'his', 'how', 'however']
stopwords += ['hundred', 'i', 'ie', 'if', 'in', 'inc', 'indeed']
stopwords += ['interest', 'into', 'is', 'it', 'its', 'itself', 'keep']
stopwords += ['last', 'latter', 'latterly', 'least', 'less', 'ltd', 'made']
stopwords += ['many', 'may', 'me', 'meanwhile', 'might', 'mill', 'mine']
stopwords += ['more', 'moreover', 'most', 'mostly', 'move', 'much']
stopwords += ['must', 'my', 'myself', 'name', 'namely', 'neither', 'never']
stopwords += ['nevertheless', 'next', 'nine', 'no', 'nobody', 'none']
stopwords += ['noone', 'nor', 'not', 'nothing', 'now', 'nowhere', 'of']
stopwords += ['off', 'often', 'on','once', 'one', 'only', 'onto', 'or']
stopwords += ['other', 'others', 'otherwise', 'our', 'ours', 'ourselves']
stopwords += ['out', 'over', 'own', 'part', 'per', 'perhaps', 'please']
stopwords += ['put', 'rather', 're', 's', 'same', 'see', 'seem', 'seemed']
stopwords += ['seeming', 'seems', 'serious', 'several', 'she', 'should']
stopwords += ['show', 'side', 'since', 'sincere', 'six', 'sixty', 'so']
stopwords += ['some', 'somehow', 'someone', 'something', 'sometime']
stopwords += ['sometimes', 'somewhere', 'still', 'such', 'system', 'take']
stopwords += ['ten', 'than', 'that', 'the', 'their', 'them', 'themselves']
stopwords += ['then', 'thence', 'there', 'thereafter', 'thereby']
stopwords += ['therefore', 'therein', 'thereupon', 'these', 'they']
stopwords += ['thick', 'thin', 'third', 'this', 'those', 'though', 'three']
stopwords += ['three', 'through', 'throughout', 'thru', 'thus', 'to']
stopwords += ['together', 'too', 'top', 'toward', 'towards', 'twelve']
stopwords += ['twenty', 'two', 'un', 'under', 'until', 'up', 'upon']
stopwords += ['us', 'very', 'via', 'was', 'we', 'well', 'were', 'what']
stopwords += ['whatever', 'when', 'whence', 'whenever', 'where']
stopwords += ['whereafter', 'whereas', 'whereby', 'wherein', 'whereupon']
stopwords += ['wherever', 'whether', 'which', 'while', 'whither', 'who']
stopwords += ['whoever', 'whole', 'whom', 'whose', 'why', 'will', 'with']
stopwords += ['within', 'without', 'would', 'yet', 'you', 'your']
stopwords += ['yours', 'yourself', 'yourselves']

# Given a string containing French accented characters
# in Unicode or HTML, return normalized lowercase.

def normalizeFrenchAccents(str):
    newstr = unicode(str, 'utf-8').encode('latin-1', 'replace')
    newstr = newstr.lower()
    newstr = newstr.replace('’', '\'')
    newstr = newstr.replace('\xc0', '\xe0') # a grave    
    newstr = newstr.replace('à', '\xe0') # a grave    
    newstr = newstr.replace('\xc2', '\xe2') # a circumflex
    newstr = newstr.replace('â', '\xe2') # a circumflex
    newstr = newstr.replace('\xc4', '\xe4') # a diaeresis
    newstr = newstr.replace('ä', '\xe4') # a diaeresis
    newstr = newstr.replace('\xc6', '\xe6') # ae ligature
    newstr = newstr.replace('æ', '\xe6') # ae ligature
    newstr = newstr.replace('\xc8', '\xe8') # e grave
    newstr = newstr.replace('è', '\xe8') # e grave
    newstr = newstr.replace('\xc9', '\xe9') # e acute
    newstr = newstr.replace('é', '\xe9') # e acute
    newstr = newstr.replace('\xca', '\xea') # e circumflex
    newstr = newstr.replace('ê', '\xea') # e circumflex
    newstr = newstr.replace('\xcb', '\xeb') # e diaeresis
    newstr = newstr.replace('ë', '\xeb') # e diaeresis
    newstr = newstr.replace('\xce', '\xee') # i circumflex
    newstr = newstr.replace('î', '\xee') # i circumflex
    newstr = newstr.replace('\xcf', '\xef') # i diaeresis
    newstr = newstr.replace('ï', '\xef') # i diaeresis
    newstr = newstr.replace('\xd4', '\xf4') # o circumflex
    newstr = newstr.replace('ô', '\xf4') # o circumflex
    newstr = newstr.replace('œ', 'oe') # oe ligature
    newstr = newstr.replace('\xd9', '\xf9') # u grave
    newstr = newstr.replace('ù', '\xf9') # u grave
    newstr = newstr.replace('\xdb', '\xfb') # u circumflex 
    newstr = newstr.replace('û', '\xfb') # u circumflex 
    newstr = newstr.replace('\xdc', '\xfc') # u diaeresis
    newstr = newstr.replace('ü', '\xfc') # u diaeresis
    newstr = newstr.replace('\xc7', '\xe7') # c cedilla
    newstr = newstr.replace('ç', '\xe7') # c cedilla
    newstr = newstr.replace('ÿ', '\xff') # y diaeresis
    return newstr

# Given a string containing HTML, remove all characters
# between matching pairs of angled brackets, inclusive.

def stripTags(html):
    inside = 0
    text = ''
    for char in html:
        if char == '<':
            inside = 1
            continue
        elif (inside == 1 and char == '>'):
            inside = 0
            continue
        elif inside == 1:
            continue
        else:
            text += char
    return text

# Given a text string, remove all non-alphanumeric
# characters (using Unicode definition of alphanumeric).

def stripNonAlphaNum(text):
    import re
    return re.compile(r'\W+', re.UNICODE).split(text)

# Given a URL, return string of lowercase text from page.

def webPageToText(url):
    import urllib2
    response = urllib2.urlopen(url)
    html = response.read()
    text = stripTags(html).replace('&nbsp;', ' ')
    return text.lower()

# Given a list of words, remove any that are
# in a list of stop words.

def removeStopwords(wordlist, stopwords):
    return [w for w in wordlist if w not in stopwords]

# Given a list of words, return a dictionary of
# word-frequency pairs.

def wordListToFreqDict(wordlist):
    wordfreq = [wordlist.count(p) for p in wordlist]
    return dict(zip(wordlist,wordfreq))

# Sort a dictionary of word-frequency pairs in
# order of descending frequency.

def sortFreqDict(freqdict):
    aux = [(freqdict[key], key) for key in freqdict]
    aux.sort()
    aux.reverse()
    return aux

# Given a dictionary of frequency-word pairs sorted
# in order of descending frequency, re-sort so it is
# in alphabetical order by word.

def reSortFreqDictAlpha(sorteddict):
    import operator
    aux = [pair for pair in sorteddict]
    aux.sort(key=operator.itemgetter(1))
    return aux

# Given name of calling program, a url and a string to wrap,
# output string in HTML body with basic metadata
# and open in Firefox tab.

def wrapStringInHTML(program, url, body):
    import datetime
    # from webbrowser import open_new_tab
    now = datetime.datetime.today().strftime("%Y%m%d-%H%M%S")
    filename = program + '.html'
    f = open(filename,'w')
    wrapper = """<html>
        <head>
        <title>%s output - %s</title>
        </head>
        <body><p>URL: <a href=\"%s\">%s</a></p><p>%s</p></body>
        </html>"""
    whole = wrapper % (program, now, url, url, body)
    f.write(whole)
    f.close()   
    # open_new_tab(filename)

# Given a list of keywords and a link name, return an
# HTML link to a Google search for those terms.

def keywordListToGoogleSearchLink(keywords, linkname):
    url = 'http://www.google.com/search?q='
    url += '+'.join(keywords)
    gsearch = undecoratedHyperlink(url, linkname)
    return gsearch
    
# Given a url and link name, return a string containing
# HTML and inline CSS for an undecorated hyperlink.

def undecoratedHyperlink(url, linkname):
    astr = """<a
    style=\"text-decoration:none\" href=\"%s\">%s</a>
    """
    return astr % (url, linkname)

# Given a list of words and a number n, return a list
# of n-grams.

def getNGrams(wordlist, n):
    return [wordlist[i:i+n] for i in range(len(wordlist)-(n-1))]

# Given a list of n-grams, return a dictionary of KWICs,
# indexed by keyword.

def nGramsToKWICDict(ngrams):
    kwicdict = {}
    keyindex = len(ngrams[0]) // 2
    for k in ngrams:
      if k[keyindex] not in kwicdict:
        kwicdict[k[keyindex]] = [k]
      else:
        kwicdict[k[keyindex]].append(k)
    return kwicdict

# Given a KWIC, return a string that is formatted for
# pretty printing.

def prettyPrintKWIC(kwic):
    n = len(kwic)
    keyindex = n // 2
    width = 10
    outstring = ' '.join(kwic[:keyindex]).rjust(width*keyindex)
    outstring += str(kwic[keyindex]).center(len(kwic[keyindex])+6)
    outstring += ' '.join(kwic[(keyindex+1):])
    return outstring
    
# Given the body of a div and an optional string of
# property-value pairs, return string containing HTML
# and inline CSS for default div.

def defaultCSSDiv(divbody, opt=''):
    divstr = """<div style=\"
    width: 560px;
    background-color: rgb(250,250,250);
    border: 1px grey solid;
    text-align: center;
    %s\">%s</div>
    """
    return divstr % (opt, divbody)

# Given the body of a span and a scaling factor, return
# string containing HTML span with scaled font size.

def scaledFontSizeSpan(body, scalingfactor):
    import math
    minfont = 24
    maxfont = 54
    fontrange = maxfont - minfont
    fontsize = int(minfont + math.floor(fontrange * scalingfactor))
    spanstr = '<span style=\"font-size:%spx;\">%s</span>'
    return spanstr % (str(fontsize), body)

# Given the body of a span and a scaling factor, return
# string containing HTML span with scaled font size and
# darkness of greyscale adjusted.

def scaledFontShadeSpan(body, scalingfactor):
    import math
    minfont = 24
    maxfont = 54
    fontrange = maxfont - minfont
    fontsize = int(minfont + math.floor(fontrange * scalingfactor))
    fontcolor = int(200 - math.ceil(200 * scalingfactor))
    spanstr = """<span style=\"font-size:%spx;
    color: rgb(%d,%d,%d);
    \">%s</span>
    """
    return spanstr % (str(fontsize), fontcolor, fontcolor, fontcolor, body)

# Given the body of a span and a scaling factor, return
# string containing HTML span with scaled font size and
# shading from cool blue to hot red.

def scaledFontHeatmapSpan(body, scalingfactor):
    import math
    minfont = 24
    maxfont = 54
    fontrange = maxfont - minfont
    fontsize = int(minfont + math.floor(fontrange * scalingfactor))
    fontcolor = int(250 - math.ceil(250 * scalingfactor))
    spanstr = """<span style=\"font-size:%spx;
    color: rgb(%d,0,%d);
    \">%s</span>
    """
    return spanstr % (str(fontsize), 250-fontcolor, fontcolor, body)

# Given a string containing the name of a directory
# return a list of files in that directory

def getFileNames(dirname):
    import os
    dircommand = 'dir ' + dirname + ' /B'
    filelist = os.popen(dircommand).readlines()
    filelist = [x.rstrip() for x in filelist]
    return filelist

# Given a local copy of a webpage, return string
# of lowercase text from page.

def localWebPageToText(webpage):    
    f = open(webpage, 'r')
    html = f.read()
    f.close()
    text = stripTags(html).replace('&nbsp;', ' ')
    return text.lower()

# Given a list of words, replace any that are
# stop words with a placeholder.

def replaceStopwords(wordlist, stopwords, placeholder = '#'):
    replacefunction = (lambda x: placeholder if x in stopwords else x)
    return map(replacefunction, wordlist)