Coretex
functions.py
1 # Copyright (C) 2023 Coretex LLC
2 
3 # This file is part of Coretex.ai
4 
5 # This program is free software: you can redistribute it and/or modify
6 # it under the terms of the GNU Affero General Public License as
7 # published by the Free Software Foundation, either version 3 of the
8 # License, or (at your option) any later version.
9 
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU Affero General Public License for more details.
14 
15 # You should have received a copy of the GNU Affero General Public License
16 # along with this program. If not, see <https://www.gnu.org/licenses/>.
17 
18 from typing import Optional, Any, Dict
19 
20 
21 def badRequest(error: str) -> Dict[str, Any]:
22  """
23  Creates a json object for bad request
24 
25  Parameters
26  ----------
27  error : str
28  Error message
29 
30  Returns
31  -------
32  dict -> Json object for bad request
33  """
34 
35  return {
36  "code": 400,
37  "body": {
38  "error": error
39  }
40  }
41 
42 
43 def success(data: Optional[Any] = None) -> Dict[str, Any]:
44  """
45  Creates a json object for successful request
46 
47  Parameters
48  ----------
49  data : Optional[Any]
50  Response data
51 
52  Returns
53  -------
54  dict -> Json object for successful request
55  """
56 
57  if data is None:
58  data = {}
59 
60  return {
61  "code": 200,
62  "body": data
63  }