box / box/box-python-sdk

Consider using wrapt with decorators

Ouverte
#168 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
enhancement question
Langage dominant
Python
Étoiles
459
Forks
223
Merge moyen
8 h 57 min
PR mergées (30 j)
13

Description

Now that we're using `@api_call` with all of our methods, they no longer can be introspected properly. For example, see http://box-python-sdk.readthedocs.io/en/latest/boxsdk.object.html#boxsdk.object.base_object.BaseObject.get .

We could potentially use wrapt (https://pypi.python.org/pypi/wrapt) to fix this. See https://github.com/GrahamDumpleton/wrapt/tree/develop/blog for more info.

Though this would potentially slow down the SDK code, so it might or might not be worth it. Perhaps it can be enabled when generating docs or using the terminal, but disabled otherwise.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par le décorateur @api_call et comparez le comportement documenté de BaseObject.get avec le problème d’introspection décrit dans la documentation liée. Lisez le contenu de référence sur wrapt, puis déterminez si la préservation de l’introspection vaut le coût potentiel en performances du SDK et si le comportement devrait différer pour la documentation ou l’utilisation dans le terminal.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
developer-experience, documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.