https://github.com/python/cpython/commit/557d2d20d484a7b22da39cdb876f6312ab66d561
commit: 557d2d20d484a7b22da39cdb876f6312ab66d561
branch: main
author: Sebb <[email protected]>
committer: picnixz <[email protected]>
date: 2025-03-23T13:10:47+01:00
summary:
gh-121529: Document `from_` parameter in `_mboxMMDF` public methods (#121530)
files:
M Doc/library/mailbox.rst
diff --git a/Doc/library/mailbox.rst b/Doc/library/mailbox.rst
index abb32f9bf3457f..e8a96f29ea185e 100644
--- a/Doc/library/mailbox.rst
+++ b/Doc/library/mailbox.rst
@@ -587,12 +587,27 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl,
and MMDF.
remarks:
- .. method:: get_file(key)
+ .. method:: get_bytes(key, from_=False)
+
+ Note: This method has an extra parameter (*from_*) compared with other
classes.
+ The first line of an mbox file entry is the Unix "From " line.
+ If *from_* is False, the first line of the file is dropped.
+
+ .. method:: get_file(key, from_=False)
Using the file after calling :meth:`~Mailbox.flush` or
:meth:`~Mailbox.close` on the :class:`!mbox` instance may yield
unpredictable results or raise an exception.
+ Note: This method has an extra parameter (*from_*) compared with other
classes.
+ The first line of an mbox file entry is the Unix "From " line.
+ If *from_* is False, the first line of the file is dropped.
+
+ .. method:: get_string(key, from_=False)
+
+ Note: This method has an extra parameter (*from_*) compared with other
classes.
+ The first line of an mbox file entry is the Unix "From " line.
+ If *from_* is False, the first line of the file is dropped.
.. method:: lock()
unlock()
@@ -851,12 +866,22 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl,
and MMDF.
remarks:
- .. method:: get_file(key)
+ .. method:: get_bytes(key, from_=False)
+
+ Note: This method has an extra parameter (*from_*) compared with other
classes.
+ The first line of an mbox file entry is the Unix "From " line.
+ If *from_* is False, the first line of the file is dropped.
+
+ .. method:: get_file(key, from_=False)
Using the file after calling :meth:`~Mailbox.flush` or
:meth:`~Mailbox.close` on the :class:`!MMDF` instance may yield
unpredictable results or raise an exception.
+ Note: This method has an extra parameter (*from_*) compared with other
classes.
+ The first line of an mbox file entry is the Unix "From " line.
+ If *from_* is False, the first line of the file is dropped.
+
.. method:: lock()
unlock()
_______________________________________________
Python-checkins mailing list -- [email protected]
To unsubscribe send an email to [email protected]
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: [email protected]
