test: bring unit tests up to current standards

Author: davidlday

tests/test_cmudict.py

@@ -1,10 +1,9 @@
-# -*- coding: utf-8 -*-
-
+# pylint: disable=missing-docstring
 import cmudict
 
 
 def test_dict_stream():
-    EXPECTED_LENGTH = 135166
+    expected_length = 135166
     # borrowed from pronouncingpy to ensure compatibility
     pronunciations = list()
     filehandle = cmudict.dict_stream()
@@ -15,24 +14,22 @@ def test_dict_stream():
         word, phones = line.split(" ", 1)
         pronunciations.append((word.split("(", 1)[0].lower(), phones))
     filehandle.close()
-    assert len(pronunciations) == EXPECTED_LENGTH
+    assert len(pronunciations) == expected_length
 
 
 def test_dict_string():
-    EXPECTED_LENGTH = 3618488
+    expected_length = 3618488
     dict_string = cmudict.dict_string()
-    LENGTH = len(dict_string)
-    if EXPECTED_LENGTH != LENGTH:
+    actual_length = len(dict_string)
+    if expected_length != actual_length:
         raise AssertionError(
-            "cmudict.dict_string(): Expected {0} length, got {1}.".format(
-                EXPECTED_LENGTH, LENGTH
-            )
+            f"cmudict.dict_string(): Expected {expected_length} length, got {actual_length}."
         )
 
 
 def test_dict_comments():
