Python lib of tools for Flask and SQLAlchemy
Project description
## Librairie “outil” pour SQLAlchemy et Flask
Cette librairie fournit des décorateurs pour faciliter le développement avec Flask et SQLAlchemy.
Paquet Python : https://pypi.org/project/utils-flask-sqlalchemy/.
Elle est composée de trois outils principaux :
### Les serialisers
Le décorateur de classe @serializable permet la sérialisation JSON d’objets Python issus des classes SQLAlchemy. Il rajoute dynamiquement une méthode as_dict() aux classes qu’il décore. Cette méthode transforme l’objet de la classe en dictionnaire en transformant les types Python non compatibles avec le format JSON. Pour cela, elle se base sur les types des colonnes décrits dans le modèle SQLAlchemy.
Le décorateur @serializable peut être utilisé tel quel, ou être appelé avec les arguments suivants :
exclude (iterable, default=()). Spécifie les colonnes qui doivent être exclues lors de la sérialisation. Par défaut, toutes les colonnes sont sérialisées.
La méthode as_dict() contient les paramètre suivants :
recursif (boolean, default = False) : contrôle si la serialisation doit sérialiser les modèles enfants (relationships) de manière recursive
columns (iterable, default=()). Spécifie les colonnes qui doivent être présentes dans le dictionnaire en sortie. Si non spécifié, le comportement par défaut du décorateur est adopté.
relationships (iterable, default=()). Spécifie les relationnships qui doivent être présentes dans le dictionnaire en sortie. Par défaut toutes les relationships sont prises si recursif=True.
### Les réponses
Le fichier contient des décorateurs de route Flask :
Le décorateur @json_resp transforme l’objet retourné par la fonction en JSON. Renvoie une 404 si la valeur retournée par la fonction est None ou un tableau vide
Le décorateur @json_resp_accept_empty_list transforme l’objet retourné par la fonction en JSON. Renvoie une 404 si la valeur retournée par la fonction est None et 200 si c’est un tableau vide
Le décorateur @csv_resp tranforme l’objet retourné par la fonction en fichier CSV. La fonction doit retourner un tuple de ce format (file_name, data, columns, separator)
### Le mapping à la volée
Le fichier generic contient les classes GenericTable et GenericQuery permettant de faire des requêtes sans définir de modèle au préalable.
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
Built Distribution
Hashes for utils-flask-sqlalchemy-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d7a55c6ba8dc63d21af6374bdbbf3ce4b305aa4ce6890eb23734be0972c0f344 |
|
MD5 | 34628f0df1e25a8118699e253f6c8a16 |
|
BLAKE2b-256 | db9d5a70f660d603de660977e678c3d7cab15c0ae78fdffa19491b0c76c09b05 |
Hashes for utils_flask_sqlalchemy-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 93e18bb565358698ac37cafb85103d6a2c8a2b58f3162756c6c019340c059d66 |
|
MD5 | 480ef4d1eb7d34ca38e6dd4a967e55ca |
|
BLAKE2b-256 | e689dc9c48bd174a74b301aa8aeec746fb33ae4c6ae2be10bb32c489f4b09d65 |