khushalps
7fdd2411bb
git-subtree-dir: utils_v2 git-subtree-split: 62600ef57051e69587da18015b7b6840fdac3194
143 lines
5.3 KiB
Python
143 lines
5.3 KiB
Python
"""
|
|
|
|
AUTHOR:
|
|
|
|
Khushal P Soonderji
|
|
|
|
DATE:
|
|
|
|
Monday, 16th Dec., 2024.
|
|
|
|
OBJECTIVE:
|
|
|
|
To provide a data model for giving a general structure to API responses.
|
|
|
|
REFERENCES:
|
|
|
|
N/A
|
|
|
|
DOWNLOADS:
|
|
|
|
N/A
|
|
|
|
"""
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** IMPORT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# To make sibling directories accessible for imports:
|
|
import sys
|
|
sys.path.append(".")
|
|
sys.path.append("..")
|
|
|
|
# For making data behaviour_models:
|
|
from pydantic import BaseModel, Field, field_validator, model_validator
|
|
from typing import Optional, Literal, Union, Dict, List, Any
|
|
|
|
# My utils:
|
|
from utils_v2.string import json
|
|
from utils_v2.string import regex
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MACROS / ONE-TIME INIT ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** VARIABLES ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
# --- Nothing Yet
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** FUNCTIONS ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
class ApiResponse(BaseModel):
|
|
|
|
action: str = Field(
|
|
description = "to know what was being done; initially intended to just hold the name of the calling function",
|
|
frozen = True,
|
|
default = None
|
|
)
|
|
|
|
requestId: str | int | None = None
|
|
|
|
url: str = Field(frozen = True)
|
|
method: str = Field(frozen = True)
|
|
response: Any = None
|
|
httpCode: int = None
|
|
|
|
requestHeaders: dict | None = None
|
|
requestParams: dict | None = None
|
|
requestJson: dict | None = None
|
|
requestData: Any | None = None
|
|
requestContent: Any | None = None
|
|
|
|
success: bool = False
|
|
message: str = None
|
|
data: Any = None
|
|
|
|
exception: Any = None
|
|
|
|
# ┏┓ ┏•
|
|
# ┃ ┏┓┏┓╋┓┏┓
|
|
# ┗┛┗┛┛┗┛┗┗┫
|
|
# ┛
|
|
|
|
class Config:
|
|
extra = "forbid"
|
|
|
|
# ┏┓ ┏┓
|
|
# ┃ ┓┏┏╋┏┓┏┳┓ ┣ ┓┏┏┓┏┏
|
|
# ┗┛┗┻┛┗┗┛┛┗┗ ┻ ┗┻┛┗┗┛
|
|
|
|
def to_markdown(self):
|
|
if self.exception: message = "❌ *API EXCEPTION:* ❌\n\n"
|
|
else: message = "*API RESPONSE:*\n\n"
|
|
message += f"*ACTION:*\n`{self.action}`\n\n"
|
|
message += f"*URL:*\n`{self.url}`\n\n"
|
|
message += f"*METHOD:*\n`{self.method}`\n\n"
|
|
message += f"*RESPONSE:*\n`{self.response}`\n\n"
|
|
message += f"*MESSAGE:*\n`{self.message}`\n\n"
|
|
message += f"*EXCEPTION:*\n`{self.exception.__class__.__name__}: {str(self.exception)}`\n\n"
|
|
return message
|
|
|
|
async def get_json(self):
|
|
try: return self.response.json()
|
|
except: return {}
|
|
|
|
async def get_content(self):
|
|
try: return self.response.content
|
|
except: return b""
|
|
|
|
|
|
# *****************************************************************************************************************
|
|
# ***** ****
|
|
# *** MAIN PROGRAM ***
|
|
# ***** ****
|
|
# *****************************************************************************************************************
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
pass
|