responser

Récepteur

Le répondeur est un package Python pour convertir des chaînes normales, des objets et d'autres données pour reposer la convention de réponse API et au format JSON.

Usage

Responser

---

Le répondeur est un package Python pour convertir des chaînes normales, des objets et d'autres données pour reposer la convention de réponse API et au format JSON.

Cette fonction suit la structure JSON suivante.

{
  "status_code" : 200 ,
  "data" : {
    "name" : " Bharath Kumar Ravichandran " ,
    "alma_mater" : " NIT Trichy " ,
    "languages_known" : [
        " Python " ,
        " PHP " ,
        " JS " ,
        " C++ "
    ],
    "cool_guy" : " yes " ,
  },
  "message" : " OK "
}

JSONResponser

• Importer la fonction avec from responser import JSONResponser
• Définition JSONResponser(status_code=400, data=None, message=None, strict_mode=false)
• Le status_code peut être des codes d'état HTTP ou vos propres codes d'état personnalisés.
• Si le status_code est un code d'état HTTP et que les data n'en sont None , une phrase de raison par défaut est ajoutée. (Si strict_mode est False (par défaut))
• Si le status_code est un code d'état HTTP et que le message None , une phrase de raison par défaut est ajoutée. (Même si strict_mode est True (par défaut)).
• Si le status_code n'est pas un code d'état HTTP et que les data n'en sont None , des données vides sont ajoutées.
• Si le status_code n'est pas un code d'état HTTP et que le message None , un message vide est ajouté.
• Si le strict_mode est défini sur True , les données fournies sous forme data sont codées.
• Le status_code est par défaut à 400.

Exemple de code

 from responser import JSONResponser

status_code = 200
data = {
    "name" : "Bharath Kumar Ravichandran" ,
    "alma_mater" : "NIT Trichy" ,
    "languages_known" : [
        "Python" ,
        "PHP" ,
        "JS" ,
        "C++"
    ],
    "cool_guy" : "yes" ,
}
message = "User details returned."

response = JSONResponser ( status_code , data , message )
print response

Sortir

{
  "status_code" : 200 ,
  "data" : {
    "name" : " Bharath Kumar Ravichandran " ,
    "alma_mater" : " NIT Trichy " ,
    "languages_known" : [
        " Python " ,
        " PHP " ,
        " JS " ,
        " C++ "
    ],
    "cool_guy" : " yes " ,
  },
  "message" : " User details returned. "
}

JSONResponserDecorator

• Importer le décorateur avec from responser import JSONResponserDecorator
• Fonction d'enveloppe avec décorateur @JSONResponserDecorator
• JSONResponserDecorator est construit au-dessus de JSONResponser, il suit donc la même convention que JSONResponser .

Exemple de code

 from responser import JSONResponserDecorator

@ JSONResponserDecorator
def sample_function ():

    data = {
        "name" : "Bharath Kumar Ravichandran" ,
        "alma_mater" : "NIT Trichy" ,
        "languages_known" : [
            "Python" ,
            "PHP" ,
            "JS" ,
            "C++"
        ],
        "cool_guy" : "yes" ,
    }

    return data

Données retournées

{
  "status_code" : 200 ,
  "data" : {
    "name" : " Bharath Kumar Ravichandran " ,
    "alma_mater" : " NIT Trichy " ,
    "languages_known" : [
        " Python " ,
        " PHP " ,
        " JS " ,
        " C++ "
    ],
    "cool_guy" : " yes " ,
  },
  "message" : " OK "
}

Inspiré de

Gokulsrinivas / Sangria

Contributeurs

Bharath Kumar Ravichandran

Licence

Mit