add argument parsing, fix program logic

[phrases.git] / phrases.py

diff --git a/phrases.py b/phrases.py
index 93f8a2f84375f06bc4dcb98ed4f3914ba68f7f12..63199d141d996cccc70d160ad3f71438f2909a32 100755 (executable)
--- a/phrases.py
+++ b/phrases.py
@@ -1,55 +1,86 @@
 #!/usr/bin/env python3
-# Display famous phrases in the terminal
+# Display Latin famous phrases in the terminal
 # Armaan Bhojwani 2020
 
+import argparse
+import csv
 import random
-import os
 import sys
-import re
 
-def _random_int(start, end):
-# Use system random if available, otherwise, use Python's
-    try:
-        r = random.SystemRandom()
-    except:
-        r = random
-
-    return r.randint(start, end)
-
-def _read_fortunes(fortune_file):
-    f = open(fortune_file, 'r')
-    contents = f.read()
-
-    lines = [line.rstrip() for line in contents.split('\n')]
-    delim = re.compile(r'^%$')
-    fortunes = []
-    cur = []
+def main(args=sys.argv[1:]):
+    # Argument parsing
+    parser = argparse.ArgumentParser(
+        description="Latin famous phrases in the terminal.")
+    parser.add_argument("-i", "--id",
+                        action='store_true',
+                        help="print the id of the phrase.")
+    parser.add_argument("-l", "--latin",
+                        action='store_true',
+                        help="print the Latin phrase (default)")
+    parser.add_argument("-e", "--english",
+                        action='store_true',
+                        help="print the English translation.")
+    parser.add_argument("-n", "--notes",
+                        action='store_true',
+                        help="print any notes on phrase")
+    parser.add_argument("-m", "--min",
+                        default=0,
+                        type=int,
+                        help="set the minimum length of the Latin phrase")
+    parser.add_argument("-M", "--max",
+                        default=10000000,
+                        type=int,
+                        help="set the maximum length of Latin phrase")
+    parser.add_argument("-p", "--num",
+                        action='store_true',
+                        help="print number of possibilities within constraints")
+    parser.add_argument("-f", "--file",
+                        default="/usr/share/phrases/phrases.csv",
+                        help="set the location of the phrase file")
+    args = parser.parse_args()
 
-    def save_if_nonempty(buf):
-        fortune = '\n'.join(buf)
-        if fortune.strip():
-            fortunes.append(fortune)
+    right_length = []
 
-    for line in lines:
-        if delim.match(line):
-            save_if_nonempty(cur)
-            cur = []
-            continue
+    # convert csv file into list
+    with open(args.file) as f:
+        reader = csv.reader(f)
+        next(reader, None) # skip header
+        all_lines = list(reader) 
+    f.close()
 
-        cur.append(line)
+    # iterate through all the phrases
+    for row in all_lines:
+        try: # generate a shortlist of phrases of the right length
+            if args.max >= int(row[4]) >= args.min:
+                right_length.append(row[0])
+        except: # skip malformed rows without exiting
+            pass
 
-    if cur:
-        save_if_nonempty(cur)
-
-    return fortunes
-
-def get_random_fortune(fortune_file):
-    fortunes = list(_read_fortunes(fortune_file))
-    randomRecord = _random_int(0, len(fortunes) - 1)
-    randFortune = fortunes[randomRecord]
-    return randFortune.partition('\n')[0]
+    try: # choose a random id from the shortlist
+        chosen = int(right_length[random.randint(0, len(right_length) - 1)])
+    except:
+        sys.exit("No phrase within the given parameters!")
 
-def main():
-    print(get_random_fortune("/usr/share/phrases/phrases"))
+    # Output as specified in flags
+    for row in all_lines:
+        if int(row[0]) == chosen:
+            if not (args.id
+                    or args.latin
+                    or args.english
+                    or args.notes
+                    or args.num):
+                print(row[1])
+            else:
+                if args.id:
+                    print(row[1])
+                if args.latin:
+                    print(row[1])
+                if args.english:
+                    print(row[2])
+                if args.notes:
+                    print(row[3])
+                if args.num:
+                    print(len(right_length))
 
-main()
+if __name__ == "__main__":
+    main()