Coverage for functions \ flipdare \ generated \ model \ search \ result_hint_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 typing import Any, TypedDict, cast, Unpack 

23from enum import StrEnum 

24from pydantic import ConfigDict, TypeAdapter 

25from flipdare.firestore.core.app_base_model import AppBaseModel 

26 

27 

28class ResultHintKeys(StrEnum): 

29 TEXT = "text" 

30 MATCHED = "matched" 

31 START = "start" 

32 END = "end" 

33 

34 

35class ResultHintModel(AppBaseModel): 

36 """The position of the match in the search result.""" 

37 

38 model_config = ConfigDict(populate_by_name=True) 

39 

40 text: str 

41 matched: str 

42 start: int 

43 end: int 

44 

45 @classmethod 

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

47 """ 

48 Uses Unpack to give you autocomplete and static warnings 

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

50 

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

52 """ 

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

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

55 if k in cls.__pydantic_fields__: 

56 field_info = cls.__pydantic_fields__[k] 

57 validated_value = cast( 

58 "Any", 

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

60 ) 

61 # Use alias if defined, otherwise use field name 

62 output_key = field_info.alias or k 

63 result[output_key] = validated_value 

64 return result 

65 

66 

67RESULTHINT_FIELD_NAMES: list[str] = list(ResultHintModel.model_fields.keys()) 

68 

69 

70class ResultHintDict(TypedDict, total=False): 

71 text: str 

72 matched: str 

73 start: int 

74 end: int