Merge pull request glamp#17 from iiSeymour/refactor

Some refactoring

Author: glamp

bashplotlib/histogram.py

@@ -1,15 +1,23 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
 
+"""
+Plotting terminal based histograms
+"""
+
+import os
+import sys
 import math
 import optparse
-import os
 from os.path import dirname
-import sys
-from utils.helpers import *
-from utils.commandhelp import hist
+from .utils.helpers import *
+from .utils.commandhelp import hist
+
 
 def calc_bins(n, min_val, max_val, h=None, binwidth=None):
-    "calculate number of bins for the histogram"
+    """
+    Calculate number of bins for the histogram
+    """
     if not h:
         h = max(10, math.log(n + 1, 2))
     if binwidth == 0:
@@ -22,15 +30,17 @@ def calc_bins(n, min_val, max_val, h=None, binwidth=None):
         else:
             yield b
 
+
 def read_numbers(numbers):
-    "read the input data in the most optimal way"
+    """
+    Read the input data in the most optimal way
+    """
     if isinstance(numbers, list):
-        for n in numbers:
-            n = str(n)
-            yield float(n.strip())
+        for number in numbers:
+            yield float(str(number).strip())
     else:
-        for n in open(numbers):
-            yield float(n.strip())
+        for number in open(numbers):
+            yield float(number.strip())
 
 
 def run_demo():
@@ -53,8 +63,8 @@ def run_demo():
     plot_hist(demo_file)
     print "*" * 80
 
-    #with colors
-    print "histogram with colors"
+    #with colours
+    print "histogram with colours"
     print "plot_hist('%s', colour='blue')" % demo_file
     print "hist -f %s -c blue" % demo_file
     plot_hist(demo_file, colour='blue')
@@ -74,10 +84,11 @@ def run_demo():
     plot_hist(demo_file, height=35.0, bincount=40)
 
 
-def plot_hist(f, height=20.0, bincount=None, binwidth=None, pch="o", colour="white", title="", xlab=None, showSummary=False, regular=False):
-    """make a histogram
+def plot_hist(f, height=20.0, bincount=None, binwidth=None, pch="o", colour="default", title="", xlab=None, showSummary=False, regular=False):
+    """
+    Make a histogram
 
-        Keyword arguments:
+    Arguments:
         height -- the height of the histogram in # of lines
         bincount -- number of bins in the histogram
         binwidth -- width of bins in the histogram
