code review

Author: mattbriggs

students/briggsm/Term2_project/baselinter/baselinter/baselinter.py

@@ -1,14 +1,27 @@
-'''BaseLinter'''
+'''BaseLinter version 0.1
+Base Linter is a command-line interface app checks for sets of words in a text by order. 
+Each time the app encounters a word belonging to a set, it prompts you to choose which 
+of the words in the set. The app will replace the word in that position in the word 
+order in the text you are checking. When you are done, the app saved the updated text 
+as a file with the date in the filename.
+
+Matt Briggs 2018-02-24
+
+'''
 
 import json
 import datetime
 import os
+import baselinter as BS
+
+# Global Variables
 
-LOCATION = "D:\\UW\\Intro-to-Python\\IntroPython-2017\\students\\briggsm\\Term2_project\\baselinter\\baselinter\\" # os.path.dirname(os.path.realpath('__file__'))
 THISDATE = str(datetime.date.today()) # e:\MB\Better-Butter\Projects\BaseLinter
 LIST_of_SETS = []
 LINTER_NAME = ""
 
+# Functions
+
 
 def open_set_json(filename):
     '''Opens a JSON file and returns the a list of sets.'''
@@ -79,20 +92,27 @@ def select_update(choices, wordlist, wordloc):
 Select ----------------------------\n
 {}\n
 -----------------------------------\n
