Convert the Coordinates class to a pydantic model

As requested by Kilo59.

It still passed all the unit test, which is good. :)

Author: wu-geoff

app/coordinates.py

@@ -1,23 +1,14 @@
 """app.coordinates.py"""
+from pydantic import BaseModel
 
 
-class Coordinates:
+class Coordinates(BaseModel):
     """
     A position on earth using decimal coordinates (latitude and longitude).
     """
 
-    def __init__(self, latitude, longitude):
-        self._latitude = latitude
-        self._longitude = longitude
-
-    def serialize(self):
-        """
-        Serializes the coordinates into a dict.
-
-        :returns: The serialized coordinates.
-        :rtype: dict
-        """
-        return {"latitude": self._latitude, "longitude": self._longitude}
+    latitude: float = None
+    longitude: float = None
 
     def __str__(self):
-        return "lat: %s, long: %s" % (self._latitude, self._longitude)
+        return "lat: %s, long: %s" % (self.latitude, self.longitude)

app/location/__init__.py

@@ -62,7 +62,7 @@ def serialize(self):
             "country_population": self.country_population,
             "province": self.province,
             # Coordinates.
-            "coordinates": self.coordinates.serialize(),
+            "coordinates": self.coordinates.dict(),
             # Last updated.
             "last_updated": self.last_updated,
             # Latest data (statistics).

app/services/location/csbs.py

@@ -82,7 +82,7 @@ async def get_locations():
                     state,
                     county,
                     # Coordinates.
-                    Coordinates(item["Latitude"], item["Longitude"]),
+                    Coordinates(latitude=item["Latitude"], longitude=item["Longitude"]),
                     # Last update (parse as ISO).
                     datetime.strptime(last_update, "%Y-%m-%d %H:%M").isoformat() + "Z",
                     # Statistics.

app/services/location/jhu.py

@@ -169,6 +169,7 @@ async def get_locations():
 
         # Grab coordinates.
         coordinates = location["coordinates"]
+        # print(coordinates)
 
         # Create location (supporting timelines) and append.
         locations.append(
@@ -178,7 +179,9 @@ async def get_locations():
                 location["country"],
                 location["province"],
                 # Coordinates.
-                Coordinates(latitude=coordinates["lat"], longitude=coordinates["long"]),
+                Coordinates(
+                    latitude=coordinates["lat"] or None, longitude=coordinates["long"] or None
+                ),
                 # Last update.
                 datetime.utcnow().isoformat() + "Z",
                 # Timelines (parse dates as ISO).

app/services/location/nyt.py

@@ -115,7 +115,7 @@ async def get_locations():
                     id=idx,
                     state=county_state[1],
                     county=county_state[0],
-                    coordinates=Coordinates(None, None),  # NYT does not provide coordinates
+                    coordinates=Coordinates(),  # NYT does not provide coordinates
                     last_updated=datetime.utcnow().isoformat() + "Z",  # since last request
                     timelines={
                         "confirmed": Timeline(

tests/test_coordinates.py

@@ -10,6 +10,6 @@ def test_coordinates_class(latitude, longitude):
     coord_obj = coordinates.Coordinates(latitude=latitude, longitude=longitude)
 
     # validate serialize
-    check_obj = {"latitude": latitude, "longitude": longitude}
+    check_obj = {"latitude": float(latitude), "longitude": float(longitude)}
 
-    assert coord_obj.serialize() == check_obj
+    assert coord_obj.dict() == check_obj