python / python/importlib_metadata

`packages_distributions` relies on setuptools implementation detail

Đang mở Phù hợp với người mới
#526 6 bình luận 0 reaction 0 người được giao Xem trên GitHub

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

documentation help wanted
Ngôn ngữ chính
Python
Star
142
Fork
97
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Mô tả

This is a follow-up to https://github.com/python/importlib_metadata/issues/402.

packages_distributions reads top_level.txt to determine the names. This file isn't part of any PEP and to my knowledge only implemented by setuptools, as a historical artifact from eggs. This leads users to believe that build backends not supporting this function have a bug (https://github.com/astral-sh/uv/issues/16423).

Would it be possible to update the documentation to accurately reflect that this is not a problem with some PEP 660 build backends not supplying top-level names, but that this function is generally not expected to work with editable installs at all, with the historical exception of setuptools?

(This may change with PEP 794)

https://github.com/python/importlib_metadata/blob/95ecf2aa573a68d4624506f801ca70992a337f41/importlib_metadata/__init__.py#L1133-L1134

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 tài liệu về packages_distributions và phần được liên kết trong importlib_metadata/init.py. Cập nhật tài liệu để giải thích rằng nhìn chung các bản cài đặt editable không được kỳ vọng sẽ cung cấp các tên cấp cao nhất, trong đó setuptools là ngoại lệ mang tính lịch sử, đồng thời lưu ý đến tác động có thể xảy ra trong tương lai của PEP 794.

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
documentation
Loại issue
Tài liệu
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
68/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.