mailbox: document Message vs EmailMessage situation
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 77.2k
- Fork
- 36k
- Chỉ số merge pull request
- Chỉ số pull request đang chờ
Mô tả
Documentation
If I read the email documentation, it makes a clear case for staying away from email.Message:
The foregoing represent the modern (unicode friendly) API of the email package. The remaining sections, starting with the Message class, cover the legacy compat32 API that deals much more directly with the details of how email messages are represented. The compat32 API does not hide the details of the RFCs from the application, but for applications that need to operate at that level, they can be useful tools. This documentation is also relevant for applications that are still using the compat32 API for backward compatibility reasons.
Changed in version 3.6: Docs reorganized and rewritten to promote the new EmailMessage/EmailPolicy API.
And indeed, there are common tasks that are hard to do in email.Message and easy with EmailMessage (see get_body() for a very common use case).
However in the documentation of mailbox, email.Message is mentioned like it's the standard.
Since at the moment in the standard library, with regards to email handling, the rule "There should be one-- and preferably only one --obvious way to do it." seems to be violated, and there are several classes with confusingly similar names but very different roles (mailbox.Message, email.Message, email.message.EmailMessage) it would help to have a clarification of the situation in the documentation of mailbox, at least until #77156 happens.
I don't know enough of the background that led to this situation to be able to draft a serious proposal for the documentation, but I guess something along the lines of this could be an initial draft:
There are currently two distinct classes for handling emails:
email.Message(deprecated), andemail.message.EmailMessage. The latter is more featureful and easier to use, but themailboxmodule still has not been updated to transition to it.
mailboxsubclasses the deprecatedemail.Messageasmailbox.Message, to act as the base hierarchy for messages read from mailboxes.
It is expected thatmailbox.Messagewill become a subclass ofemail.message.EmailMessagein a future version of Python [insert API compatibility notes].
Hướng dẫn đóng góp
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 với tài liệu của mô-đun mailbox và so sánh các tham chiếu của tài liệu này đến email.Message với tài liệu của gói email về EmailMessage và compat32 API. Xem xét mối quan hệ giữa mailbox.Message, email.Message và email.message.EmailMessage, sau đó làm rõ vai trò và trạng thái di chuyển của chúng trong tài liệu mailbox. Công việc được xem là hoàn tất khi tài liệu giải thích ứng dụng nên sử dụng lớp nào và vì sao mailbox vẫn cung cấp hệ phân cấp cũ.
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ó
- 3/5
- Thời gian dự kiến
- 1-2 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
- 48/100