Coverage for opt/mealie/lib/python3.12/site-packages/mealie/routes/_base/mixins.py: 95%

1from collections.abc import Callable 1 ctx1m

2from logging import Logger 1 ctx1m

3 

4import sqlalchemy.exc 1 ctx1m

5from fastapi import HTTPException, status 1 ctx1m

6from pydantic import UUID4, BaseModel 1 ctx1m

7 

8from mealie.repos.repository_generic import RepositoryGeneric 1 ctx1m

9from mealie.schema.response import ErrorResponse 1 ctx1m

10 

11 

12class HttpRepo[C: BaseModel, R: BaseModel, U: BaseModel]: 1 ctx1m

13 """ 

14 The HttpRepo[C, R, U] class is a mixin class that provides a common set of methods for CRUD operations. 

15 This class is intended to be used in a composition pattern where a class has a mixin property. For example: 

16 

17 ``` 

18 class MyClass: 

19 def __init__(self, repo, logger): 

20 self.mixins = HttpRepo(repo, logger) 

21 ``` 

22 

23 """ 

24 

25 repo: RepositoryGeneric 1 ctx1m

26 exception_msgs: Callable[[type[Exception]], str] | None 1 ctx1m

27 default_message: str = "An unexpected error occurred." 1 ctx1m

28 

29 def __init__( 1 ctx1m

30 self, 

31 repo: RepositoryGeneric, 

32 logger: Logger, 

33 exception_msgs: Callable[[type[Exception]], str] | None = None, 

34 default_message: str | None = None, 

35 ) -> None: 

36 self.repo = repo 18 ctx1psrjbdflhcegnoikqa

37 self.logger = logger 18 ctx1psrjbdflhcegnoikqa

38 self.exception_msgs = exception_msgs 18 ctx1psrjbdflhcegnoikqa

39 

40 if default_message: 18 ctx1psrjbdflhcegnoikqa

41 self.default_message = default_message 14 ctx1jbdflhcegnoika

42 

43 def get_exception_message(self, ext: Exception) -> str: 1 ctx1m

44 if self.exception_msgs: 16 ctx1pjbdflhcegnoikqa

45 return self.exception_msgs(type(ext)) 15 ctx1pjbdflcegnoikqa

46 return self.default_message 11 ctx1bdlhcegnoia

47 

48 def handle_exception(self, ex: Exception) -> None: 1 ctx1m

49 # Cleanup 

50 self.logger.exception(ex) 16 ctx1pjbdflhcegnoikqa

51 self.repo.session.rollback() 16 ctx1pjbdflhcegnoikqa

52 

53 # Respond 

54 msg = self.get_exception_message(ex) 16 ctx1pjbdflhcegnoikqa

55 

56 if isinstance(ex, sqlalchemy.exc.NoResultFound): 16 ctx1pjbdflhcegnoikqa

57 raise HTTPException( 3 ctx1dha

58 status.HTTP_404_NOT_FOUND, 

59 detail=ErrorResponse.respond(message=msg, exception=str(ex)), 

60 ) 

61 else: 

62 raise HTTPException( 16 ctx1pjbdflhcegnoikqa

63 status.HTTP_400_BAD_REQUEST, 

64 detail=ErrorResponse.respond(message=msg, exception=str(ex)), 

65 ) 

66 

67 def create_one(self, data: C) -> R | None: 1 ctx1m

68 item: R | None = None 17 ctx1psjbdflhcegnoikqa

69 try: 17 ctx1psjbdflhcegnoikqa

70 item = self.repo.create(data) 17 ctx1psjbdflhcegnoikqa

71 except Exception as ex: 16 ctx1pjbdflhcegnoikqa

72 self.handle_exception(ex) 16 ctx1pjbdflhcegnoikqa

73 

74 return item 17 ctx1psjbdflhcegnoikqa

75 

76 def get_one(self, item_id: int | str | UUID4, key: str | None = None) -> R: 1 ctx1m

77 item = self.repo.get_one(item_id, key) 6 ctx1bdlcga

78 

79 if not item: 6 ctx1bdlcga

80 raise HTTPException( (empty)

81 status.HTTP_404_NOT_FOUND, 

82 detail=ErrorResponse.respond(message="Not found."), 

83 ) 

84 

85 return item 6 ctx1bdlcga

86 

87 def update_one(self, data: U, item_id: int | str | UUID4) -> R: 1 ctx1m

88 item = self.repo.get_one(item_id) 6 ctx1rfceia

89 

90 if not item: 6 ctx1rfceia

91 raise HTTPException( 2 ctx1ra

92 status.HTTP_404_NOT_FOUND, 

93 detail=ErrorResponse.respond(message="Not found."), 

94 ) 

95 

96 try: 6 ctx1rfceia

97 item = self.repo.update(item_id, data) # type: ignore 6 ctx1rfceia

98 except Exception as ex: (empty)

99 self.handle_exception(ex) (empty)

100 

101 return item 6 ctx1rfceia

102 

103 def patch_one(self, data: U, item_id: int | str | UUID4) -> R: 1 ctx1m

104 item = self.repo.get_one(item_id) 2 ctx1ba

105 

106 if not item: 106 ↛ 107line 106 didn't jump to line 107 because the condition on line 106 was never true2 ctx1ba

107 raise HTTPException( 

108 status.HTTP_404_NOT_FOUND, 

109 detail=ErrorResponse.respond(message="Not found."), 

110 ) 

111 

112 try: 2 ctx1ba

113 item = self.repo.patch(item_id, data.model_dump(exclude_unset=True, exclude_defaults=True)) 2 ctx1ba

114 except Exception as ex: 

115 self.handle_exception(ex) 

116 

117 return item 2 ctx1ba

118 

119 def delete_one(self, item_id: int | str | UUID4) -> R | None: 1 ctx1m

120 item: R | None = None 10 ctx1jbdfhcegka

121 try: 10 ctx1jbdfhcegka

122 item = self.repo.delete(item_id) 10 ctx1jbdfhcegka

123 self.logger.info(f"Deleting item with id {item_id}") 10 ctx1jbdfhcegka

124 except Exception as ex: 3 ctx1dha

125 self.handle_exception(ex) 3 ctx1dha

126 

127 return item 10 ctx1jbdfhcegka