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. 

5The API also supports collection of Automation Intelligence for requests to your server in edge, pre-origin, or middleware contexts. 

6 

7The version of the OpenAPI document: 4 

8Contact: support@fingerprint.com 

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

10 

11Do not edit the class manually. 

12""" # noqa: E501 

13 

14from __future__ import annotations 

15 

16import json 

17import pprint 

18import re # noqa: F401 

19from typing import Any, ClassVar, Optional 

20 

21from pydantic import BaseModel, ConfigDict 

22from typing_extensions import Self 

23 

24from fingerprint_server_sdk.models.ip_info_v4 import IPInfoV4 

25from fingerprint_server_sdk.models.ip_info_v6 import IPInfoV6 

26 

27 

28class IPInfo(BaseModel): 

29 """ 

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

31 """ 

32 

33 v4: Optional[IPInfoV4] = None 

34 v6: Optional[IPInfoV6] = None 

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

36 

37 model_config = ConfigDict( 

38 populate_by_name=True, 

39 validate_assignment=True, 

40 protected_namespaces=(), 

41 ) 

42 

43 def to_str(self) -> str: 

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

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

46 

47 def to_json(self) -> str: 

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

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

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

51 

52 @classmethod 

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

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

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

56 

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

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

59 

60 This has the following differences from calling pydantic's 

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

62 

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

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

65 are ignored. 

66 """ 

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

68 

69 _dict = self.model_dump( 

70 by_alias=True, 

71 exclude=excluded_fields, 

72 exclude_none=True, 

73 ) 

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

75 if self.v4: 

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

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

78 if self.v6: 

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

80 return _dict 

81 

82 @classmethod 

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

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

85 if obj is None: 

86 return None 

87 

88 if not isinstance(obj, dict): 

89 return cls.model_validate(obj) 

90 

91 _obj = cls.model_validate( 

92 { 

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

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

95 } 

96 ) 

97 return _obj