+N ) next  I ) ignore\n
 {}
 -----------------------------------
 """.format(display_string, display_choices))
-    choiceindex = input("Select an option. > ")
-    wordupdate = these_choices[int(choiceindex)-1]
-    wordlist[wordloc] = wordupdate
-    return wordlist
+    choosing = True
+    while (choosing == True):
+        choiceindex = input("Select an option. > ")
+        try:
+            wordupdate = these_choices[int(choiceindex)-1]
+            wordlist[wordloc] = wordupdate
+            return wordlist
+            choosing = False
+        except ValueError:
+            print ("Please type a valid option. \n")
+            choosing = True
 
 
 def load_linter():
     '''Load linters'''
     global LIST_of_SETS
     global LINTER_NAME
-    global LOCATION
 
     linters = { "American Homophone" : "\\data\\guide-amhomo.json",
                 "MS Docs Voice Guide" : "\\data\\guide-msdocs.json",
@@ -106,7 +126,7 @@ def load_linter():
     lint_choice = input("Select an option. > ")
     lint_choice = int(lint_choice) - 1
     LINTER_NAME = lint_list[lint_choice]
-    LIST_of_SETS = open_set_json(LOCATION + "\\" + linters[LINTER_NAME])
+    LIST_of_SETS = open_set_json(os.path.dirname(BS.__file__) +  linters[LINTER_NAME])
 
     return True
 
@@ -116,6 +136,7 @@ def exit_app():
     print("Goodbye.")
     return False
 
+
 def check_file():
     ''' '''
     try:
@@ -135,9 +156,6 @@ def check_file():
         f.write(outtext)
     return True
 
-
-
-
 chooser = {
     "1": ("Check file.", check_file),
     "2": ("Load new linter.", load_linter),
@@ -151,7 +169,8 @@ def main():
     global LIST_of_SETS
 
     LINTER_NAME = "American Homophone"
-    LIST_of_SETS = open_set_json(LOCATION + "\\data\\guide-amhomo.json")
+    
+    LIST_of_SETS = open_set_json(os.path.dirname(BS.__file__) + "\\data\\guide-amhomo.json")
 
     run = True
     while run == True:

students/briggsm/Term2_project/baselinter/baselinter/data/guide-businessjargon.json

@@ -1,44 +1,44 @@
 { 
-"7a548216-9301-43d1-af5b-77cc976a0eed" : ["actionable","**edit item :: actionable"], 
-"9bd390f6-2258-4240-a07d-cb3c6a216d32" : ["agreeance","**edit item :: agreeance"], 
-"3ce7f957-470a-4b08-a182-9522ab8858c1" : ["bandwidth","**edit item :: bandwidth"], 
-"c54911a5-b4c6-4414-a7c8-0868e897f966" : ["client-centered","**edit item :: client-centered"], 
-"164d20ed-6fc7-4010-bef2-09ade126b620" : ["CYA","**edit item :: CYA"], 
-"3dd40bc4-1e0f-46e9-9089-39a359686199" : ["going forward","**edit item :: going forward"], 
-"e0784322-bed2-425b-97df-f5fd48b01e63" : ["go rogue","**edit item :: go rogue"], 
-"e7001580-e2b9-4c48-b351-e62a723c26a9" : ["guesstimate","**edit item :: guesstimate"], 
-"b0bf2b70-d2df-4a4a-8880-db1dc6d7ed9e" : ["impact","**edit item :: impact"], 
-"ec515601-5aa9-4b4a-80ab-6345fb1eb73b" : ["incent","**edit item :: incent"], 
-"ecf801a1-7115-4dc6-ba7f-18aea6c2a3bc" : ["incentivize","**edit item :: incentivize"], 
-"317c9986-0817-4863-b2eb-389c8e2db71b" : ["impactful","**edit item :: impactful"], 
-"7193d135-7f14-4541-8e8b-04d64d1c36ad" : ["leverage","**edit item :: leverage"], 
-"086040a3-8240-4a9b-bc8c-55562fe77aa1" : ["liaise","**edit item :: liaise"], 
-"97873513-46d1-4352-85fd-24bd24bd9773" : ["mission-critical","**edit item :: mission-critical"], 
-"dd188923-2d91-48ca-bae0-b081e0b159d4" : ["monetize","**edit item :: monetize"], 
-"2bf760c2-b4d7-44eb-b248-27a213d35ce8" : ["net-net","**edit item :: net-net"], 
-"61dadc35-bd21-4ecf-b2b3-c984d09a1f64" : ["operationalize","**edit item :: operationalize"], 
-"caca5a35-5206-4088-8ac3-7675ee83018d" : ["optimize","**edit item :: optimize"], 
-"e5b977e6-9e47-4e0c-aee1-2109062f1bf3" : ["paradigm","**edit item :: paradigm"], 
-"0f44c71e-592a-498d-a402-31a8e479164f" : ["parameters","**edit item :: parameters"], 
-"d2a1fe8f-b3fe-4d41-8eb3-97999665cce5" : ["planfu","**edit item :: planfu"], 
-"a4871fd0-630e-4739-8d5f-222381ffc94f" : ["pursuant","**edit item :: pursuant"], 
-"b03dae0a-02ce-4185-bc79-103d775c0b37" : ["recontextualize","**edit item :: recontextualize"], 
-"1ce02721-02d3-4236-a73e-51da03aacbc1" : ["repurpose","**edit item :: repurpose"], 
-"f83176fe-3c88-4fe5-a1ed-77dcf3773f81" : ["rightsized","**edit item :: rightsized"], 
-"49ce5f29-0be3-4c63-92dc-6cebf4acb545" : ["sacred cow","**edit item :: sacred cow"], 
-"164abeb6-2ac7-4e0a-ac43-1745e44f39f3" : ["scalable","**edit item :: scalable"], 
-"89ecc5d0-da96-44a8-887d-71b5d8bbeb91" : ["seamless","**edit item :: seamless"], 
-"c2999f2f-3e45-4b00-8db3-019918b60d4e" : ["seismic","**edit item :: seismic"], 
-"f8b1dedf-b1a4-42c3-be88-7edf4cfa380d" : ["smartsized","**edit item :: smartsized"], 
-"fd511c6c-eb16-4ee8-905c-914b4cd26c96" : ["strategic","**edit item :: strategic"], 
-"81a5da6e-502c-4f30-a696-34c9d23eba16" : ["alliance","**edit item :: alliance"], 
-"19281354-320d-43ef-841e-0498035cbfd0" : ["dynamism","**edit item :: dynamism"], 
-"b4ad18fc-3a3d-44b2-8ed7-cfb5ab9cbe37" : ["synergize","**edit item :: synergize"], 
-"2796c91e-8734-4e3e-afeb-ac440ae26f07" : ["synergy","**edit item :: synergy"], 
-"cde15d85-15fa-4303-ac63-041c73497bcf" : ["turnkey","**edit item :: turnkey"], 
-"1dfb8b9c-3376-4afa-bd7f-6707456f2b34" : ["utilization","**edit item :: utilization"], 
+"7a548216-9301-43d1-af5b-77cc976a0eed" : ["actionable","**edit item :: actionable **"], 
+"9bd390f6-2258-4240-a07d-cb3c6a216d32" : ["agreeance","**edit item :: agreeance **"], 
+"3ce7f957-470a-4b08-a182-9522ab8858c1" : ["bandwidth","**edit item :: bandwidth **"], 
+"c54911a5-b4c6-4414-a7c8-0868e897f966" : ["client-centered","**edit item :: client-centered **"], 
+"164d20ed-6fc7-4010-bef2-09ade126b620" : ["CYA","**edit item :: CYA **"], 
+"3dd40bc4-1e0f-46e9-9089-39a359686199" : ["going forward","**edit item :: going forward **"], 
+"e0784322-bed2-425b-97df-f5fd48b01e63" : ["go rogue","**edit item :: go rogue **"], 
+"e7001580-e2b9-4c48-b351-e62a723c26a9" : ["guesstimate","**edit item :: guesstimate **"], 
+"b0bf2b70-d2df-4a4a-8880-db1dc6d7ed9e" : ["impact","**edit item :: impact **"], 
+"ec515601-5aa9-4b4a-80ab-6345fb1eb73b" : ["incent","**edit item :: incent **"], 
+"ecf801a1-7115-4dc6-ba7f-18aea6c2a3bc" : ["incentivize","**edit item :: incentivize **"], 
+"317c9986-0817-4863-b2eb-389c8e2db71b" : ["impactful","**edit item :: impactful **"], 
+"7193d135-7f14-4541-8e8b-04d64d1c36ad" : ["leverage","**edit item :: leverage **"], 
+"086040a3-8240-4a9b-bc8c-55562fe77aa1" : ["liaise","**edit item :: liaise **"], 
+"97873513-46d1-4352-85fd-24bd24bd9773" : ["mission-critical","**edit item :: mission-critical **"], 
+"dd188923-2d91-48ca-bae0-b081e0b159d4" : ["monetize","**edit item :: monetize **"], 
+"2bf760c2-b4d7-44eb-b248-27a213d35ce8" : ["net-net","**edit item :: net-net **"], 
+"61dadc35-bd21-4ecf-b2b3-c984d09a1f64" : ["operationalize","**edit item :: operationalize **"], 
+"caca5a35-5206-4088-8ac3-7675ee83018d" : ["optimize","**edit item :: optimize **"], 
+"e5b977e6-9e47-4e0c-aee1-2109062f1bf3" : ["paradigm","**edit item :: paradigm **"], 
+"0f44c71e-592a-498d-a402-31a8e479164f" : ["parameters","**edit item :: parameters **"], 
+"d2a1fe8f-b3fe-4d41-8eb3-97999665cce5" : ["planfu","**edit item :: planfu **"], 
+"a4871fd0-630e-4739-8d5f-222381ffc94f" : ["pursuant","**edit item :: pursuant **"], 
+"b03dae0a-02ce-4185-bc79-103d775c0b37" : ["recontextualize","**edit item :: recontextualize **"], 
+"1ce02721-02d3-4236-a73e-51da03aacbc1" : ["repurpose","**edit item :: repurpose **"], 
+"f83176fe-3c88-4fe5-a1ed-77dcf3773f81" : ["rightsized","**edit item :: rightsized **"], 
+"49ce5f29-0be3-4c63-92dc-6cebf4acb545" : ["sacred cow","**edit item :: sacred cow **"], 
+"164abeb6-2ac7-4e0a-ac43-1745e44f39f3" : ["scalable","**edit item :: scalable **"], 
+"89ecc5d0-da96-44a8-887d-71b5d8bbeb91" : ["seamless","**edit item :: seamless **"], 
+"c2999f2f-3e45-4b00-8db3-019918b60d4e" : ["seismic","**edit item :: seismic **"], 
+"f8b1dedf-b1a4-42c3-be88-7edf4cfa380d" : ["smartsized","**edit item :: smartsized **"], 
+"fd511c6c-eb16-4ee8-905c-914b4cd26c96" : ["strategic","**edit item :: strategic **"], 
+"81a5da6e-502c-4f30-a696-34c9d23eba16" : ["alliance","**edit item :: alliance **"], 
+"19281354-320d-43ef-841e-0498035cbfd0" : ["dynamism","**edit item :: dynamism "], 
+"b4ad18fc-3a3d-44b2-8ed7-cfb5ab9cbe37" : ["synergize","**edit item :: synergize **"], 
+"2796c91e-8734-4e3e-afeb-ac440ae26f07" : ["synergy","**edit item :: synergy **"], 
+"cde15d85-15fa-4303-ac63-041c73497bcf" : ["turnkey","**edit item :: turnkey **"], 
+"1dfb8b9c-3376-4afa-bd7f-6707456f2b34" : ["utilization","**edit item :: utilization **"], 
 "04e2f429-b5fc-4c2f-8d1e-6b71cc01ea28" : ["utilize","**edit item :: utilize"], 
-"ea4323d3-6b15-4632-bde4-25bc93fc7fa7" : ["value-added","**edit item :: value-added"], 
-"598d65fa-354e-4526-bdb5-df6f740ab2c4" : ["verbage","**edit item :: verbage"], 
-"7ac142b6-1669-4b2c-983b-fa3b75935df5" : ["win-win","**edit item :: win-win"] 
+"ea4323d3-6b15-4632-bde4-25bc93fc7fa7" : ["value-added","**edit item :: value-added **"], 
+"598d65fa-354e-4526-bdb5-df6f740ab2c4" : ["verbage","**edit item :: verbage **"], 
+"7ac142b6-1669-4b2c-983b-fa3b75935df5" : ["win-win","**edit item :: win-win **"] 
  } 

students/briggsm/Term2_project/baselinter/baselinter/dummy-txt-2018-02-20.txt

@@ -1,21 +1,20 @@
 '''Test for BaseLinter'''
 
 import json
+import os
 import datetime
 import mock
-import baselinter as BL
+import baselinter.baselinter as BS
 
 def test_open_set_json():
     '''Function returns a list of sets from a json file.'''
-    list_of_sets = BL.open_set_json("dummy-data.json")
+    list_of_sets = BS.open_set_json(os.path.dirname(BS.__file__) + "\\test\\dummy-data.json")
 
-    assert type(list_of_sets) == list
-    assert type(list_of_sets[0]) == set
-    assert list_of_sets[1] == {"mole", "vole"}
+    assert {"mole","vole"} == list_of_sets[0]
 
 def test_text_to_list():
     '''Function returns from a filename a list of words in order.'''
-    wordlist = BL.text_to_list("dummy-text.txt")
+    wordlist = BS.text_to_list(os.path.dirname(BS.__file__) + "\\test\\dummy-text.txt")
 
     assert len(wordlist) == 413
     assert wordlist[0] == "We"
@@ -24,7 +23,7 @@ def test_text_to_list():
 def test_wordlist_to_text():
     '''Function returns from a list of words in order a single string.'''
     test_list = ['We', 'got', 'up', 'at', 'four', 'in', 'the', 'morning,', 'that', 'first', 'day', 'in', 'the', 'east.']
-    out_text = BL.wordlist_to_text(test_list)
+    out_text = BS.wordlist_to_text(test_list)
 
     assert out_text == "We got up at four in the morning, that first day in the east."
 
@@ -33,8 +32,8 @@ def test_return_members():
     '''Function returns the set of an item if a member of the set, otherwise returns None.'''
     test_set = [{"that1", "that2", "that3"},{"mole", "vole"}]
 
-    assert BL.return_members(test_set, "mole") == {"mole", "vole"}
-    assert BL.return_members(test_set, "fig") == None
+    assert BS.return_members(test_set, "mole") == {"mole", "vole"}
+    assert BS.return_members(test_set, "fig") == None
 
 def test_select_update():
     '''Function returns an updated list'''

students/briggsm/Term2_project/baselinter/baselinter/loco.py

@@ -0,0 +1,2 @@
+{ "1A8C5C98-3306-4068-8CA8-302F3EF49A62": ["mole","vole"],
+    "61CA4EB1-E9C7-4913-8484-C6A26A594E61": ["marmot","lemming"] }

students/briggsm/Term2_project/baselinter/baselinter/test/baselinter_.py renamed to students/briggsm/Term2_project/baselinter/baselinter/test/baselinter_test.py

@@ -0,0 +1,32 @@
+We got up at four in the morning, that first day in the east. On the
+evening before we had climbed off a freight train at the edge of town,
+and with the true instinct of Kentucky boys had found our way across
+town and to the race track and the stables at once. Then we knew we
+were all right. Hanley Turner right away found a nigger we knew. It was
+Bildad Johnson who in the winter works at Ed Becker's livery barn in
+our home town, Beckersville. Bildad is a good cook as almost all our
+niggers are and of course he, like everyone in our part of Kentucky who
+is anyone at all, likes the horses. In the spring Bildad begins to
+scratch around. A nigger from our country can flatter and wheedle
+anyone into letting him do most anything he wants. Bildad wheedles the
+stable men and the trainers from the horse farms in our country around
+Lexington. The trainers come into town in the evening to stand around
+and talk and maybe get into a poker game. Bildad gets in with them. He
+is always doing little favors and telling about things to eat, chicken
+browned in a pan, and how is the best way to cook sweet potatoes and
+corn bread. It makes your mouth water to hear him.
+
+When the racing season comes on and the horses go to the races and
+there is all the talk on the streets in the evenings about the new
+colts, and everyone says when they are going over to Lexington or to
+the spring meeting at Churchhill Downs or to Latonia, and the horsemen
+that have been down to New Orleans or maybe at the winter meeting at
+Havana in Cuba come home to spend a week before they start out again,
+at such a time when everything talked about in Beckersville is just
+horses and nothing else and the outfits start out and horse racing is
+in every breath of air you breathe, Bildad shows up with a job as cook
+for some outfit. Often when I think about it, his always going all
+season to the races and working in the livery barn in the winter where
+horses are and where men like to come and talk about horses, I wish I
+was a nigger. It's a foolish thing to say, but that's the way I am
+about being around horses, just crazy. I can't help it.