Consider using wrapt with decorators
- Dominant language
- Python
- Stars
- 459
- Forks
- 223
- Avg merge
- 8h 57m
- Merged PRs (30d)
- 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.
Contributor guide
Research direction
Start at the @api_call decorator and compare the documented BaseObject.get behavior with the introspection issue described in the linked documentation. Read the referenced wrapt material, then determine whether preserving introspection is worth the potential SDK performance cost and whether behavior should differ for documentation or terminal use.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- developer-experience, documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100