Coverage for functions \ flipdare \ generated \ model \ internal \ analytics_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 

30from flipdare.generated.shared.model.core.analytics_type import AnalyticsType 

31 

32 

33class AnalyticsKeys(StrEnum): 

34 ID = "id" 

35 UPDATED_AT = "updated_at" 

36 CREATED_AT = "created_at" 

37 ANALYTIC_TYPE = "analytic_type" 

38 SOURCE_USER = "source_user" 

39 DEST_USER = "dest_user" 

40 INGESTIBLE = "ingestible" 

41 VERSION = "version" 

42 PROCESSED = "processed" 

43 ERROR_COUNT = "error_count" 

44 

45 

46# !! IMPORTANT !! 

47# !! 

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

49# !! 

50class AnalyticsInternalKeys(StrEnum): 

51 UPDATED_AT = "updated_at" 

52 CREATED_AT = "created_at" 

53 VERSION = "VERSION" 

54 PROCESSED = "INT_P" 

55 ERROR_COUNT = "INT_E" 

56 

57 

58class AnalyticsModel(AppBaseModel): 

59 """Stores app analytics events""" 

60 

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

62 

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

64 updated_at: FirestoreField = Field( 

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

66 ) 

67 created_at: FirestoreField = Field( 

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

69 ) 

70 analytic_type: AnalyticsType 

71 source_user: str 

72 dest_user: str | None = None 

73 ingestible: dict[str, str] 

74 # Version (base internal field) 

75 version: int = Field(default=1, alias="VERSION") 

76 # Processed (base internal field) 

77 processed: bool = Field(default=False, alias="INT_P") 

78 # Error Count (base internal field) 

79 error_count: int = Field(default=0, alias="INT_E") 

80 

81 @classmethod 

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

83 """ 

84 Uses Unpack to give you autocomplete and static warnings 

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

86 

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

88 """ 

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

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

91 if k in cls.__pydantic_fields__: 

92 field_info = cls.__pydantic_fields__[k] 

93 validated_value = cast( 

94 "Any", 

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

96 ) 

97 # Use alias if defined, otherwise use field name 

98 output_key = field_info.alias or k 

99 result[output_key] = validated_value 

100 return result 

101 

102 

103ANALYTICS_FIELD_NAMES: list[str] = list(AnalyticsModel.model_fields.keys()) 

104 

105 

106class AnalyticsDict(TypedDict, total=False): 

107 id: str | None 

108 updated_at: Sentinel | datetime | str 

109 created_at: Sentinel | datetime | str 

110 analytic_type: AnalyticsType 

111 source_user: str 

112 dest_user: str | None 

113 ingestible: dict[str, str] 

114 VERSION: int | None 

115 INT_P: bool | None 

116 INT_E: int | None