-    DICT = cmudict.dict()
-    EXPECTED_DICT = {
+    actual_dict = cmudict.dict()
+    expected_dict = {
         "d'artagnan": [["D", "AH0", "R", "T", "AE1", "NG", "Y", "AH0", "N"]],
         "danglar": [["D", "AH0", "NG", "L", "AA1", "R"]],
         "danglars": [["D", "AH0", "NG", "L", "AA1", "R", "Z"]],
@@ -41,86 +38,79 @@ def test_dict_comments():
         "porthos": [["P", "AO0", "R", "T", "AO1", "S"]],
         "spieth": [["S", "P", "IY1", "TH"], ["S", "P", "AY1", "AH0", "TH"]],
     }
-    for TEST_WORD in EXPECTED_DICT:
-        EXPECTED_PRONOUNCIATION = EXPECTED_DICT[TEST_WORD]
-        PRONUNCIATION = DICT[TEST_WORD]
-        if EXPECTED_PRONOUNCIATION != PRONUNCIATION:
+    for test_word, expected_pronunciation in expected_dict.items():
+        actual_pronunciation = actual_dict[test_word]
+        if expected_pronunciation != actual_pronunciation:
             raise AssertionError(
-                'cmudict.dict(): Expected "{0}", got "{1}".'.format(
-                    EXPECTED_PRONOUNCIATION, PRONUNCIATION
-                )
+                f"""
+                cmudict.dict(): Expected "{expected_pronunciation}", got "{actual_pronunciation}".
+                """
             )
 
 
 def test_phones():
-    EXPECTED_SIZE = 39
+    expected_size = 39
     phones = cmudict.phones()
-    SIZE = len(phones)
-    if EXPECTED_SIZE != SIZE:
+    actual_size = len(phones)
+    if expected_size != actual_size:
         raise AssertionError(
-            "cmudict.phones(): Expected {0} keys, got {1}.".format(EXPECTED_SIZE, SIZE)
+            f"cmudict.phones(): Expected {expected_size} keys, got {actual_size}."
         )
 
 
 def test_phones_string():
-    EXPECTED_LENGTH = 382
+    expected_length = 382
     phones_string = cmudict.phones_string()
-    LENGTH = len(phones_string)
-    if EXPECTED_LENGTH != LENGTH:
+    actual_length = len(phones_string)
+    if expected_length != actual_length:
         raise AssertionError(
-            "cmudict.phones_string(): Expected {0} length, got {1}.".format(
-                EXPECTED_LENGTH, LENGTH
-            )
+            f"cmudict.phones_string(): Expected {expected_length} length, got {actual_length}."
         )
 
 
 def test_symbols():
-    EXPECTED_SIZE = 84
+    expected_size = 84
     symbols = cmudict.symbols()
-    SIZE = len(symbols)
-    if EXPECTED_SIZE != SIZE:
+    actual_size = len(symbols)
+    if expected_size != actual_size:
         raise AssertionError(
-            "cmudict.symbols(): Expected {0} keys, got {1}.".format(EXPECTED_SIZE, SIZE)
+            f"cmudict.symbols(): Expected {expected_size} keys, got {actual_size}."
         )
 
 
 def test_symbols_string():
-    EXPECTED_LENGTH = 281
+    expected_length = 281
     symbols_string = cmudict.symbols_string()
-    LENGTH = len(symbols_string)
-    if EXPECTED_LENGTH != LENGTH:
+    actual_length = len(symbols_string)
+    if expected_length != actual_length:
         raise AssertionError(
-            "cmudict.symbols_string(): Expected {0} length, got {1}.".format(
-                EXPECTED_LENGTH, LENGTH
-            )
+            f"cmudict.symbols_string(): Expected {expected_length} length, got {actual_length}."
         )
 
 
 def test_vp():
-    EXPECTED_SIZE = 52
+    expected_size = 52
     vp = cmudict.vp()
-    SIZE = len(vp)
-    if EXPECTED_SIZE != SIZE:
+    actual_size = len(vp)
+    if expected_size != actual_size:
         raise AssertionError(
-            "cmudict.vp(): Expected {0} keys, got {1}.".format(EXPECTED_SIZE, SIZE)
+            f"cmudict.vp(): Expected {expected_size} keys, got {actual_size}."
         )
 
 
 def test_vp_string():
-    EXPECTED_LENGTH = 1747
+    expected_length = 1747
     vp_string = cmudict.vp_string()
-    LENGTH = len(vp_string)
-    if EXPECTED_LENGTH != LENGTH:
+    actual_length = len(vp_string)
+    if expected_length != actual_length:
         raise AssertionError(
-            "cmudict.vp_string(): Expected {0} length, got {1}.".format(
-                EXPECTED_LENGTH, LENGTH
-            )
+            f"cmudict.vp_string(): Expected {expected_length} length, got {actual_length}."
         )
 
 
 def test_vp_comments():
-    VP = cmudict.vp()
-    EXPECTED_VP = {
+    actual_vp = cmudict.vp()
+    expected_vp = {
         "!exclamation-point": [
             [
                 "EH2",
@@ -226,24 +216,21 @@ def test_vp_comments():
         "'quote": [["K", "W", "OW1", "T"]],
         "'apostrophe": [["AH0", "P", "AA1", "S", "T", "R", "AH0", "F", "IY0"]],
     }
-    for PUNCTUATION in EXPECTED_VP:
-        EXPECTED_PRONOUNCIATION = EXPECTED_VP[PUNCTUATION]
-        PRONUNCIATION = VP[PUNCTUATION]
-        if EXPECTED_PRONOUNCIATION != PRONUNCIATION:
+    for test_punctuation, expected_pronounciation in expected_vp.items():
+        actual_pronounciation = actual_vp[test_punctuation]
+        if expected_pronounciation != actual_pronounciation:
             raise AssertionError(
-                'cmudict.vp(): Expected "{0}", got "{1}".'.format(
-                    EXPECTED_PRONOUNCIATION, PRONUNCIATION
-                )
+                f"""
+                cmudict.vp(): Expected "{expected_pronounciation}", got "{actual_pronounciation}".
+                """
             )
 
 
 def test_license_string():
-    EXPECTED_LENGTH = 1754
+    expected_length = 1754
     license_string = cmudict.license_string()
-    LENGTH = len(license_string)
-    if EXPECTED_LENGTH != LENGTH:
+    actual_length = len(license_string)
+    if expected_length != actual_length:
         raise AssertionError(
-            "cmudict.license_string(): Expected {0} length, got {1}.".format(
-                EXPECTED_LENGTH, LENGTH
-            )
+            f"cmudict.license_string(): Expected {expected_length} length, got {actual_length}."
         )