MagicStack / MagicStack/asyncpg

Type hints

Đang mở
#387 1 bình luận 32 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
8.1k
Fork
468
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

Hi there!

I would really appreciate if the methods were defined with correct return data type as specified in PEP-484.

This would help with typing hints where the IDE can correctly determine how to help out with the right methods and variables.

Some examples on places I've stumbled into this:

  • create_ppol should type hint Pool
  • Pool.acquire() should type hint Connection
  • Connection.fetch() should type hint list of Record
  • Connection.fetchrow() should type hint Record or None

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

Bắt đầu bằng cách đọc các định nghĩa của create_ppol, Pool.acquire(), Connection.fetch() và Connection.fetchrow(), sau đó so sánh các chú thích kiểu trả về của chúng với PEP 484. Hoàn thành khi các phương thức được liệt kê cung cấp các kiểu trả về chính xác, bao gồm Pool, Connection, danh sách Record và Record hoặc None.

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

Đánh giá

Công nghệ
postgresql, python
Lĩnh vực
api, databases
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
45/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.