Move around schema into logic groupings (#2)

* Move around schema into logic groups

* chore: deprecation warning on import of schema

* ci: isort runs only on vaccine_feed_ingest_schema

* ci: explicitly configure isort config

* Fix superlinter isort

Co-authored-by: Eli Block <[email protected]>

Author: bryanculbertson

.github/workflows/test.yml

@@ -59,3 +59,4 @@ jobs:
           VALIDATE_ALL_CODEBASE: false
           DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          PYTHON_ISORT_CONFIG_FILE: .isort.cfg # This is the default, but was not being picked up

.isort.cfg

@@ -1,2 +1,3 @@
 [settings]
 profile = black
+src_paths = vaccine_feed_ingest_schema

README.md

@@ -20,12 +20,12 @@ Import this package then use it to construct normalized objects with type
 enforcement.
 
 ```python
-from vaccine_feed_ingest_schema import schema
+from vaccine_feed_ingest_schema import location
 
 
-schema.NormalizedLocation(
+location.NormalizedLocation(
   id="vaccinebot:uuid-for-site",
-  source=schema.Source(
+  source=location.Source(
     source="vaccinebot",
     id="uuid-for-site",
     fetched_from_uri="https://vaccinateTheStates.com",

tests/test_vaccine_feed_ingest_schema.py

@@ -1,17 +1,29 @@
 import inspect
+from importlib import reload
 
 import pydantic.error_wrappers
 import pytest
 
-from vaccine_feed_ingest_schema import schema
+DEPRECATION_SNIPPET = "vaccine_feed_ingest_schema.schema is deprecated."
 
 
+def test_warn_on_import():
+    with pytest.warns(DeprecationWarning, match=DEPRECATION_SNIPPET):
+        from vaccine_feed_ingest_schema import schema
+
+        # Depending on the order in which tests run, the above import may be
+        # skipped. Reload it so that we trigger the warning, if it exists.
+        reload(schema)
+
+
+@pytest.mark.filterwarnings(f"ignore: {DEPRECATION_SNIPPET}")
 def test_has_expected_classes():
+    from vaccine_feed_ingest_schema import schema
+
     class_tuples = inspect.getmembers(schema, inspect.isclass)
     classes = list(map(lambda class_tuple: class_tuple[0], class_tuples))
 
     expected_classes = [
-        "BaseModel",
         "Address",
         "LatLng",
         "Contact",
@@ -37,6 +49,9 @@ def test_has_expected_classes():
             raise KeyError(f"Extra class {klass} defined. Did you update your tests?")
 
 
+@pytest.mark.filterwarnings(f"ignore: {DEPRECATION_SNIPPET}")
 def test_raises_on_invalid_location():
+    from vaccine_feed_ingest_schema import schema
+
     with pytest.raises(pydantic.error_wrappers.ValidationError):
         schema.NormalizedLocation()

tests/test_vaccine_feed_ingest_schema_load.py

@@ -0,0 +1,23 @@
+import inspect
+
+from vaccine_feed_ingest_schema import load
+
+
+def test_has_expected_classes():
+    class_tuples = inspect.getmembers(load, inspect.isclass)
+    classes = list(map(lambda class_tuple: class_tuple[0], class_tuples))
+
+    expected_classes = [
+        "BaseModel",
+        "NormalizedLocation",
+        "ImportMatchAction",
+        "ImportSourceLocation",
+    ]
+
+    for expected_class in expected_classes:
+        if expected_class not in classes:
+            raise KeyError(f"Expected class {expected_class} is not defined.")
+
+    for klass in classes:
+        if klass not in expected_classes:
+            raise KeyError(f"Extra class {klass} defined. Did you update your tests?")

tests/test_vaccine_feed_ingest_schema_location.py

@@ -0,0 +1,39 @@
+import inspect
+
+import pydantic.error_wrappers
+import pytest
+from vaccine_feed_ingest_schema import location
+
+
+def test_has_expected_classes():
+    class_tuples = inspect.getmembers(location, inspect.isclass)
+    classes = list(map(lambda class_tuple: class_tuple[0], class_tuples))
+
+    expected_classes = [
+        "BaseModel",
+        "Address",
+        "LatLng",
+        "Contact",
+        "OpenDate",
+        "OpenHour",
+        "Availability",
+        "Vaccine",
+        "Access",
+        "Organization",
+        "Link",
+        "Source",
+        "NormalizedLocation",
+    ]
+
+    for expected_class in expected_classes:
+        if expected_class not in classes:
+            raise KeyError(f"Expected class {expected_class} is not defined.")
+
+    for klass in classes:
+        if klass not in expected_classes:
+            raise KeyError(f"Extra class {klass} defined. Did you update your tests?")
+
+
+def test_raises_on_invalid_location():
+    with pytest.raises(pydantic.error_wrappers.ValidationError):
+        location.NormalizedLocation()

vaccine_feed_ingest_schema/common.py

@@ -0,0 +1,24 @@
+"""Common config for all schemas"""
+
+import pydantic
+
+
+class BaseModel(pydantic.BaseModel):
+    """BaseModel for all schema to inherit from."""
+
+    class Config:
+        # Strip whitespace from str values by default.
+        # This will help have consistant data if parsers forgot to strip.
+        anystr_strip_whitespace = True
+
+        # Fail if an attrbute that doesn't exist is added.
+        # This will help reduce typos.
+        extra = "forbid"
+
+        # Validate when setting attributes.
+        # This will help trigger errors right where they occur.
+        validate_assignment = True
+
+        # Store enums as string values.
+        # This helps so people can use either strings or enums.
+        use_enum_values = True

vaccine_feed_ingest_schema/load.py

@@ -0,0 +1,23 @@
+from typing import Optional
+
+from .common import BaseModel
+from .location import NormalizedLocation
+
+
+class ImportMatchAction(BaseModel):
+    """Match action to take when importing a source location"""
+
+    id: Optional[str]
+    action: str
+
+
+class ImportSourceLocation(BaseModel):
+    """Import source location record"""
+
+    source_uid: str
+    source_name: str
+    name: Optional[str]
+    latitude: Optional[float]
+    longitude: Optional[float]
+    import_json: NormalizedLocation
+    match: Optional[ImportMatchAction]

vaccine_feed_ingest_schema/location.py

@@ -0,0 +1,186 @@
+"""Normalized Location Schema
+
+Spec defined here:
+https://github.com/CAVaccineInventory/vaccine-feed-ingest/wiki/Normalized-Location-Schema
+"""
+
+from typing import List, Optional
+
+from .common import BaseModel
+
+
+class Address(BaseModel):
+    """
+    {
+        "street1": str,
+        "street2": str,
+        "city": str,
+        "state": str as state initial e.g. CA,
+        "zip": str,
+    },
+    """
+
+    street1: str
+    street2: Optional[str]
+    city: str
+    state: str
+    zip: str
+
+
+class LatLng(BaseModel):
+    """
+    {
+        "latitude": float,
+        "longitude": float,
+    },
+    """
+
+    latitude: float
+    longitude: float
+
+
+class Contact(BaseModel):
+    """
+    {
+        "contact_type": str as contact type enum e.g. booking,
+        "phone": str as (###) ###-###,
+        "website": str,
+        "email": str,
+        "other": str,
+    }
+    """
+
+    contact_type: Optional[str]
+    phone: Optional[str]
+    website: Optional[str]
+    email: Optional[str]
+    other: Optional[str]
+
+
+class OpenDate(BaseModel):
+    """
+    {
+        "opens": str as iso8601 date,
+        "closes": str as iso8601 date,
+    }
+    """
+
+    opens: Optional[str]
+    closes: Optional[str]
+
+
+class OpenHour(BaseModel):
+    """
+    {
+        "day": str as day of week enum e.g. monday,
+        "opens": str as hh:mm,
+        "closes": str as hh:mm,
+    }
+    """
+
+    day: str
+    open: str
+    closes: str
+
+
+class Availability(BaseModel):
+    """
+    {
+        "drop_in": bool,
+        "appointments": bool,
+    },
+    """
+
+    drop_in: Optional[bool]
+    appointments: Optional[bool]
+
+
+class Vaccine(BaseModel):
+    """
+    {
+        "vaccine": str as vaccine type enum,
+        "supply_level": str as supply level enum e.g. more_than_48hrs
+    }
+    """
+
+    vaccine: str
+    supply_level: Optional[str]
+
+
+class Access(BaseModel):
+    """
+    {
+        "walk": bool,
+        "drive": bool,
+        "wheelchair": str,
+    }
+    """
+
+    walk: Optional[bool]
+    drive: Optional[bool]
+    wheelchair: Optional[str]
+
+
+class Organization(BaseModel):
+    """
+    {
+        "id": str as parent organization enum e.g. rite_aid,
+        "name": str,
+    }
+    """
+
+    id: Optional[str]
+    name: Optional[str]
+
+
+class Link(BaseModel):
+    """
+    {
+        "authority": str as authority enum e.g. rite_aid or google_places,
+        "id": str as id used by authority to reference this location e.g. 4096,
+        "uri": str as uri used by authority to reference this location,
+    }
+    """
+
+    authority: Optional[str]
+    id: Optional[str]
+    uri: Optional[str]
+
+
+class Source(BaseModel):
+    """
+    {
+        "source": str as source type enum e.g. vaccinespotter,
+        "id": str as source defined id e.g. 7382088,
+        "fetched_from_uri": str as uri where data was fetched from,
+        "fetched_at": str as iso8601 datetime (when scraper ran),
+        "published_at": str as iso8601 datetime (when source claims it updated),
+        "data": {...parsed source data in source schema...},
+    }
+    """
+
+    source: str
+    id: str
+    fetched_from_uri: Optional[str]
+    fetched_at: Optional[str]
+    published_at: Optional[str]
+    data: dict
+
+
+class NormalizedLocation(BaseModel):
+    id: str
+    name: Optional[str]
+    address: Optional[Address]
+    location: Optional[LatLng]
+    contact: Optional[List[Contact]]
+    languages: Optional[List[str]]  # [str as ISO 639-1 code]
+    opening_dates: Optional[List[OpenDate]]
+    opening_hours: Optional[List[OpenHour]]
+    availability: Optional[Availability]
+    inventory: Optional[List[Vaccine]]
+    access: Optional[Access]
+    parent_organization: Optional[Organization]
+    links: Optional[List[Link]]
+    notes: Optional[List[str]]
+    active: Optional[bool]
+    source: Source