Files
OSIT-AE-API-FastAPI/app/models/person_models.py
2024-07-24 17:16:03 -04:00

226 lines
9.2 KiB
Python

import datetime, pytz
from typing import Dict, List, Optional, Set, Union
from pydantic import BaseModel, EmailStr, Field, Json, PrivateAttr, ValidationError, validator
from app.db_sql import redis_lookup_id_random
from app.lib_general import log, logging
from app.models.common_field_schema import base_fields, default_num_bytes
# from app.models.account_models import Account_Base
from app.models.contact_models import Contact_Base
from app.models.journal_models import Journal_Base
from app.models.membership_group_models import Membership_Group_Base
from app.models.membership_person_models import Membership_Person_Base
from app.models.membership_type_models import Membership_Type_Base
# from app.models.order_models import Order_Base
from app.models.organization_models import Organization_Base
from app.models.user_models import User_Base
# ### BEGIN ### API Person Models ### Person_Base() ###
class Person_Base(BaseModel):
log.setLevel(logging.INFO) # DEBUG, INFO, WARNING, ERROR, EXCEPTION, CRITICAL
log.debug(locals())
id_random: Optional[str] = Field(
**base_fields['person_id_random'],
alias = 'person_id_random',
# default_factory = lambda:secrets.token_urlsafe(default_num_bytes),
)
id: Optional[int] = Field(
alias = 'person_id'
)
account_id_random: Optional[str]
account_id: Optional[int]
contact_id_random: Optional[str]
contact_id: Optional[int]
organization_id_random: Optional[str]
organization_id: Optional[int]
user_id_random: Optional[str]
user_id: Optional[int]
membership_person_id_random: Optional[str] # Linked from membership_person using the v_person view
membership_person_id: Optional[int] # Linked from membership_person using the v_person view
pronouns: Optional[str] # Preferred pronouns
informal_name: Optional[str] # Informal or nick name they commonly go by
title_names: Optional[str] # Title for generation, official position, or professional or academic qualification, other honorific, or other name prefix
prefix: Optional[str] # NOTE: Phasing out! Use *title_names* instead.
given_name: Optional[str]
middle_name: Optional[str]
family_name: Optional[str]
designations: Optional[str] # Temporary or long-term designations related to family, relationships, person differentiation (Junior/Senior), location, social status, professional qualifications, legal status, or other name suffix
suffix: Optional[str] # NOTE: Phasing out! Use *designations* instead.
professional_title: Optional[str] # Professional title
display_name: Optional[str] # NOTE: This will be changed to full_name_override to match event_badge, event_presenter, and event_profile
informal_display_name: Optional[str] # Custom what they want for informal public display
professional_display_name: Optional[str] # Custom what they want for professional public display. This should include professional title.
preferred_display_name: Optional[str] # '', 'informal', 'professional'
# BEGIN # Auto created name variations
first_last_name: Optional[str] # With SQL view?
first_middle_last_name: Optional[str] # With SQL view?
last_first_name: Optional[str] # With SQL view?
last_first_middle_name: Optional[str] # With SQL view?
full_name: Optional[str] # title_names given_name middle_name family_name designations
full_name_override: Optional[str] # Override full_name; Actual name shown for person
informal_full_name: Optional[str] # informal_name family_name May be auto created from informal, given, family, etc if not given
professional_full_name: Optional[str] # title_names given_name middle_name family_name designations professional_title
# END # Auto created name variations
affiliations: Optional[str] # One or more affiliations with organizations, companies, and other groups
primary_email: Optional[str]
tagline: Optional[Union[None, str]]
birth_date: Optional[datetime.date]
lu_gender_id: Optional[int]
lu_gender_name: Optional[str]
email_allowed: Optional[bool]
paper_mail_allowed: Optional[bool]
external_id: Optional[str] # Generated internally or externally. Needs to be stable. It should not change.
external_sys_id: Optional[str] # Generated by external system (should be stable and not change)
stripe_customer_id: Optional[str]
allow_auth_key: Optional[bool]
auth_key: Optional[str] # Intended for one time use; more complex
passcode: Optional[str] # For basic quick access; 8 characters or more; can change as needed
status: Optional[str]
# status_id: Optional[int] # From a lookup
# status_name: Optional[str] # Status name from the lookup
hide: Optional[bool]
priority: Optional[bool]
sort: Optional[int]
group: Optional[str]
enable: Optional[bool]
notes: Optional[str]
created_on: Optional[datetime.datetime] = None
updated_on: Optional[datetime.datetime] = None
test_field: str = 'abcd 1234'
# Including convenience data
# This is only for convenience. Probably going to keep unless it causes a problem.
email: Optional[str]
cc_email: Optional[str]
# Maybe add timezone in the future?
username: Optional[str]
user_name: Optional[str]
user_email: Optional[str]
user_allow_auth_key: Optional[bool]
user_super: Optional[bool]
user_manager: Optional[bool]
user_administrator: Optional[bool]
user_public: Optional[bool]
# Including JSON data
data_json: Optional[Json]
other_json: Optional[Json]
meta_json: Optional[Json]
# Including other related objects
# archive_list: Optional[list] # Archive_Base()
event_list: Optional[list] # Event_Base() # Priority l1
hosted_file_list: Optional[list] # Hosted_File_Base() # Priority l2
journal_list: Optional[list[Journal_Base]] # Journal_Base() # Priority l3
contact: Optional[Union[Contact_Base, None]]
membership_person: Optional[Membership_Person_Base]
membership_group_list: Optional[list[Membership_Group_Base]] # Membership_Group_Base() list of member group options
membership_type_list: Optional[list[Membership_Type_Base]] # Membership_Type_Base() list of member type options
# membership_person_type_list: Optional[list] # Membership_Person_Type_Base() list of member type person records... for now this should be only one at most.
# membership_person_group_list: Optional[list] # Membership_Person_Group_Base() list of member group person records
orders_info: Optional[dict] # closed_count, etc
order_list: Optional[list] # Order_Base() # Priority l2
order_cart: Optional[dict] # Order_Cart_Base() # Priority l2
order_cart_v3: Optional[dict] # Order_Base()
organization: Optional[Union[Organization_Base, None]]
post_list: Optional[list] # Post_Base() # Priority l1
# from app.models.user_models import User_Base
user: Optional[Union[User_Base, None]]
_processed_at: datetime.datetime = PrivateAttr(default_factory=datetime.datetime.now)
#@validator('person_id_random', always=True)
def person_id_random_copy(cls, v, values, **kwargs):
log.setLevel(logging.WARNING)
log.debug(locals())
if values['id_random']:
return values['id_random']
return None
@validator('id', always=True)
def person_id_lookup(cls, v, values, **kwargs):
log.setLevel(logging.WARNING)
log.debug(locals())
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='person')
return None
@validator('account_id', always=True)
def account_id_lookup(cls, v, values, **kwargs):
log.setLevel(logging.WARNING)
log.debug(locals())
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('contact_id', always=True)
def contact_id_lookup(cls, v, values, **kwargs):
log.setLevel(logging.WARNING)
log.debug(locals())
if isinstance(v, int) and v > 0: return v
elif id_random := values.get('contact_id_random'):
return redis_lookup_id_random(record_id_random=id_random, table_name='contact')
return None
@validator('organization_id', always=True)
def organization_id_lookup(cls, v, values, **kwargs):
log.setLevel(logging.WARNING)
log.debug(locals())
if isinstance(v, int) and v > 0: return v
elif id_random := values.get('organization_id_random'):
return redis_lookup_id_random(record_id_random=id_random, table_name='organization')
return None
@validator('user_id', always=True)
def user_id_lookup(cls, v, values, **kwargs):
log.setLevel(logging.WARNING)
log.debug(locals())
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
class Config:
underscore_attrs_are_private = True
allow_population_by_field_name = True
fields = base_fields
# ### END ### API Person Models ### Person_Base() ###