Coverage for fingerprint_server_sdk / models / ip_info.py: 68%

1""" 

2Server API 

3Fingerprint Server API allows you to get, search, and update Events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. 

4Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. 

5 

6The version of the OpenAPI document: 4 

7Contact: support@fingerprint.com 

8Generated by OpenAPI Generator (https://openapi-generator.tech) 

9 

10Do not edit the class manually. 

11""" # noqa: E501 

12 

13from __future__ import annotations 

14 

15import json 

16import pprint 

17import re # noqa: F401 

18from typing import Any, ClassVar, Optional 

19 

20from pydantic import BaseModel, ConfigDict 

21from typing_extensions import Self 

22 

23from fingerprint_server_sdk.models.ip_info_v4 import IPInfoV4 

24from fingerprint_server_sdk.models.ip_info_v6 import IPInfoV6 

25 

26 

27class IPInfo(BaseModel): 

28 """ 

29 Details about the request IP address. Has separate fields for v4 and v6 IP address versions. 

30 """ 

31 

32 v4: Optional[IPInfoV4] = None 

33 v6: Optional[IPInfoV6] = None 

34 __properties: ClassVar[list[str]] = ['v4', 'v6'] 

35 

36 model_config = ConfigDict( 

37 populate_by_name=True, 

38 validate_assignment=True, 

39 protected_namespaces=(), 

40 ) 

41 

42 def to_str(self) -> str: 

43 """Returns the string representation of the model using alias""" 

44 return pprint.pformat(self.model_dump(by_alias=True)) 

45 

46 def to_json(self) -> str: 

47 """Returns the JSON representation of the model using alias""" 

48 # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead 

49 return json.dumps(self.to_dict()) 

50 

51 @classmethod 

52 def from_json(cls, json_str: str) -> Optional[Self]: 

53 """Create an instance of IPInfo from a JSON string""" 

54 return cls.from_dict(json.loads(json_str)) 

55 

56 def to_dict(self) -> dict[str, Any]: 

57 """Return the dictionary representation of the model using alias. 

58 

59 This has the following differences from calling pydantic's 

60 `self.model_dump(by_alias=True)`: 

61 

62 * `None` is only added to the output dict for nullable fields that 

63 were set at model initialization. Other fields with value `None` 

64 are ignored. 

65 """ 

66 excluded_fields: set[str] = set([]) 

67 

68 _dict = self.model_dump( 

69 by_alias=True, 

70 exclude=excluded_fields, 

71 exclude_none=True, 

72 ) 

73 # override the default output from pydantic by calling `to_dict()` of v4 

74 if self.v4: 

75 _dict['v4'] = self.v4.to_dict() 

76 # override the default output from pydantic by calling `to_dict()` of v6 

77 if self.v6: 

78 _dict['v6'] = self.v6.to_dict() 

79 return _dict 

80 

81 @classmethod 

82 def from_dict(cls, obj: Optional[dict[str, Any]]) -> Optional[Self]: 

83 """Create an instance of IPInfo from a dict""" 

84 if obj is None: 

85 return None 

86 

87 if not isinstance(obj, dict): 

88 return cls.model_validate(obj) 

89 

90 _obj = cls.model_validate( 

91 { 

92 'v4': IPInfoV4.from_dict(obj['v4']) if obj.get('v4') is not None else None, 

93 'v6': IPInfoV6.from_dict(obj['v6']) if obj.get('v6') is not None else None, 

94 } 

95 ) 

96 return _obj