Structural Pattern applied

Author: Hankun Li

app/services/location/__init__.py

@@ -1,28 +1,20 @@
 """app.services.location"""
-from abc import ABC, abstractmethod
 
-
-class LocationService(ABC):
+class LocationService:
     """
     Service for retrieving locations.
     """
 
-    @abstractmethod
     async def get_all(self):
-        """
-        Gets and returns all of the locations.
+        # Get the locations.
+        locations = await get_locations()
+        return locations
 
-        :returns: The locations.
-        :rtype: List[Location]
-        """
-        raise NotImplementedError
+    async def get(self, loc_id):  # pylint: disable=arguments-differ
+        # Get location at the index equal to the provided id.
+        locations = await self.get_all()
+        return locations[loc_id]
 
     @abstractmethod
-    async def get(self, id):  # pylint: disable=redefined-builtin,invalid-name
-        """
-        Gets and returns location with the provided id.
-
-        :returns: The location.
-        :rtype: Location
-        """
-        raise NotImplementedError
+    async def get_locations():
+        raise NotImplementedError

app/services/location/csbs.py

@@ -19,84 +19,74 @@ class CSBSLocationService(LocationService):
     """
     Service for retrieving locations from csbs
     """
-
-    async def get_all(self):
-        # Get the locations.
-        locations = await get_locations()
-        return locations
-
-    async def get(self, loc_id):  # pylint: disable=arguments-differ
-        # Get location at the index equal to the provided id.
-        locations = await self.get_all()
-        return locations[loc_id]
-
-
+    def __init__(self):
+        super().__init__()
 # Base URL for fetching data
-BASE_URL = "https://facts.csbs.org/covid-19/covid19_county.csv"
-
-
-@cached(cache=TTLCache(maxsize=1, ttl=1800))
-async def get_locations():
-    """
-    Retrieves county locations; locations are cached for 1 hour
-
-    :returns: The locations.
-    :rtype: dict
-    """
-    data_id = "csbs.locations"
-    LOGGER.info(f"{data_id} Requesting data...")
-    # check shared cache
-    cache_results = await check_cache(data_id)
-    if cache_results:
-        LOGGER.info(f"{data_id} using shared cache results")
-        locations = cache_results
-    else:
-        LOGGER.info(f"{data_id} shared cache empty")
-        async with httputils.CLIENT_SESSION.get(BASE_URL) as response:
-            text = await response.text()
-
-        LOGGER.debug(f"{data_id} Data received")
-
-        data = list(csv.DictReader(text.splitlines()))
-        LOGGER.debug(f"{data_id} CSV parsed")
-
-        locations = []
-
-        for i, item in enumerate(data):
-            # General info.
-            state = item["State Name"]
-            county = item["County Name"]
-
-            # Ensure country is specified.
-            if county in {"Unassigned", "Unknown"}:
-                continue
-
-            # Date string without "EDT" at end.
-            last_update = " ".join(item["Last Update"].split(" ")[0:2])
-
-            # Append to locations.
-            locations.append(
-                CSBSLocation(
-                    # General info.
-                    i,
-                    state,
-                    county,
-                    # Coordinates.
-                    Coordinates(item["Latitude"], item["Longitude"]),
-                    # Last update (parse as ISO).
-                    datetime.strptime(last_update, "%Y-%m-%d %H:%M").isoformat() + "Z",
-                    # Statistics.
-                    int(item["Confirmed"] or 0),
-                    int(item["Death"] or 0),
+    BASE_URL = "https://facts.csbs.org/covid-19/covid19_county.csv"
+
+
+    @cached(cache=TTLCache(maxsize=1, ttl=1800))
+    async def get_locations():
+        """
+        Retrieves county locations; locations are cached for 1 hour
+
+        :returns: The locations.
+        :rtype: dict
+        """
+        data_id = "csbs.locations"
+        LOGGER.info(f"{data_id} Requesting data...")
+        # check shared cache
+        cache_results = await check_cache(data_id)
+        if cache_results:
+            LOGGER.info(f"{data_id} using shared cache results")
+            locations = cache_results
+        else:
+            LOGGER.info(f"{data_id} shared cache empty")
+            async with httputils.CLIENT_SESSION.get(BASE_URL) as response:
+                text = await response.text()
+
+            LOGGER.debug(f"{data_id} Data received")
+
+            data = list(csv.DictReader(text.splitlines()))
+            LOGGER.debug(f"{data_id} CSV parsed")
+
+            locations = []
+
+            for i, item in enumerate(data):
+                # General info.
+                state = item["State Name"]
+                county = item["County Name"]
+
+                # Ensure country is specified.
+                if county in {"Unassigned", "Unknown"}:
+                    continue
+
+                # Date string without "EDT" at end.
+                last_update = " ".join(item["Last Update"].split(" ")[0:2])
+
+                # Append to locations.
+                locations.append(
+                    CSBSLocation(
+                        # General info.
+                        i,
+                        state,
+                        county,
+                        # Coordinates.
+                        Coordinates(item["Latitude"], item["Longitude"]),
+                        # Last update (parse as ISO).
+                        datetime.strptime(last_update, "%Y-%m-%d %H:%M").isoformat() + "Z",
+                        # Statistics.
+                        int(item["Confirmed"] or 0),
+                        int(item["Death"] or 0),
+                    )
                 )
-            )
-        LOGGER.info(f"{data_id} Data normalized")
-        # save the results to distributed cache
-        # TODO: fix json serialization
-        try:
-            await load_cache(data_id, locations)
-        except TypeError as type_err:
-            LOGGER.error(type_err)
-
-    # Return the locations.
-    return locations
+            LOGGER.info(f"{data_id} Data normalized")
+            # save the results to distributed cache
+            # TODO: fix json serialization
+            try:
+                await load_cache(data_id, locations)
+            except TypeError as type_err:
+                LOGGER.error(type_err)
+
+        # Return the locations.
+        return locations