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

1from collections.abc import Callable 1 ctx1u

2from logging import Logger 1 ctx1u

3 

4import sqlalchemy.exc 1 ctx1u

5from fastapi import HTTPException, status 1 ctx1u

6from pydantic import UUID4, BaseModel 1 ctx1u

7 

8from mealie.repos.repository_generic import RepositoryGeneric 1 ctx1u

9from mealie.schema.response import ErrorResponse 1 ctx1u

10 

11 

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

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 ctx1u

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

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

28 

29 def __init__( 1 ctx1u

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 22 ctx1trwdmecnsgfjohiapvqlkb

37 self.logger = logger 22 ctx1trwdmecnsgfjohiapvqlkb

38 self.exception_msgs = exception_msgs 22 ctx1trwdmecnsgfjohiapvqlkb

39 

40 if default_message: 22 ctx1trwdmecnsgfjohiapvqlkb

41 self.default_message = default_message 20 ctx1wdmecnsgfjohiapvqlkb

42 

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

44 if self.exception_msgs: 21 ctx1trdmecnsgfjohiapvqlkb

45 return self.exception_msgs(type(ext)) 21 ctx1trdmecnsgfjohiapvqlkb

46 return self.default_message 12 ctx1tdcgfhiapqlb

47 

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

49 # Cleanup 

50 self.logger.exception(ex) 21 ctx1trdmecnsgfjohiapvqlkb

51 self.repo.session.rollback() 21 ctx1trdmecnsgfjohiapvqlkb

52 

53 # Respond 

54 msg = self.get_exception_message(ex) 21 ctx1trdmecnsgfjohiapvqlkb

55 

56 if isinstance(ex, sqlalchemy.exc.NoResultFound): 21 ctx1trdmecnsgfjohiapvqlkb

57 raise HTTPException( 4 ctx1tcab

58 status.HTTP_404_NOT_FOUND, 

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

60 ) 

61 else: 

62 raise HTTPException( 20 ctx1rdmecnsgfjohiapvqlkb

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 ctx1u

68 item: R | None = None 20 ctx1rdmecnsgfjohiapvqlkb

69 try: 20 ctx1rdmecnsgfjohiapvqlkb

70 item = self.repo.create(data) 20 ctx1rdmecnsgfjohiapvqlkb

71 except Exception as ex: 20 ctx1rdmecnsgfjohiapvqlkb

72 self.handle_exception(ex) 20 ctx1rdmecnsgfjohiapvqlkb

73 

74 return item 20 ctx1rdmecnsgfjohiapvqlkb

75 

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

77 item = self.repo.get_one(item_id, key) 16 ctx1trwdcsgfjhiapqkb

78 

79 if not item: 16 ctx1trwdcsgfjhiapqkb

80 raise HTTPException( 9 ctx1trwcghapb

81 status.HTTP_404_NOT_FOUND, 

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

83 ) 

84 

85 return item 11 ctx1rdcsfjipqkb

86 

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

88 item = self.repo.get_one(item_id) 8 ctx1dmecfalb

89 

90 if not item: 8 ctx1dmecfalb

91 raise HTTPException( (empty)

92 status.HTTP_404_NOT_FOUND, 

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

94 ) 

95 

96 try: 8 ctx1dmecfalb

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

98 except Exception as ex: 4 ctx1efab

99 self.handle_exception(ex) 4 ctx1efab

100 

101 return item 6 ctx1dmcalb

102 

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

104 item = self.repo.get_one(item_id) 3 ctx1iab

105 

106 if not item: 3 ctx1iab

107 raise HTTPException( 2 ctx1ab

108 status.HTTP_404_NOT_FOUND, 

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

110 ) 

111 

112 try: 2 ctx1ia

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

114 except Exception as ex: 

115 self.handle_exception(ex) 

116 

117 return item 2 ctx1ia

118 

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

120 item: R | None = None 12 ctx1tdecngjohakb

121 try: 12 ctx1tdecngjohakb

122 item = self.repo.delete(item_id) 12 ctx1tdecngjohakb

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

124 except Exception as ex: 4 ctx1tcab

125 self.handle_exception(ex) 4 ctx1tcab

126 

127 return item 11 ctx1decngjohakb