Skip to content

gh-66515: mailbox.MH now supports folders withou the ".mh_sequences"… #804

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions Doc/library/mailbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -644,6 +644,10 @@ Supported mailbox formats are Maildir, mbox, MH, Babyl, and MMDF.
:class:`!MH` instances have all of the methods of :class:`Mailbox` in addition
to the following:

.. versionchanged:: 3.13

Supported folders that don't contain a :file:`.mh_sequences` file.


.. method:: list_folders()

Expand Down
9 changes: 6 additions & 3 deletions Lib/mailbox.py
Original file line number Diff line number Diff line change
Expand Up @@ -1198,7 +1198,11 @@ def remove_folder(self, folder):
def get_sequences(self):
"""Return a name-to-key-list dictionary to define each sequence."""
results = {}
with open(os.path.join(self._path, '.mh_sequences'), 'r', encoding='ASCII') as f:
try:
f = open(os.path.join(self._path, '.mh_sequences'), 'r', encoding='ASCII')
except FileNotFoundError:
return results
with f:
all_keys = set(self.keys())
for line in f:
try:
Expand All @@ -1221,9 +1225,8 @@ def get_sequences(self):

def set_sequences(self, sequences):
"""Set sequences using the given name-to-key-list dictionary."""
f = open(os.path.join(self._path, '.mh_sequences'), 'r+', encoding='ASCII')
f = open(os.path.join(self._path, '.mh_sequences'), 'w', encoding='ASCII')
try:
os.close(os.open(f.name, os.O_WRONLY | os.O_TRUNC))
for name, keys in sequences.items():
if len(keys) == 0:
continue
Expand Down
13 changes: 13 additions & 0 deletions Lib/test/test_mailbox.py
Original file line number Diff line number Diff line change
Expand Up @@ -1347,6 +1347,19 @@ def test_sequences(self):
self._box.remove(key1)
self.assertEqual(self._box.get_sequences(), {'flagged':[key0]})

self._box.set_sequences({'foo':[key0]})
self.assertEqual(self._box.get_sequences(), {'foo':[key0]})

def test_no_dot_mh_sequences_file(self):
path = os.path.join(self._path, 'foo.bar')
os.mkdir(path)
box = self._factory(path)
self.assertEqual(os.listdir(path), [])
self.assertEqual(box.get_sequences(), {})
self.assertEqual(os.listdir(path), [])
box.set_sequences({})
self.assertEqual(os.listdir(path), ['.mh_sequences'])

def test_issue2625(self):
msg0 = mailbox.MHMessage(self._template % 0)
msg0.add_sequence('foo')
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:class:`mailbox.MH` now supports folders that do not contain a
``.mh_sequences`` file (e.g. Claws Mail IMAP-cache folders). Patch by Serhiy
Storchaka.