python / python/pyperformance

Add type hints?

Đang mở
#282 0 bình luận 4 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
Python
Star
1k
Fork
203
Merge trung bình
1 giờ 20 phút
Pull request đã merge (30 ngày)
2

Mô tả

How would we feel about adding type hints to the pyperformance codebase?

Running a type checker on pyperformance might catch some bugs. But more importantly, in my opinion, it would make some parts of the code base a lot easier to read and reason about -- it would be self-evident what kind of object is being accepted and returned by various functions.

There are various tools that we could use to add "obvious" type hints quickly to the code base, such as autotyping and MonkeyType.

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

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Không có tệp hoặc bài kiểm thử nào được nêu. Hãy bắt đầu bằng cách xem xét codebase pyperformance và đánh giá autotyping cùng MonkeyType như những điểm khởi đầu khả thi. Công việc được xem là hoàn tất khi đã thống nhất phạm vi bổ sung type hint và một phương pháp kiểm tra kiểu giúp cải thiện khả năng đọc cũng như có thể phát hiện lỗi.

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
tooling
Loại issue
Tái cấu trúc
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
25/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.