openzim / openzim/python-scraperlib
Calls to third party code not respecting type hints
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 31
- Fork
- 27
- Merge trung bình
- 3 ngày 7 giờ
- Pull request đã merge (30 ngày)
- 2
Mô tả
Following #227, scraperlib users are not allowed to send values of unexpected types to our API.
We should apply the same strict treatment to our usage of other's APIs.
beartype allows setting this in our code and raising or warning on incorrect calls. Once we fix the codebase, we would keep it and it would serve as automated test for this.
Hướng dẫn đóng góp
Chưa lập chỉ mục được hướng dẫn đóng góp cho kho mã nguồn này
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Bắt đầu bằng cách xem xét codebase của scraperlib để tìm các lệnh gọi đến API của bên thứ ba và việc thực thi type hint được mô tả trong #227. Sử dụng beartype để xác định các lệnh gọi không chính xác; hoàn thành có nghĩa là codebase vượt qua bước kiểm tra này mà không có kiểu đối số ngoài dự kiến, đồng thời giữ lại các bước kiểm tra dưới dạng các bài kiểm thử tự động.
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
- api
- Loại issue
- Tái cấu trúc
- Độ 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
- 38/100