ReQBodyMan 1.2.1

ReQBodyMan to easily manage body data received with Request

Project Description

ReQBodyMan is a package that you can use to manage the validations of body data coming with Request more effectively.

Installation

1 Install to Package

For Windows

pip install ReQBodyMan

For Linux/MacOs

pip3 install ReQBodyMan

2 Dependencies Package

flask

Usage

1 Import The Package

from ReQBodyMan.ReQBodyMan import ReQBodyMan

2 ReQBodyMan Create Object

ReQBodyMans = ReQBodyMan()

2 Get Form Data

If the data comes from the request with a form, you can get the data as follows.

Data : string, int, float, boolean, list, dict,  
Parameters : variableName, variableType, booleanType=NoneRequired
booleanType default = "int"
Return: data

data = ReQBodyMans.params(variableName, variableType, booleanType="int")

data = ReQBodyMans.form("variableName", "str")
data = ReQBodyMans.form("variableName", "int")
data = ReQBodyMans.form("variableName", "float")
data = ReQBodyMans.form("variableName", "bool", booleanType="bool")
data = ReQBodyMans.form("variableName", "bool", booleanType="int" )
data = ReQBodyMans.form("variableName", "list")
data = ReQBodyMans.form("variableName", "dict")

If Variable Type is sent outside the specified format, return None.

3 Get Json Data

Data : string, int, float, boolean, list, dict,  
Parameters : variableName, variableType, booleanType=NoneRequired
booleanType default = "int"
Return : Data

data = ReQBodyMans.params(variableName, variableType, booleanType="int")

data = ReQBodyMans.json("variableName", "str")
data = ReQBodyMans.json("variableName", "int")
data = ReQBodyMans.json("variableName", "float")
data = ReQBodyMans.json("variableName", "bool", booleanType="bool")
data = ReQBodyMans.json("variableName", "bool", booleanType="int")
data = ReQBodyMans.json("variableName", "list")
data = ReQBodyMans.json("variableName", "dict")

If Variable Type is sent outside the specified format, return None.

4 Get File

Data : file
Parameters : fileName
Return: file

file = ReQBodyMans.file("fileName")

If FileName is not in request.file, the value "The {fileName} is not in request.files" is returned.

5 Get Params

Data : string, int, float, boolean, list,  
Parameters : variableName, variableType, booleanType=NoneRequired
booleanType default = "int"
Return : data

data = ReQBodyMans.params(variableName, variableType, booleanType="int")

data = ReQBodyMans.params("variableName", "str")
data = ReQBodyMans.params("variableName", "int")
data = ReQBodyMans.params("variableName", "float")
data = ReQBodyMans.params("variableName", "bool", booleanType="bool")
data = ReQBodyMans.params("variableName", "bool", booleanType="int")
data = ReQBodyMans.params("variableName", "list")

6 GetAllData Function

Data : string, int, float, boolean, list, file,  
Parameters : bodyJson
variableName : Variable name in body data 
bodyType :  form, json, params, file
booleanType: int, bool
Return : allVariablesJson

data = ReQBodyMans.getAllData(bodyJson)

bodyJson = {

    "variableName" : ["bodyType", "variableType", "booleanType"]
}

# BodyType Json

bodyJson = {
    
    "password"  : ["json", "str"],
    "email"     : ["json", "str"]
}

# Boolean Type Usage 

bodyJson = {
    
    "password"  : ["json", "str"],
    "email"     : ["json", "str"],
    "status"    : ["json", "str", "int"]
    "status2"   : ["json", "str", "bool"]
}

# BodyType Form

bodyJson = {
    
    "password"  : ["form", "str"],
    "email"     : ["form", "str"],
    "status"    : ["form", "str", "int"]
    "status2"   : ["form", "str", "bool"]
    "fileName"  : ["file"] 
}

# BodyForm Params

bodyJson = {
    
    "password"  : ["params", "str"],
    "email"     : ["params", "str"],
    "status"    : ["params", "str", "int"]
    "status2"   : ["params", "str", "bool"] 
}

data = ReQBodyMans.getAllData(bodyJson)

Return data content 

{
    "email" : "[e-mail]",
    "password":"test2",
    "status" : "1" or "0",
    "status2" : True or False,
    "fileName" : file
}

If Variable Type is sent outside the specified format, return None.

Release Note

v.1.2.1

1. ReadMe file updated

v1.2.0

1. getAllData Function Added
   • Allows you to send all the data at once and receive the data as a dictionary

v.1.1.0

1. Added dict property to Params.
2. Added dict property to Json
3. The return value for bool type has been added to return int or bool type according to the value to be given with booleanType.
4. Code refactor.

v.1.0.1

1. ReadMe file updated

v.1.0.0

1. Project published.

ReQBodyMan is a BrainyTech Product.

Developer : Murat Bilginer