Coverage for django_napse/utils/serializers/fields.py: 96%

1import uuid 

2from datetime import datetime 

3 

4 

5def instance_check(target_type) -> callable: 

6 def _instance_check(instance, target_type=target_type): 

7 return isinstance(instance, target_type) 

8 

9 return _instance_check 

10 

11 

12class Field: 

13 validate = None 

14 # Define if the getter method takes the serializer as argument. 

15 getter_takes_serializer = False 

16 

17 def __init__(self, required: bool = False, source: str | None = None): 

18 self.required = required 

19 self.source = source 

20 

21 def to_value(self, value): 

22 """Overwrite this method for custom transformation on the serialized value.""" 

23 return value 

24 

25 def as_getter(self, serializer_field_name, serializer_cls) -> None: 

26 """Return a getter method for the field.""" 

27 return 

28 

29 

30class StrField(Field): 

31 to_value: callable = staticmethod(str) 

32 validate: callable = staticmethod(instance_check(str)) 

33 

34 

35class IntField(Field): 

36 to_value: callable = staticmethod(int) 

37 validate: callable = staticmethod(instance_check(int)) 

38 

39 

40class FloatField(Field): 

41 to_value: callable = staticmethod(float) 

42 validate: callable = staticmethod(instance_check(float)) 

43 

44 

45class BoolField(Field): 

46 to_value: callable = staticmethod(bool) 

47 validate: callable = staticmethod(instance_check(bool)) 

48 

49 

50class UUIDField(Field): 

51 to_value: callable = staticmethod(uuid.UUID) 

52 validate: callable = staticmethod(instance_check(uuid.UUID)) 

53 

54 @staticmethod 

55 def to_value(value): 

56 if not isinstance(value, uuid.UUID): 

57 return str(uuid.UUID(value)) 

58 return str(value) 

59 

60 

61class DatetimeField(Field): 

62 # to_value: callable = staticmethod(datetime) 

63 validate: callable = instance_check(datetime) 

64 

65 @staticmethod 

66 def to_value(value): 

67 return value.strftime("%Y-%m-%d %H:%M:%S") 

68 

69 

70class MethodField(Field): 

71 getter_takes_serializer = True 

72 

73 # Avoir type serialization on data 

74 to_value = None 

75 validate = None 

76 

77 def __init__(self, method_name: str | None = None, **kwargs): 

78 super().__init__(**kwargs) 

79 self.method_name = method_name 

80 

81 def as_getter(self, serializer_field_name, serializer_cls) -> callable: 

82 """Get the (get_<field> | method_name) method from the serializer class.""" 

83 return getattr( 

84 serializer_cls, 

85 self.method_name or f"get_{serializer_field_name}", 

86 )