Skip to content

Commit

Permalink
CTX-4793: Moved functions related code to top-level module "functions…
Browse files Browse the repository at this point in the history
…" and added documentation
  • Loading branch information
Vuk Manojlovic committed Oct 27, 2023
1 parent 5ba368c commit 133a411
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 20 deletions.
46 changes: 46 additions & 0 deletions coretex/functions.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
from typing import Optional, Any, Dict


def badRequest(error: str) -> Dict[str, Any]:
"""
Creates a json object for bad request
Parameters
----------
error : str
Error message
Returns
-------
dict -> Json object for bad request
"""

return {
"code": 400,
"body": {
"error": error
}
}


def success(data: Optional[Any] = None) -> Dict[str, Any]:
"""
Creates a json object for successful request
Parameters
----------
data : Optional[Any]
Response data
Returns
-------
dict -> Json object for successful request
"""

if data is None:
data = {}

return {
"code": 200,
"body": data
}
1 change: 0 additions & 1 deletion coretex/networking/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,3 @@
from .request_type import RequestType
from .chunk_upload_session import ChunkUploadSession, MAX_CHUNK_SIZE
from .file_data import FileData
from .utils import badRequest, success
19 changes: 0 additions & 19 deletions coretex/networking/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -66,22 +66,3 @@ def logRequestFailure(endpoint: str, response: NetworkResponse) -> None:
logging.getLogger("coretexpylib").debug(f"\tResponse: {responseJson}")
except (ValueError, TypeError):
logging.getLogger("coretexpylib").debug(f"\tResponse: {response.getContent()!r}")


def badRequest(error: str) -> Dict[str, Any]:
return {
"code": 400,
"body": {
"error": error
}
}


def success(data: Optional[Any] = None) -> Dict[str, Any]:
if data is None:
data = {}

return {
"code": 200,
"body": data
}

0 comments on commit 133a411

Please sign in to comment.