[Issue #1853] Move where we define the lookup mapping to avoid consta…

…nt import issues (#1854) ## Summary Fixes #1853 ### Time to review: __1 mins__ ## Changes proposed Move where we define the LookupConfig definitions to reduce circular dependencies ## Context for reviewers This doesn't change the configs, just where they're defined. We frequently want to import the enums defined in lookup_constants, but because that file in turn depends on the DB lookup files, we run into some odd circular dependencies that require manually sorting imports to resolve. Instead, we'll just define those LookupConfig classes in the only place they're ever used to avoid the headache.
HHS · Apr 26, 2024 · 365918c · 365918c
1 parent dd9a43d
commit 365918c
Show file tree

Hide file tree

Showing 2 changed files with 98 additions and 97 deletions.
diff --git a/api/src/constants/lookup_constants.py b/api/src/constants/lookup_constants.py
@@ -1,7 +1,5 @@
 from enum import StrEnum
 
-from src.db.models.lookup import LookupConfig, LookupStr
-
 
 class OpportunityStatus(StrEnum):
     FORECASTED = "forecasted"
@@ -10,16 +8,6 @@ class OpportunityStatus(StrEnum):
     ARCHIVED = "archived"
 
 
-OPPORTUNITY_STATUS_CONFIG = LookupConfig(
-    [
-        LookupStr(OpportunityStatus.FORECASTED, 1),
-        LookupStr(OpportunityStatus.POSTED, 2),
-        LookupStr(OpportunityStatus.CLOSED, 3),
-        LookupStr(OpportunityStatus.ARCHIVED, 4),
-    ]
-)
-
-
 class OpportunityCategoryLegacy(StrEnum):
     # These are only used where the legacy system
     # needs to specify the values and can be removed
@@ -39,17 +27,6 @@ class OpportunityCategory(StrEnum):
     OTHER = "other"
 
 
-OPPORTUNITY_CATEGORY_CONFIG = LookupConfig(
-    [
-        LookupStr(OpportunityCategory.DISCRETIONARY, 1),
-        LookupStr(OpportunityCategory.MANDATORY, 2),
-        LookupStr(OpportunityCategory.CONTINUATION, 3),
-        LookupStr(OpportunityCategory.EARMARK, 4),
-        LookupStr(OpportunityCategory.OTHER, 5),
-    ]
-)
-
-
 class ApplicantType(StrEnum):
     # https://grants.gov/system-to-system/grantor-system-to-system/schemas/grants-funding-synopsis#EligibleApplicantTypes
     # Comment is the legacy systems code
@@ -86,29 +63,6 @@ class ApplicantType(StrEnum):
     UNRESTRICTED = "unrestricted"  # 99
 
 
-APPLICANT_TYPE_CONFIG = LookupConfig(
-    [
-        LookupStr(ApplicantType.STATE_GOVERNMENTS, 1),
-        LookupStr(ApplicantType.COUNTY_GOVERNMENTS, 2),
-        LookupStr(ApplicantType.CITY_OR_TOWNSHIP_GOVERNMENTS, 3),
-        LookupStr(ApplicantType.SPECIAL_DISTRICT_GOVERNMENTS, 4),
-        LookupStr(ApplicantType.INDEPENDENT_SCHOOL_DISTRICTS, 5),
-        LookupStr(ApplicantType.PUBLIC_AND_STATE_INSTITUTIONS_OF_HIGHER_EDUCATION, 6),
-        LookupStr(ApplicantType.PRIVATE_INSTITUTIONS_OF_HIGHER_EDUCATION, 7),
-        LookupStr(ApplicantType.FEDERALLY_RECOGNIZED_NATIVE_AMERICAN_TRIBAL_GOVERNMENTS, 8),
-        LookupStr(ApplicantType.OTHER_NATIVE_AMERICAN_TRIBAL_ORGANIZATIONS, 9),
-        LookupStr(ApplicantType.PUBLIC_AND_INDIAN_HOUSING_AUTHORITIES, 10),
-        LookupStr(ApplicantType.NONPROFITS_NON_HIGHER_EDUCATION_WITH_501C3, 11),
-        LookupStr(ApplicantType.NONPROFITS_NON_HIGHER_EDUCATION_WITHOUT_501C3, 12),
-        LookupStr(ApplicantType.INDIVIDUALS, 13),
-        LookupStr(ApplicantType.FOR_PROFIT_ORGANIZATIONS_OTHER_THAN_SMALL_BUSINESSES, 14),
-        LookupStr(ApplicantType.SMALL_BUSINESSES, 15),
-        LookupStr(ApplicantType.OTHER, 16),
-        LookupStr(ApplicantType.UNRESTRICTED, 17),
-    ]
-)
-
-
 class FundingCategory(StrEnum):
     # https://grants.gov/system-to-system/grantor-system-to-system/schemas/grants-funding-synopsis#FundingActivityCategory
     # Comment is the legacy systems code
@@ -143,38 +97,6 @@ class FundingCategory(StrEnum):
     OTHER = "other"  # O
 
 
-FUNDING_CATEGORY_CONFIG = LookupConfig(
-    [
-        LookupStr(FundingCategory.RECOVERY_ACT, 1),
-        LookupStr(FundingCategory.AGRICULTURE, 2),
-        LookupStr(FundingCategory.ARTS, 3),
-        LookupStr(FundingCategory.BUSINESS_AND_COMMERCE, 4),
-        LookupStr(FundingCategory.COMMUNITY_DEVELOPMENT, 5),
-        LookupStr(FundingCategory.CONSUMER_PROTECTION, 6),
-        LookupStr(FundingCategory.DISASTER_PREVENTION_AND_RELIEF, 7),
-        LookupStr(FundingCategory.EDUCATION, 8),
-        LookupStr(FundingCategory.EMPLOYMENT_LABOR_AND_TRAINING, 9),
-        LookupStr(FundingCategory.ENERGY, 10),
-        LookupStr(FundingCategory.ENVIRONMENT, 11),
-        LookupStr(FundingCategory.FOOD_AND_NUTRITION, 12),
-        LookupStr(FundingCategory.HEALTH, 13),
-        LookupStr(FundingCategory.HOUSING, 14),
-        LookupStr(FundingCategory.HUMANITIES, 15),
-        LookupStr(FundingCategory.INFRASTRUCTURE_INVESTMENT_AND_JOBS_ACT, 16),
-        LookupStr(FundingCategory.INFORMATION_AND_STATISTICS, 17),
-        LookupStr(FundingCategory.INCOME_SECURITY_AND_SOCIAL_SERVICES, 18),
-        LookupStr(FundingCategory.LAW_JUSTICE_AND_LEGAL_SERVICES, 19),
-        LookupStr(FundingCategory.NATURAL_RESOURCES, 20),
-        LookupStr(FundingCategory.OPPORTUNITY_ZONE_BENEFITS, 21),
-        LookupStr(FundingCategory.REGIONAL_DEVELOPMENT, 22),
-        LookupStr(FundingCategory.SCIENCE_TECHNOLOGY_AND_OTHER_RESEARCH_AND_DEVELOPMENT, 23),
-        LookupStr(FundingCategory.TRANSPORTATION, 24),
-        LookupStr(FundingCategory.AFFORDABLE_CARE_ACT, 25),
-        LookupStr(FundingCategory.OTHER, 26),
-    ]
-)
-
-
 class FundingInstrument(StrEnum):
     # https://grants.gov/system-to-system/grantor-system-to-system/schemas/grants-funding-synopsis#FundingInstrument
     # Comment is the legacy systems code
@@ -183,13 +105,3 @@ class FundingInstrument(StrEnum):
     GRANT = "grant"  # G
     PROCUREMENT_CONTRACT = "procurement_contract"  # PC
     OTHER = "other"  # O
-
-
-FUNDING_INSTRUMENT_CONFIG = LookupConfig(
-    [
-        LookupStr(FundingInstrument.COOPERATIVE_AGREEMENT, 1),
-        LookupStr(FundingInstrument.GRANT, 2),
-        LookupStr(FundingInstrument.PROCUREMENT_CONTRACT, 3),
-        LookupStr(FundingInstrument.OTHER, 4),
-    ]
-)
diff --git a/api/src/db/models/lookup_models.py b/api/src/db/models/lookup_models.py
@@ -1,11 +1,100 @@
 from sqlalchemy.orm import Mapped, mapped_column
 
-from src.constants import lookup_constants
+from src.constants.lookup_constants import (
+    ApplicantType,
+    FundingCategory,
+    FundingInstrument,
+    OpportunityCategory,
+    OpportunityStatus,
+)
 from src.db.models.base import TimestampMixin
-from src.db.models.lookup import Lookup, LookupRegistry, LookupTable
-
-
-@LookupRegistry.register_lookup(lookup_constants.OPPORTUNITY_CATEGORY_CONFIG)
+from src.db.models.lookup import Lookup, LookupConfig, LookupRegistry, LookupStr, LookupTable
+
+OPPORTUNITY_STATUS_CONFIG = LookupConfig(
+    [
+        LookupStr(OpportunityStatus.FORECASTED, 1),
+        LookupStr(OpportunityStatus.POSTED, 2),
+        LookupStr(OpportunityStatus.CLOSED, 3),
+        LookupStr(OpportunityStatus.ARCHIVED, 4),
+    ]
+)
+
+
+OPPORTUNITY_CATEGORY_CONFIG = LookupConfig(
+    [
+        LookupStr(OpportunityCategory.DISCRETIONARY, 1),
+        LookupStr(OpportunityCategory.MANDATORY, 2),
+        LookupStr(OpportunityCategory.CONTINUATION, 3),
+        LookupStr(OpportunityCategory.EARMARK, 4),
+        LookupStr(OpportunityCategory.OTHER, 5),
+    ]
+)
+
+APPLICANT_TYPE_CONFIG = LookupConfig(
+    [
+        LookupStr(ApplicantType.STATE_GOVERNMENTS, 1),
+        LookupStr(ApplicantType.COUNTY_GOVERNMENTS, 2),
+        LookupStr(ApplicantType.CITY_OR_TOWNSHIP_GOVERNMENTS, 3),
+        LookupStr(ApplicantType.SPECIAL_DISTRICT_GOVERNMENTS, 4),
+        LookupStr(ApplicantType.INDEPENDENT_SCHOOL_DISTRICTS, 5),
+        LookupStr(ApplicantType.PUBLIC_AND_STATE_INSTITUTIONS_OF_HIGHER_EDUCATION, 6),
+        LookupStr(ApplicantType.PRIVATE_INSTITUTIONS_OF_HIGHER_EDUCATION, 7),
+        LookupStr(ApplicantType.FEDERALLY_RECOGNIZED_NATIVE_AMERICAN_TRIBAL_GOVERNMENTS, 8),
+        LookupStr(ApplicantType.OTHER_NATIVE_AMERICAN_TRIBAL_ORGANIZATIONS, 9),
+        LookupStr(ApplicantType.PUBLIC_AND_INDIAN_HOUSING_AUTHORITIES, 10),
+        LookupStr(ApplicantType.NONPROFITS_NON_HIGHER_EDUCATION_WITH_501C3, 11),
+        LookupStr(ApplicantType.NONPROFITS_NON_HIGHER_EDUCATION_WITHOUT_501C3, 12),
+        LookupStr(ApplicantType.INDIVIDUALS, 13),
+        LookupStr(ApplicantType.FOR_PROFIT_ORGANIZATIONS_OTHER_THAN_SMALL_BUSINESSES, 14),
+        LookupStr(ApplicantType.SMALL_BUSINESSES, 15),
+        LookupStr(ApplicantType.OTHER, 16),
+        LookupStr(ApplicantType.UNRESTRICTED, 17),
+    ]
+)
+
+
+FUNDING_CATEGORY_CONFIG = LookupConfig(
+    [
+        LookupStr(FundingCategory.RECOVERY_ACT, 1),
+        LookupStr(FundingCategory.AGRICULTURE, 2),
+        LookupStr(FundingCategory.ARTS, 3),
+        LookupStr(FundingCategory.BUSINESS_AND_COMMERCE, 4),
+        LookupStr(FundingCategory.COMMUNITY_DEVELOPMENT, 5),
+        LookupStr(FundingCategory.CONSUMER_PROTECTION, 6),
+        LookupStr(FundingCategory.DISASTER_PREVENTION_AND_RELIEF, 7),
+        LookupStr(FundingCategory.EDUCATION, 8),
+        LookupStr(FundingCategory.EMPLOYMENT_LABOR_AND_TRAINING, 9),
+        LookupStr(FundingCategory.ENERGY, 10),
+        LookupStr(FundingCategory.ENVIRONMENT, 11),
+        LookupStr(FundingCategory.FOOD_AND_NUTRITION, 12),
+        LookupStr(FundingCategory.HEALTH, 13),
+        LookupStr(FundingCategory.HOUSING, 14),
+        LookupStr(FundingCategory.HUMANITIES, 15),
+        LookupStr(FundingCategory.INFRASTRUCTURE_INVESTMENT_AND_JOBS_ACT, 16),
+        LookupStr(FundingCategory.INFORMATION_AND_STATISTICS, 17),
+        LookupStr(FundingCategory.INCOME_SECURITY_AND_SOCIAL_SERVICES, 18),
+        LookupStr(FundingCategory.LAW_JUSTICE_AND_LEGAL_SERVICES, 19),
+        LookupStr(FundingCategory.NATURAL_RESOURCES, 20),
+        LookupStr(FundingCategory.OPPORTUNITY_ZONE_BENEFITS, 21),
+        LookupStr(FundingCategory.REGIONAL_DEVELOPMENT, 22),
+        LookupStr(FundingCategory.SCIENCE_TECHNOLOGY_AND_OTHER_RESEARCH_AND_DEVELOPMENT, 23),
+        LookupStr(FundingCategory.TRANSPORTATION, 24),
+        LookupStr(FundingCategory.AFFORDABLE_CARE_ACT, 25),
+        LookupStr(FundingCategory.OTHER, 26),
+    ]
+)
+
+FUNDING_INSTRUMENT_CONFIG = LookupConfig(
+    [
+        LookupStr(FundingInstrument.COOPERATIVE_AGREEMENT, 1),
+        LookupStr(FundingInstrument.GRANT, 2),
+        LookupStr(FundingInstrument.PROCUREMENT_CONTRACT, 3),
+        LookupStr(FundingInstrument.OTHER, 4),
+    ]
+)
+
+
+@LookupRegistry.register_lookup(OPPORTUNITY_CATEGORY_CONFIG)
 class LkOpportunityCategory(LookupTable, TimestampMixin):
     __tablename__ = "lk_opportunity_category"
 
@@ -19,7 +108,7 @@ def from_lookup(cls, lookup: Lookup) -> "LkOpportunityCategory":
         )
 
 
-@LookupRegistry.register_lookup(lookup_constants.APPLICANT_TYPE_CONFIG)
+@LookupRegistry.register_lookup(APPLICANT_TYPE_CONFIG)
 class LkApplicantType(LookupTable, TimestampMixin):
     __tablename__ = "lk_applicant_type"
 
@@ -33,7 +122,7 @@ def from_lookup(cls, lookup: Lookup) -> "LkApplicantType":
         )
 
 
-@LookupRegistry.register_lookup(lookup_constants.FUNDING_CATEGORY_CONFIG)
+@LookupRegistry.register_lookup(FUNDING_CATEGORY_CONFIG)
 class LkFundingCategory(LookupTable, TimestampMixin):
     __tablename__ = "lk_funding_category"
 
@@ -47,7 +136,7 @@ def from_lookup(cls, lookup: Lookup) -> "LkFundingCategory":
         )
 
 
-@LookupRegistry.register_lookup(lookup_constants.FUNDING_INSTRUMENT_CONFIG)
+@LookupRegistry.register_lookup(FUNDING_INSTRUMENT_CONFIG)
 class LkFundingInstrument(LookupTable, TimestampMixin):
     __tablename__ = "lk_funding_instrument"
 
@@ -61,7 +150,7 @@ def from_lookup(cls, lookup: Lookup) -> "LkFundingInstrument":
         )
 
 
-@LookupRegistry.register_lookup(lookup_constants.OPPORTUNITY_STATUS_CONFIG)
+@LookupRegistry.register_lookup(OPPORTUNITY_STATUS_CONFIG)
 class LkOpportunityStatus(LookupTable, TimestampMixin):
     __tablename__ = "lk_opportunity_status"