feat: Implement V3 ID Vision and fields_to_exclude_from_db across core models
This commit refactors numerous Pydantic models to align with the V3 ID Vision standard, ensuring that primary and foreign key fields are represented as clean string IDs in the API. It also introduces and populates the ClassVar in each model to prevent view-only fields and linked objects from being inadvertently written to the database during PATCH/POST operations. Specifically, this includes: - Adding to exclude view-derived or joined fields such as , , nested objects (e.g., , ), and convenience fields (e.g., ). - Adjusting root validators to correctly map string IDs and strip internal integer IDs for API responses. - Resolving a KeyError by adding to . These changes are crucial for maintaining data integrity and consistency with the V3 API architecture.
This commit is contained in:
Scott Idem
@@ -1,7 +1,7 @@
|
||||
import datetime, pytz
|
||||
|
||||
from typing import Dict, List, Optional, Set, Union
|
||||
from pydantic import BaseModel, EmailStr, Field, Json, PrivateAttr, ValidationError, validator
|
||||
from typing import Dict, List, Optional, Set, Union, ClassVar
|
||||
from pydantic import BaseModel, EmailStr, Field, Json, PrivateAttr, ValidationError, validator, root_validator
|
||||
|
||||
from app.db_sql import redis_lookup_id_random
|
||||
from app.lib_general import log, logging
|
||||
@@ -22,40 +22,33 @@ class Event_Person_Base(BaseModel):
|
||||
log.setLevel(logging.WARNING) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL
|
||||
log.debug(locals())
|
||||
|
||||
id_random: Optional[str] = Field(
|
||||
# **base_fields['event_person_id_random'],
|
||||
alias = 'event_person_id_random',
|
||||
)
|
||||
id: Optional[int] = Field(
|
||||
alias = 'event_person_id'
|
||||
)
|
||||
# --- Standardized Vision IDs (Strings) ---
|
||||
id: Optional[str] = Field(None, **base_fields['event_person_id_random'])
|
||||
event_person_id: Optional[str] = Field(None, **base_fields['event_person_id_random'])
|
||||
|
||||
account_id_random: Optional[str]
|
||||
account_id: Optional[int]
|
||||
account_id: Optional[str] = Field(None, **base_fields['account_id_random'])
|
||||
event_id: Optional[str] = Field(None, **base_fields['event_id_random'])
|
||||
|
||||
event_id_random: Optional[str]
|
||||
event_id: Optional[int]
|
||||
event_badge_id: Optional[str] = Field(None, **base_fields['event_badge_id_random'])
|
||||
event_badge_vendor_id: Optional[str] = Field(None, **base_fields['event_badge_id_random'])
|
||||
event_badge_vip_id: Optional[str] = Field(None, **base_fields['event_badge_id_random'])
|
||||
|
||||
event_badge_id_random: Optional[str] # Default attendee badge
|
||||
event_badge_id: Optional[int]
|
||||
event_person_profile_id: Optional[str] = Field(None, **base_fields['event_person_profile_id_random'])
|
||||
event_registration_id: Optional[str] = Field(None, **base_fields['event_registration_id_random'])
|
||||
person_id: Optional[str] = Field(None, **base_fields['person_id_random'])
|
||||
user_id: Optional[str] = Field(None, **base_fields['user_id_random'])
|
||||
|
||||
event_badge_vendor_id_random: Optional[str] # Additional vendor badge
|
||||
event_badge_vendor_id: Optional[int]
|
||||
|
||||
event_badge_vip_id_random: Optional[str] # Additional VIP badge
|
||||
event_badge_vip_id: Optional[int]
|
||||
|
||||
event_person_profile_id_random: Optional[str]
|
||||
event_person_profile_id: Optional[int]
|
||||
|
||||
event_registration_id_random: Optional[str]
|
||||
event_registration_id: Optional[int]
|
||||
|
||||
person_id_random: Optional[str]
|
||||
person_id: Optional[int]
|
||||
|
||||
user_id_random: Optional[str]
|
||||
user_id: Optional[int]
|
||||
# --- Standardized Legacy / Internal IDs (Excluded) ---
|
||||
id_random: Optional[str] = Field(None, alias='event_person_id_random', exclude=True)
|
||||
account_id_random: Optional[str] = Field(None, exclude=True)
|
||||
event_id_random: Optional[str] = Field(None, exclude=True)
|
||||
event_badge_id_random: Optional[str] = Field(None, exclude=True)
|
||||
event_badge_vendor_id_random: Optional[str] = Field(None, exclude=True)
|
||||
event_badge_vip_id_random: Optional[str] = Field(None, exclude=True)
|
||||
event_person_profile_id_random: Optional[str] = Field(None, exclude=True)
|
||||
event_registration_id_random: Optional[str] = Field(None, exclude=True)
|
||||
person_id_random: Optional[str] = Field(None, exclude=True)
|
||||
user_id_random: Optional[str] = Field(None, exclude=True)
|
||||
|
||||
external_id: Optional[str] # Generated internally or externally. Needs to be stable. It should not change.
|
||||
external_event_id: Optional[str] # Event ID generated by external system. Needs to be stable. It should not change.
|
||||
@@ -159,81 +152,54 @@ class Event_Person_Base(BaseModel):
|
||||
|
||||
_processed_at: datetime.datetime = PrivateAttr(default_factory=datetime.datetime.now)
|
||||
|
||||
#@validator('event_person_id_random', always=True)
|
||||
def event_person_id_random_copy(cls, v, values, **kwargs):
|
||||
if values['id_random']:
|
||||
return values['id_random']
|
||||
return None
|
||||
@root_validator(pre=True)
|
||||
def map_v3_ids(cls, values):
|
||||
"""
|
||||
Vision Transformer:
|
||||
Map DB keys to clean API keys and strip internal integers.
|
||||
"""
|
||||
# 1. Map Random Strings to Clean Names
|
||||
if rid := values.get('id_random') or values.get('event_person_id_random'):
|
||||
values['id'] = rid
|
||||
values['event_person_id'] = rid
|
||||
|
||||
if a_rid := values.get('account_id_random'): values['account_id'] = a_rid
|
||||
if e_rid := values.get('event_id_random'): values['event_id'] = e_rid
|
||||
if b_rid := values.get('event_badge_id_random'): values['event_badge_id'] = b_rid
|
||||
if bv_rid := values.get('event_badge_vendor_id_random'): values['event_badge_vendor_id'] = bv_rid
|
||||
if bvip_rid := values.get('event_badge_vip_id_random'): values['event_badge_vip_id'] = bvip_rid
|
||||
if ep_rid := values.get('event_person_profile_id_random'): values['event_person_profile_id'] = ep_rid
|
||||
if er_rid := values.get('event_registration_id_random'): values['event_registration_id'] = er_rid
|
||||
if p_rid := values.get('person_id_random'): values['person_id'] = p_rid
|
||||
if u_rid := values.get('user_id_random'): values['user_id'] = u_rid
|
||||
|
||||
# 2. Prevent "Collision Population"
|
||||
for k in ['id', 'event_person_id', 'account_id', 'event_id', 'event_badge_id', 'event_badge_vendor_id', 'event_badge_vip_id', 'event_person_profile_id', 'event_registration_id', 'person_id', 'user_id']:
|
||||
if k in values and not isinstance(values[k], str) and values[k] is not None:
|
||||
del values[k]
|
||||
|
||||
return values
|
||||
|
||||
@validator('id', always=True)
|
||||
def event_person_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event_person')
|
||||
return None
|
||||
|
||||
@validator('account_id', always=True)
|
||||
def account_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('account_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='account')
|
||||
return None
|
||||
|
||||
@validator('event_id', always=True)
|
||||
def event_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('event_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event')
|
||||
return None
|
||||
|
||||
@validator('event_badge_id', always=True)
|
||||
def event_badge_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('event_badge_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event_badge')
|
||||
return None
|
||||
|
||||
@validator('event_badge_vendor_id', always=True)
|
||||
def event_badge_vendor_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('event_badge_vendor_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event_badge')
|
||||
return None
|
||||
|
||||
@validator('event_badge_vip_id', always=True)
|
||||
def event_badge_vip_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('event_badge_vip_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event_badge')
|
||||
return None
|
||||
|
||||
@validator('event_person_profile_id', always=True)
|
||||
def event_person_profile_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('event_person_profile_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event_person_profile')
|
||||
return None
|
||||
|
||||
@validator('event_registration_id', always=True)
|
||||
def event_registration_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('event_registration_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event_registration')
|
||||
return None
|
||||
|
||||
@validator('person_id', always=True)
|
||||
def person_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('person_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='person')
|
||||
return None
|
||||
|
||||
@validator('user_id', always=True)
|
||||
def user_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('user_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='user')
|
||||
return None
|
||||
# Fields that are part of the model (for reading) but should not be saved to the DB table
|
||||
fields_to_exclude_from_db: ClassVar[list] = [
|
||||
'file_count',
|
||||
'informal_name', 'given_name', 'middle_name', 'family_name', 'full_name_override', 'full_name',
|
||||
'affiliations', 'email', 'website_url',
|
||||
'event_badge_informal_name', 'event_badge_given_name', 'event_badge_middle_name',
|
||||
'event_badge_family_name', 'event_badge_full_name', 'event_badge_full_name_override',
|
||||
'event_badge_affiliations', 'event_badge_email', 'event_badge_city',
|
||||
'event_badge_state_province', 'event_badge_country_alpha_2_code', 'event_badge_country',
|
||||
'event_person_informal_name', 'event_person_given_name', 'event_person_middle_name',
|
||||
'event_person_family_name', 'event_person_name_override', 'event_person_full_name',
|
||||
'event_person_affiliations', 'event_person_email', 'event_person_extended_json',
|
||||
'person_informal_name', 'person_given_name', 'person_middle_name', 'person_family_name',
|
||||
'person_full_name', 'person_full_name_override', 'person_affiliations', 'person_email',
|
||||
'user_email', 'user_name', 'user_username',
|
||||
'event_badge', 'event_badge_vendor', 'event_badge_vip', 'event_exhibit_list',
|
||||
'event_file_list', 'event_location_list', 'event_person_profile',
|
||||
'event_presentation_list', 'event_presenter_list', 'event_registration',
|
||||
'event_session', 'event_track', 'person', 'user'
|
||||
]
|
||||
|
||||
class Config:
|
||||
underscore_attrs_are_private = True
|
||||
@@ -247,17 +213,17 @@ class Event_Person_New_Base(BaseModel):
|
||||
log.setLevel(logging.WARNING) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL
|
||||
log.debug(locals())
|
||||
|
||||
id_random: Optional[str] = Field(
|
||||
**base_fields['event_person_id_random'],
|
||||
alias = 'event_person_id_random',
|
||||
)
|
||||
id: Optional[int] = Field(
|
||||
alias = 'event_person_id'
|
||||
)
|
||||
account_id_random: Optional[str]
|
||||
account_id: Optional[int]
|
||||
event_id_random: Optional[str]
|
||||
event_id: Optional[int]
|
||||
# --- Standardized Vision IDs (Strings) ---
|
||||
id: Optional[str] = Field(None, **base_fields['event_person_id_random'])
|
||||
event_person_id: Optional[str] = Field(None, **base_fields['event_person_id_random'])
|
||||
|
||||
account_id: Optional[str] = Field(None, **base_fields['account_id_random'])
|
||||
event_id: Optional[str] = Field(None, **base_fields['event_id_random'])
|
||||
|
||||
# --- Standardized Legacy / Internal IDs (Excluded) ---
|
||||
id_random: Optional[str] = Field(None, alias='event_person_id_random', exclude=True)
|
||||
account_id_random: Optional[str] = Field(None, exclude=True)
|
||||
event_id_random: Optional[str] = Field(None, exclude=True)
|
||||
|
||||
extended_json: Optional[Union[Json, None]]
|
||||
|
||||
@@ -319,32 +285,43 @@ class Event_Person_New_Base(BaseModel):
|
||||
|
||||
_processed_at: datetime.datetime = PrivateAttr(default_factory=datetime.datetime.now)
|
||||
|
||||
#@validator('event_person_id_random', always=True)
|
||||
def event_person_id_random_copy(cls, v, values, **kwargs):
|
||||
if values['id_random']:
|
||||
return values['id_random']
|
||||
return None
|
||||
@root_validator(pre=True)
|
||||
def map_v3_ids(cls, values):
|
||||
"""
|
||||
Vision Transformer:
|
||||
Map DB keys to clean API keys and strip internal integers.
|
||||
"""
|
||||
# 1. Map Random Strings to Clean Names
|
||||
if rid := values.get('id_random') or values.get('event_person_id_random'):
|
||||
values['id'] = rid
|
||||
values['event_person_id'] = rid
|
||||
|
||||
if a_rid := values.get('account_id_random'):
|
||||
values['account_id'] = a_rid
|
||||
if e_rid := values.get('event_id_random'):
|
||||
values['event_id'] = e_rid
|
||||
|
||||
# 2. Prevent "Collision Population"
|
||||
for k in ['id', 'event_person_id', 'account_id', 'event_id']:
|
||||
if k in values and not isinstance(values[k], str) and values[k] is not None:
|
||||
del values[k]
|
||||
|
||||
return values
|
||||
|
||||
@validator('id', always=True)
|
||||
def event_person_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event_person')
|
||||
return None
|
||||
|
||||
@validator('account_id', always=True)
|
||||
def account_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('account_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='account')
|
||||
return None
|
||||
|
||||
@validator('event_id', always=True)
|
||||
def event_id_lookup(cls, v, values, **kwargs):
|
||||
if isinstance(v, int) and v > 0: return v
|
||||
elif id_random := values.get('event_id_random'):
|
||||
return redis_lookup_id_random(record_id_random=id_random, table_name='event')
|
||||
return None
|
||||
# Fields that are part of the model (for reading) but should not be saved to the DB table
|
||||
fields_to_exclude_from_db: ClassVar[list] = [
|
||||
'informal_name', 'given_name', 'middle_name', 'family_name', 'full_name',
|
||||
'full_name_override', 'affiliations', 'email', 'website_url', 'state_province_name',
|
||||
'event_badge_informal_name', 'event_badge_given_name', 'event_badge_middle_name',
|
||||
'event_badge_family_name', 'event_badge_full_name', 'event_badge_full_name_override',
|
||||
'event_badge_affiliations', 'event_badge_email', 'event_badge_city',
|
||||
'event_badge_state_province', 'event_badge_country_alpha_2_code', 'event_badge_country',
|
||||
'event_person_informal_name', 'event_person_given_name', 'event_person_middle_name',
|
||||
'event_person_family_name', 'event_person_name_override', 'event_person_full_name',
|
||||
'event_person_affiliations', 'event_person_email',
|
||||
'person_given_name', 'person_middle_name', 'person_family_name',
|
||||
'person_full_name', 'person_full_name_override', 'new_password'
|
||||
]
|
||||
|
||||
class Config:
|
||||
underscore_attrs_are_private = True
|
||||
|
||||
Reference in New Issue
Block a user