Project 02

Author: lukemcguire

02_crowsnest/crowsnest.py

@@ -0,0 +1,35 @@
+#!/usr/bin/env python3
+"""
+Author : Oak Hopper
+Date   : 2024-06-17
+Purpose: Let the captain know what you see
+"""
+
+import argparse
+
+
+# --------------------------------------------------
+def get_args():
+    """Get command-line arguments"""
+    parser = argparse.ArgumentParser(
+        description="Alert the captain!",
+        formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+    )
+    parser.add_argument("word", metavar="word", help="The thing we see")
+    return parser.parse_args()
+
+
+# --------------------------------------------------
+def main():
+    """Make a jazz noise here"""
+
+    args = get_args()
+    word: str = args.word
+    article: str = "an" if word[0].lower() in "aeiou" else "a"
+    shout: str = "Ahoy, Captain, {} {} off the larboard bow!"
+    print(shout.format(article.title() if word[0].isupper() else article, word))
+
+
+# --------------------------------------------------
+if __name__ == "__main__":
+    main()

02_crowsnest/test.py

@@ -4,65 +4,82 @@
 import os
 from subprocess import getstatusoutput, getoutput
 
-prg = './crowsnest.py'
+PRG = "./crowsnest.py"
 consonant_words = [
-    'brigantine', 'clipper', 'dreadnought', 'frigate', 'galleon', 'haddock',
-    'junk', 'ketch', 'longboat', 'mullet', 'narwhal', 'porpoise', 'quay',
-    'regatta', 'submarine', 'tanker', 'vessel', 'whale', 'xebec', 'yatch',
-    'zebrafish'
+    "brigantine",
+    "clipper",
+    "dreadnought",
+    "frigate",
+    "galleon",
+    "haddock",
+    "junk",
+    "ketch",
+    "longboat",
+    "mullet",
+    "narwhal",
+    "porpoise",
+    "quay",
+    "regatta",
+    "submarine",
+    "tanker",
+    "vessel",
+    "whale",
+    "xebec",
+    "yacht",
+    "zebrafish",
 ]
-vowel_words = ['aviso', 'eel', 'iceberg', 'octopus', 'upbound']
-template = 'Ahoy, Captain, {} {} off the larboard bow!'
+vowel_words = ["aviso", "eel", "iceberg", "octopus", "upbound"]
+TEMPLATE = "Ahoy, Captain, {} {} off the larboard bow!"
 
 
 # --------------------------------------------------
 def test_exists():
     """exists"""
 
-    assert os.path.isfile(prg)
+    assert os.path.isfile(PRG)
 
 
 # --------------------------------------------------
 def test_usage():
     """usage"""
 
-    for flag in ['-h', '--help']:
-        rv, out = getstatusoutput(f'{prg} {flag}')
+    for flag in ["-h", "--help"]:
+        rv, out = getstatusoutput(f"python3 {PRG} {flag}")
         assert rv == 0
-        assert out.lower().startswith('usage')
+        assert out.lower().startswith("usage")
 
 
 # --------------------------------------------------
 def test_consonant():
     """brigantine -> a brigantine"""
 
     for word in consonant_words:
-        out = getoutput(f'{prg} {word}')
-        assert out.strip() == template.format('a', word)
+        out = getoutput(f"python3 {PRG} {word}")
+        assert out.strip() == TEMPLATE.format("a", word)
 
 
 # --------------------------------------------------
 def test_consonant_upper():
     """brigantine -> a Brigatine"""
 
     for word in consonant_words:
-        out = getoutput(f'{prg} {word.title()}')
-        assert out.strip() == template.format('a', word.title())
+        out = getoutput(f"python3 {PRG} {word.title()}")
+        assert out.strip() == TEMPLATE.format("A", word.title())
 
 
 # --------------------------------------------------
 def test_vowel():
     """octopus -> an octopus"""
 
     for word in vowel_words:
-        out = getoutput(f'{prg} {word}')
-        assert out.strip() == template.format('an', word)
+        out = getoutput(f"python3 {PRG} {word}")
+        assert out.strip() == TEMPLATE.format("an", word)
 
 
 # --------------------------------------------------
 def test_vowel_upper():
     """octopus -> an Octopus"""
 
     for word in vowel_words:
-        out = getoutput(f'{prg} {word.upper()}')
-        assert out.strip() == template.format('an', word.upper())
+        out = getoutput(f"python3 {PRG} {word.upper()}")
+        assert out.strip() == TEMPLATE.format("An", word.upper())