mailbox: document Message vs EmailMessage situation
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 48/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia dalla documentazione del modulo mailbox e confronta i suoi riferimenti a email.Message con la documentazione del pacchetto email relativa a EmailMessage e alla compat32 API. Esamina la relazione tra mailbox.Message, email.Message e email.message.EmailMessage, quindi chiarisci i loro ruoli e lo stato della migrazione nella documentazione di mailbox. Il lavoro è completato quando la documentazione spiega quale classe dovrebbero usare le applicazioni e perché mailbox espone ancora la gerarchia legacy.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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].
- Lingua principale
- Python
- Stelle
- 77.2k
- Fork
- 36k
- Merge medio
- 1g 9h
- PR unite (30g)
- 558
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di python/cpython
-
docs pending
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
stdlib type-feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
stdlib type-feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
build type-bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
stdlib topic-email type-feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
Tutte le issue di python/cpython
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
bancolombia/sentinel#23 ·
-
test md ApertaCI
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100