Coverage for functions \ flipdare \ generated \ model \ internal \ location_model.py: 100%

1#!/usr/bin/env python 

2# 

3# Copyright (c) 2026 Flipdare Pty Ltd. All rights reserved. 

4# 

5# This file is part of Flipdare's proprietary software and contains 

6# confidential and copyrighted material. Unauthorised copying, 

7# modification, distribution, or use of this file is strictly 

8# prohibited without prior written permission from Flipdare Pty Ltd. 

9# 

10# This software includes third-party components licensed under MIT, 

11# BSD, and Apache 2.0 licences. See THIRD_PARTY_NOTICES for details. 

12# 

13# NOTE: THIS FILE IS AUTO GENERATED. DO NOT EDIT. 

14# 

15# Generated by codegen_models.py 

16# 

17# Modify 'codegen_models.py' 

18# and re-run the script above to update. 

19# 

20# pragma: no cover 

21from __future__ import annotations 

22from datetime import datetime 

23from google.cloud.firestore_v1.transforms import Sentinel 

24from flipdare.core.firestore_field import FirestoreField 

25from flipdare.util.time_util import FirestoreTime 

26from typing import Any, TypedDict, cast, Unpack 

27from enum import StrEnum 

28from pydantic import Field, ConfigDict, TypeAdapter 

29from flipdare.firestore.core.app_base_model import AppBaseModel 

30 

31 

32class LocationKeys(StrEnum): 

33 ID = "id" 

34 UPDATED_AT = "updated_at" 

35 CREATED_AT = "created_at" 

36 COUNTRY = "country" 

37 COUNTRY_CODE = "country_code" 

38 STATE = "state" 

39 CITY = "city" 

40 REGION = "region" 

41 STREET = "street" 

42 HOUSE_NUMBER = "house_number" 

43 POSTAL_CODE = "postal_code" 

44 UTC_OFFSET = "utc_offset" 

45 DST_OFFSET = "dst_offset" 

46 LATITUDE = "latitude" 

47 LONGITUDE = "longitude" 

48 FORMATTED_ADDRESS = "formatted_address" 

49 

50 

51# !! IMPORTANT !! 

52# !! 

53# !! this should only be used in the database to query. 

54# !! 

55class LocationInternalKeys(StrEnum): 

56 UPDATED_AT = "updated_at" 

57 CREATED_AT = "created_at" 

58 

59 

60class LocationModel(AppBaseModel): 

61 """Represents a geographical location with various levels of detail.""" 

62 

63 model_config = ConfigDict(populate_by_name=True, arbitrary_types_allowed=True) 

64 

65 id: str | None = Field(None, alias="id") 

66 updated_at: FirestoreField = Field( 

67 default_factory=cast("Any", lambda: FirestoreTime.server_timestamp()) 

68 ) 

69 created_at: FirestoreField = Field( 

70 default_factory=cast("Any", lambda: FirestoreTime.server_timestamp()) 

71 ) 

72 country: str 

73 country_code: str 

74 state: str | None = None 

75 city: str | None = None 

76 region: str | None = None 

77 street: str | None = None 

78 house_number: str | None = None 

79 postal_code: str | None = None 

80 utc_offset: float 

81 dst_offset: float 

82 latitude: float 

83 longitude: float 

84 formatted_address: str | None = None 

85 

86 @classmethod 

87 def validate_partial(cls, **data: Unpack[LocationDict]) -> dict[str, Any]: 

88 """ 

89 Uses Unpack to give you autocomplete and static warnings 

90 if you pass an invalid key or type in your code. 

91 

92 Returns a dict with Firestore field names (aliases) for use with batch.update(). 

93 """ 

94 result: dict[str, Any] = {} 

95 for k, v in data.items(): 

96 if k in cls.__pydantic_fields__: 

97 field_info = cls.__pydantic_fields__[k] 

98 validated_value = cast( 

99 "Any", 

100 TypeAdapter(field_info.annotation).validate_python(v), 

101 ) 

102 # Use alias if defined, otherwise use field name 

103 output_key = field_info.alias or k 

104 result[output_key] = validated_value 

105 return result 

106 

107 

108LOCATION_FIELD_NAMES: list[str] = list(LocationModel.model_fields.keys()) 

109 

110 

111class LocationDict(TypedDict, total=False): 

112 id: str | None 

113 updated_at: Sentinel | datetime | str 

114 created_at: Sentinel | datetime | str 

115 country: str 

116 country_code: str 

117 state: str | None 

118 city: str | None 

119 region: str | None 

120 street: str | None 

121 house_number: str | None 

122 postal_code: str | None 

123 utc_offset: float 

124 dst_offset: float 

125 latitude: float 

126 longitude: float 

127 formatted_address: str | None