changes in compliance with #205

Author: vishakha1812

_template_python/delphi_NAME/constants.py

@@ -0,0 +1,14 @@
+"""
+Registry for signal names
+"""
+
+
+FULL_TIME = "full_time_work_prop"
+PART_TIME = "part_time_work_prop"
+COVIDNET = "covidnet"
+
+SIGNALS = [
+    FULL_TIME,
+    PART_TIME,
+    COVIDNET
+]

_template_python/delphi_NAME/handle_wip_signal.py

@@ -5,7 +5,7 @@
 Created: 2020-08-07
 """
 
-from delphi_epidata import Epidata
+import covidcast
 
 
 def add_prefix(signal_names, wip_signal, prefix: str):
@@ -17,47 +17,46 @@ def add_prefix(signal_names, wip_signal, prefix: str):
     prefix : 'wip_'
         prefix for new/non public signals
     wip_signal : List[str] or bool
-        Either takes a list of wip signals: [], OR
-        incorporated all signals in the registry: True OR
-        no signals: False
+        a list of wip signals: [], OR
+        all signals in the registry: True OR
+        only signals that have never been published: False
     Returns
     -------
     List of signal names
         wip/non wip signals for further computation
     """
-    if wip_signal in ("", False):
-        return signal_names
-    elif wip_signal and isinstance(wip_signal, bool):
+
+    if wip_signal is True:
+        return [prefix + signal for signal in signal_names]
+    if isinstance(wip_signal, list):
+        make_wip = set(wip_signal)
+        return[
+            prefix + signal if signal in make_wip else signal
+            for signal in signal_names
+        ]
+    if wip_signal in {False, ""}:
         return [
-            (prefix + signal) if public_signal(signal)
-            else signal
+            signal if public_signal(signal)
+            else prefix + signal
             for signal in signal_names
         ]
-    elif isinstance(wip_signal, list):
-        for signal in wip_signal:
-            if public_signal(signal):
-                signal_names.append(prefix + signal)
-                signal_names.remove(signal)
-        return signal_names
-    else:
-        raise ValueError("Supply True | False or '' or [] | list()")
+    raise ValueError("Supply True | False or '' or [] | list()")
 
 
 def public_signal(signal_):
-    """Checks if the signal name is already public using Epidata
+    """Checks if the signal name is already public using COVIDcast
     Parameters
     ----------
     signal_ : str
         Name of the signal
     Returns
     -------
     bool
-        True if the signal is not present
-        False if the signal is present
+        True if the signal is present
+        False if the signal is not present
     """
-    epidata_df = Epidata.covidcast_meta()
-    for index in range(len(epidata_df['epidata'])):
-        if 'signal' in epidata_df['epidata'][index]:
-            if epidata_df['epidata'][index]['signal'] == signal_:
-                return False
-    return True
+    epidata_df = covidcast.metadata()
+    for index in range(len(epidata_df)):
+        if epidata_df['signal'][index] == signal_:
+            return True
+    return False

_template_python/delphi_NAME/run.py

@@ -6,14 +6,9 @@
 """
 from delphi_utils import read_params
 from .handle_wip_signal import add_prefix
+from .constants import SIGNALS
 
 # Sample signals
-SIGNALS = ["full_time_work_prop",
-           "covidnet",
-           "part_time_work_prop",
-           "completely_home_prop"
-           ]
-
 
 def run_module():
     """

_template_python/setup.py

@@ -7,7 +7,8 @@
     "pytest",
     "pytest-cov",
     "pylint",
-    "delphi-utils"
+    "delphi-utils",
+    "covidcast"
 ]
 
 setup(

_template_python/tests/params.json.template

@@ -1,5 +1,6 @@
 {
   "static_file_dir": "../static",
   "export_dir": "./receiving",
-  "cache_dir": "./cache"
+  "cache_dir": "./cache",
+  "wip_signal": ""
 }

_template_python/tests/test_handle_wip_signal.py

@@ -7,11 +7,16 @@
 
 
 def test_handle_wip_signal():
-    assert isinstance(wip_signal, (list, bool)) or wip_signal == "", "Supply True | False or "" or [] | list()"
-    if isinstance(wip_signal, list):
-        assert set(wip_signal).issubset(set(SIGNALS)), "signal in params don't belong in the registry"
-    updated_signal_names = add_prefix(SIGNALS, wip_signal, prefix='wip_')
-    assert (len(updated_signal_names) >= len(SIGNALS))
+    signal_names = add_prefix(SIGNALS, True, prefix="wip_")
+    assert all(s.startswith("wip_") for s in signal_names)
+    # Test wip_signal = list
+    signal_names = add_prefix(SIGNALS, [SIGNALS[0]], prefix="wip_")
+    assert signal_names[0].startswith("wip_")
+    assert all(not s.startswith("wip_") for s in signal_names[1:])
+    # Test wip_signal = False
+    signal_names = add_prefix(["xyzzy", SIGNALS[0]], False, prefix="wip_")
+    assert signal_names[0].startswith("wip_")
+    assert all(not s.startswith("wip_") for s in signal_names[1:])
 
 
 class MyTestCase(unittest.TestCase):