box / box/box-python-sdk

Consider using wrapt with decorators

Đang mở
#168 0 bình luận 0 reaction 0 người được giao Xem trên GitHub
enhancement question
Ngôn ngữ chính
Python
Star
459
Fork
223
Merge trung bình
8 giờ 57 phút
Pull request đã merge (30 ngày)
13

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
python
Lĩnh vực
developer-experience, documentation
Loại issue
Tính năng
Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
35/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.