...
Project description
Django Utilitybox
Managment software by 'On road Rescues': Stable Version.
Installation
pip install django-utilitybox
Usage
Raise Exception
from django_utilitybox.response import raise_response as rres
This utility makes it easier to return errors in DRF. Giving a default message and a status. The options are as follows.
| Class | Status | Message | Use cases |
|---|---|---|---|
QueryParamNotFound |
400 | Queryparam '{field}' is required |
Used when a query param is not found in the url |
KwargNotFound |
400 | Kwarg '{field}' is required |
Used when a kwarg is not found |
ModelNotFound |
400 | {field} don't exist |
Used when a model is not found |
CustomRaise |
400 | |
Se usa cuando se quiere mandar un mensaje personalizado |
Use cases
class ResponseTest(APIView):
def get(self, *args, **kwargs):
data:dict = self.request.GET
param = data.get('case')
match param:
case '1': rres.QueryParamNotFound('id')
case '2': rres.KwargNotFound ('data')
case '3': rres.ModelNotFound('Rescue')
case '4': rres.CustomRaise('Custom message')
return Response({'message': 'Successful.'}, status=st.HTTP_200_OK)
Returns
| Class | Status | Message |
|---|---|---|
QueryParamNotFound |
400 | Queryparam 'id' is required |
KwargNotFound |
400 | Kwarg 'data' is required |
ModelNotFound |
400 | Rescue don't exist |
CustomRaise |
400 | Custom message |
Json returned
HTTP 400 Bad Request
{
"status": "{message}"
}
Modifiable parameters
WIP
Used By
This project is used by the following companies:
- AETO Software
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file django_utilitybox-0.1.2.tar.gz.
File metadata
- Download URL: django_utilitybox-0.1.2.tar.gz
- Upload date:
- Size: 9.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7e1b878cc04b8527f6a89d5a4f838890f12ac322bf7a5a9a81e9bb4d82ebc8a4
|
|
| MD5 |
eb344900e374f7d9b92df6216e0e6df9
|
|
| BLAKE2b-256 |
e1f49643d4c5f3a247c5fd8e4222f41c7dd053ef199af926d8d0fef0a23aa23a
|