@@ -88,28 +99,25 @@ def plot_hist(f, height=20.0, bincount=None, binwidth=None, pch="o", colour="whi
         showSummary -- boolean value for whether or not to display a summary
         regular -- boolean value for whether or not to start y-labels at 0
     """
-
     if pch is None:
         pch = "o"
 
-    colour = get_colour(colour)
-
     min_val, max_val = None, None
-    n, mean = 0., 0.
+    n, mean = 0.0, 0.0
+
     for number in read_numbers(f):
         n += 1
-
-        if (min_val is None) or (number < min_val):
+        if min_val is None or number < min_val:
             min_val = number
-        if (max_val is None) or (number > max_val):
+        if max_val is None or number > max_val:
             max_val = number
         mean += number
+
     mean /= n
 
     bins = list(calc_bins(n, min_val, max_val, bincount, binwidth))
-    hist = {}
-    for i in range(len(bins)):
-        hist[i] = 0
+    hist = {i: 0 for i in range(len(bins))}
+
     for number in read_numbers(f):
         for i, b in enumerate(bins):
             if number <= b:
@@ -122,6 +130,7 @@ def plot_hist(f, height=20.0, bincount=None, binwidth=None, pch="o", colour="whi
 
     start = max(min_y, 1)
     stop = max_y + 1
+
     if regular:
         start = 1
 
@@ -138,6 +147,7 @@ def plot_hist(f, height=20.0, bincount=None, binwidth=None, pch="o", colour="whi
     if title:
         print box_text(title, max(len(hist)*2, len(title)), nlen)
     print
+
     used_labs = set()
     for y in ys:
         ylab = str(int(y))
@@ -151,67 +161,63 @@ def plot_hist(f, height=20.0, bincount=None, binwidth=None, pch="o", colour="whi
 
         for i in range(len(hist)):
             if int(y) <= hist[i]:
-                printcolor(pch, True, colour)
+                printcolour(pch, True, colour)
             else:
-                printcolor(" ", True, colour)
+                printcolour(" ", True, colour)
         print
     xs = hist.keys() * 2
 
-    print " "*(nlen+1) + "-"*len(xs)
-
+    print " " * (nlen+1) + "-" * len(xs)
 
     if xlab:
         xlen = len(str(float((max_y)/height) + max_y))
         for i in range(0, xlen):
-            printcolor(" "*(nlen+1), True, colour)
+            printcolour(" " * (nlen+1), True, colour)
             for x in range(0, len(hist)):
                 num = str(bins[x])
-                if x%2==0:
+                if x % 2 == 0:
                     print " ",
                 elif i < len(num):
                     print num[i],
                 else:
                     print " ",
             print
+
     center = max(map(len, map(str, [n, min_val, mean, max_val])))
     center += 15
 
     if showSummary:
         print
-        print "-"*(2 + center)
+        print "-" * (2 + center)
         print "|" + "Summary".center(center) + "|"
-        print "-"*(2 + center)
+        print "-" * (2 + center)
         summary = "|" + ("observations: %d" % n).center(center) + "|\n"
         summary += "|" + ("min value: %f" % min_val).center(center) + "|\n"
         summary += "|" + ("mean : %f" % mean).center(center) + "|\n"
         summary += "|" + ("max value: %f" % max_val).center(center) + "|\n"
-        summary += "-"*(2 + center)
+        summary += "-" * (2 + center)
         print summary
 
 
 def main():
 
     parser = optparse.OptionParser(usage=hist['usage'])
 
-    parser.add_option('-f', '--file', help='a file containing a column of numbers',
-                      default=None, dest='f')
-    parser.add_option('-t', '--title', help='title for the chart',
-                      default="", dest='t')
-    parser.add_option('-b', '--bins', help='number of bins in the histogram',
-                      type='int', default=None, dest='b')
-    parser.add_option('-w', '--binwidth', help='width of bins in the histogram',
-                      type='float', default=None, dest='binwidth')
-    parser.add_option('-s', '--height', help='height of the histogram (in lines)',
-                      type='int', default=None, dest='h')
+    parser.add_option('-f', '--file', help='a file containing a column of numbers', default=None, dest='f')
+    parser.add_option('-t', '--title', help='title for the chart', default="", dest='t')
+    parser.add_option('-b', '--bins', help='number of bins in the histogram', type='int', default=None, dest='b')
+    parser.add_option('-w', '--binwidth', help='width of bins in the histogram', type='float', default=None, dest='binwidth')
+    parser.add_option('-s', '--height', help='height of the histogram (in lines)', type='int', default=None, dest='h')
     parser.add_option('-p', '--pch', help='shape of each bar', default='o', dest='p')
     parser.add_option('-x', '--xlab', help='label bins on x-axis', default=None, action="store_true", dest='x')
-    parser.add_option('-c', '--colour', help='colour of the plot (%s)' % ", ".join([c for c in bcolours.keys() if c != 'ENDC']),
-                      default='white', dest='colour')
+    parser.add_option('-c', '--colour', help='colour of the plot (%s)' % colour_help, default='default', dest='colour')
     parser.add_option('-d', '--demo', help='run demos', action='store_true', dest='demo')
     parser.add_option('-n', '--nosummary', help='hide summary', action='store_false', dest='showSummary', default=True)
-    parser.add_option('-r', '--regular', help='use regular y-scale (0 - maximum y value), instead of truncated y-scale (minimum y-value - maximum y-value)', default=False, action="store_true", dest='regular')
+    parser.add_option('-r', '--regular',
+                      help='use regular y-scale (0 - maximum y value), instead of truncated y-scale (minimum y-value - maximum y-value)',
+                      default=False, action="store_true", dest='regular')
 
-    (opts, args) = parser.parse_args()
+    opts, args = parser.parse_args()
 
     if opts.f is None:
         if len(args) > 0:
@@ -227,5 +233,5 @@ def main():
         print "nothing to plot!"
 
 
-if __name__=="__main__":
+if __name__ == "__main__":
     main()

bashplotlib/scatterplot.py

@@ -1,10 +1,15 @@
 #!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Plotting terminal based scatterplots
+"""
 
 import csv
-import optparse
 import sys
-from utils.helpers import *
-from utils.commandhelp import scatter 
+import optparse
+from .utils.helpers import *
+from .utils.commandhelp import scatter 
 
 
 def get_scale(series, is_y=False, steps=20):
@@ -20,10 +25,12 @@ def get_scale(series, is_y=False, steps=20):
         scaled_series.reverse()
     return scaled_series
 
+
 def plot_scatter(f, xs, ys, size, pch, colour, title):
-    """Form a complex number.
+    """
+    Form a complex number.
     
-        Arguments:
+    Arguments:
         f -- comma delimited file w/ x,y coordinates
         xs -- if f not specified this is a file w/ x coordinates
         ys -- if f not specified this is a filew / y coordinates
@@ -44,14 +51,12 @@ def plot_scatter(f, xs, ys, size, pch, colour, title):
         xs = [float(str(row).strip()) for row in open(xs)]
         ys = [float(str(row).strip()) for row in open(ys)]
 
-    colour = get_colour(colour)
-
     plotted = set()
 
     if title:
         print box_text(title, 2*len(get_scale(xs, False, size))+1)
 
-    print "-"*(2*len(get_scale(xs, False, size))+2)
+    print "-" * (2*len(get_scale(xs, False, size))+2)
     for y in get_scale(ys, True, size):
         print "|",
         for x in get_scale(xs, False, size):
@@ -67,30 +72,24 @@ def plot_scatter(f, xs, ys, size, pch, colour, title):
                 point = "|"
             elif y==0:
                 point = "-"
-            printcolor(point, True, colour)
+            printcolour(point, True, colour)
         print "|"
     print "-"*(2*len(get_scale(xs, False, size))+2)
 
 
 def main():
 
     parser = optparse.OptionParser(usage=scatter['usage'])
-    parser.add_option('-f', '--file', help='a csv w/ x and y coordinates',
-                      default=None, dest='f')
-    parser.add_option('-t', '--title', help='title for the chart',
-                          default="", dest='t')
-    parser.add_option('-x', help='x coordinates',
-                      default=None, dest='x')
-    parser.add_option('-y', help='y coordinates',
-                      default=None, dest='y')
-    parser.add_option('-s', '--size',help='y coordinates',
-                      default=20, dest='size', type='int')
-    parser.add_option('-p', '--pch',help='shape of point',
-                      default="x", dest='pch') 
-    parser.add_option('-c', '--colour', help='colour of the plot (%s)' % ", ".join(bcolours.keys()),
-                      default='white', dest='colour')
-
-    (opts, args) = parser.parse_args()
+
+    parser.add_option('-f', '--file', help='a csv w/ x and y coordinates', default=None, dest='f')
+    parser.add_option('-t', '--title', help='title for the chart', default="", dest='t')
+    parser.add_option('-x', help='x coordinates', default=None, dest='x')
+    parser.add_option('-y', help='y coordinates', default=None, dest='y')
+    parser.add_option('-s', '--size',help='y coordinates', default=20, dest='size', type='int')
+    parser.add_option('-p', '--pch',help='shape of point', default="x", dest='pch') 
+    parser.add_option('-c', '--colour', help='colour of the plot (%s)' % colour_help, default='default', dest='colour')
+
+    opts, args = parser.parse_args()
 
     if opts.f is None and (opts.x is None or opts.y is None):
         opts.f = sys.stdin.readlines()

bashplotlib/utils/commandhelp.py

@@ -1,24 +1,28 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""
+Usage messages for bashplotlib system commands
+"""
 
 hist = {
     "usage": """hist is a command for making histograms. it accepts a series of values in one of the following formats:
         1) txt file w/ 1 column of numbers
-        2) standard in piped from another command line cat or curl    
-    
+        2) standard in piped from another command line cat or curl
+
     for some examples of how to use hist, you can type the command:
         hist --demo
     or visit https://github.com/glamp/bashplotlib/blob/master/examples/sample.sh
     """
 }
 
 scatter = {
-    "usage": """scatterplot is a command for making xy plots. it accepts a series of x values and a series of y values in the 
+    "usage": """scatterplot is a command for making xy plots. it accepts a series of x values and a series of y values in the
     following formats:
         1) a txt file or standard in value w/ 2 comma seperated columns of x,y values
         2) 2 txt files. 1 w/ designated x values and another with designated y values.
-    
+
     scatter -x <xcoords> -y <ycoords>
     cat <file_with_x_and_y_coords> | scatter
-
     """
 }
-