bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir #1163

webknjaz · 2017-04-16T20:06:41Z

Hi,

I've faced an issue w/ mailbox.Maildir(). The case is following:

I create a folder with tempfile.TemporaryDirectory(), so it's empty
I pass that folder path as an argument when instantiating mailbox.Maildir()
Then I receive an exception happening because "there's no such file or directory" (namely cur, tmp or new) during interaction with Maildir

Expected result: subdirs are created during Maildir() instance creation.

Actual result: subdirs are assumed as existing which leads to exceptions during use.

Workaround: remove the actual dir before passing the path to Maildir(). It will be created automatically with all subdirs needed.

Fix: This PR. Basically it adds creation of subdirs regardless of whether the base dir existed before.

https://bugs.python.org/issue30088

the-knights-who-say-ni · 2017-04-16T20:06:43Z

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept your contribution by verifying you have signed the PSF contributor agreement (CLA).

Unfortunately our records indicate you have not signed the CLA. For legal reasons we need you to sign this before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

Thanks again to your contribution and we look forward to looking at it!

webknjaz · 2017-04-16T20:15:05Z

@the-knights-who-say-ni I've signed it, it just hasn't got checked yet.

serhiy-storchaka · 2017-04-17T05:38:31Z

Please open an issue on the bug tracker for discussion and sign the CLA. This isn't trivial PR like fixing a typo.

webknjaz · 2017-04-17T07:51:26Z

@serhiy-storchaka http://bugs.python.org/issue30088

Plz revisit this PR in 1 US business day (I think). The doc says that the CLA is checked manually.

louisom · 2017-04-17T08:53:14Z

@webknjaz a small point that the title should be bpo-30088: Fix creation of....

webknjaz · 2017-04-17T21:14:55Z

(CLA signed: http://bugs.python.org/user17410)

csabella · 2019-07-03T23:54:36Z

cc @maxking

maxking · 2019-07-04T07:07:29Z

From the conversation on BPO, it seems like this is wrong behaviour and if we are operating on a directory expecting it to be a Maildir, it should already have subdirectories created. And I agree with the reasoning.

If there is a more specific Doc change that needs to be made to make the current behaviour more easy to understand, that can be a separate PR.

@csabella I think we can close the PR and maybe the associated Issue.

Make sure that if base maildir directory exists, all mandatory subfolders are also created if mailbox.Maildir initialized with create=True argument

* Bonus: use new assertRaisesRegex instead of deprecated name

This reverts commit aff2caa.

This reverts commit 3059564.

This reverts commit 9a42867.

This reverts commit 26f16a2.

This reverts commit a451dc7.

This reverts commit 55f1670.

webknjaz · 2019-07-13T12:45:46Z

@maxking hi, i've tried to do the suggested docs clarification on this.

miss-islington · 2019-07-13T14:47:17Z

Thanks @webknjaz for the PR 🌮🎉.. I'm working now to backport this PR to: 3.7, 3.8.
🐍🍒⛏🤖

…lbox.Maildir (pythonGH-1163) Hi, I've faced an issue w/ `mailbox.Maildir()`. The case is following: 1. I create a folder with `tempfile.TemporaryDirectory()`, so it's empty 2. I pass that folder path as an argument when instantiating `mailbox.Maildir()` 3. Then I receive an exception happening because "there's no such file or directory" (namely `cur`, `tmp` or `new`) during interaction with Maildir **Expected result:** subdirs are created during `Maildir()` instance creation. **Actual result:** subdirs are assumed as existing which leads to exceptions during use. **Workaround:** remove the actual dir before passing the path to `Maildir()`. It will be created automatically with all subdirs needed. **Fix:** This PR. Basically it adds creation of subdirs regardless of whether the base dir existed before. https://bugs.python.org/issue30088 (cherry picked from commit e441847) Co-authored-by: Sviatoslav Sydorenko <wk@sydorenko.org.ua>

bedevere-bot · 2019-07-13T14:47:27Z

GH-14749 is a backport of this pull request to the 3.8 branch.

…lbox.Maildir (pythonGH-1163) Hi, I've faced an issue w/ `mailbox.Maildir()`. The case is following: 1. I create a folder with `tempfile.TemporaryDirectory()`, so it's empty 2. I pass that folder path as an argument when instantiating `mailbox.Maildir()` 3. Then I receive an exception happening because "there's no such file or directory" (namely `cur`, `tmp` or `new`) during interaction with Maildir **Expected result:** subdirs are created during `Maildir()` instance creation. **Actual result:** subdirs are assumed as existing which leads to exceptions during use. **Workaround:** remove the actual dir before passing the path to `Maildir()`. It will be created automatically with all subdirs needed. **Fix:** This PR. Basically it adds creation of subdirs regardless of whether the base dir existed before. https://bugs.python.org/issue30088 (cherry picked from commit e441847) Co-authored-by: Sviatoslav Sydorenko <wk@sydorenko.org.ua>

bedevere-bot · 2019-07-13T14:47:33Z

GH-14750 is a backport of this pull request to the 3.7 branch.

…lbox.Maildir (GH-1163) Hi, I've faced an issue w/ `mailbox.Maildir()`. The case is following: 1. I create a folder with `tempfile.TemporaryDirectory()`, so it's empty 2. I pass that folder path as an argument when instantiating `mailbox.Maildir()` 3. Then I receive an exception happening because "there's no such file or directory" (namely `cur`, `tmp` or `new`) during interaction with Maildir **Expected result:** subdirs are created during `Maildir()` instance creation. **Actual result:** subdirs are assumed as existing which leads to exceptions during use. **Workaround:** remove the actual dir before passing the path to `Maildir()`. It will be created automatically with all subdirs needed. **Fix:** This PR. Basically it adds creation of subdirs regardless of whether the base dir existed before. https://bugs.python.org/issue30088 (cherry picked from commit e441847) Co-authored-by: Sviatoslav Sydorenko <wk@sydorenko.org.ua>

…lbox.Maildir (pythonGH-1163) Hi, I've faced an issue w/ `mailbox.Maildir()`. The case is following: 1. I create a folder with `tempfile.TemporaryDirectory()`, so it's empty 2. I pass that folder path as an argument when instantiating `mailbox.Maildir()` 3. Then I receive an exception happening because "there's no such file or directory" (namely `cur`, `tmp` or `new`) during interaction with Maildir **Expected result:** subdirs are created during `Maildir()` instance creation. **Actual result:** subdirs are assumed as existing which leads to exceptions during use. **Workaround:** remove the actual dir before passing the path to `Maildir()`. It will be created automatically with all subdirs needed. **Fix:** This PR. Basically it adds creation of subdirs regardless of whether the base dir existed before. https://bugs.python.org/issue30088

the-knights-who-say-ni added the CLA not signed label Apr 16, 2017

webknjaz changed the title ~~[bug] Fix creation of dir structure in mailbox.Maildir (when create=True)~~ [trivial] [bug] Fix creation of dir structure in mailbox.Maildir (when create=True) Apr 16, 2017

webknjaz changed the title ~~[trivial] [bug] Fix creation of dir structure in mailbox.Maildir (when create=True)~~ bpo-30088 [bug] Fix creation of dir structure in mailbox.Maildir (when create=True) Apr 17, 2017

webknjaz changed the title ~~bpo-30088 [bug] Fix creation of dir structure in mailbox.Maildir (when create=True)~~ bpo-30088: Fix creation of dir structure in mailbox.Maildir (when create=True) Apr 17, 2017

the-knights-who-say-ni added CLA signed and removed CLA not signed labels Apr 17, 2017

brettcannon added the awaiting review label Feb 21, 2018

serhiy-storchaka added the type-bug An unexpected behavior, bug, or error label Dec 8, 2018

webknjaz added 14 commits July 13, 2019 14:26

Add test for creation of maildir subdirs

55f1670

Make sure that if base maildir directory exists, all mandatory subfolders are also created if mailbox.Maildir initialized with create=True argument

Ensure maildir's subdirs exist upon initialization

a451dc7

Add Sviatoslav Sydorenko to Misc/ACKS

f4de906

Add test for raising error if maildir is invalid

26f16a2

Fix mailbox instantiation in test

9a42867

* Bonus: use new assertRaisesRegex instead of deprecated name

Make checked subpath absolute in test

3059564

Turn assertRaisesRegex into assertRaises

aff2caa

Revert "Turn assertRaisesRegex into assertRaises"

07c2e76

This reverts commit aff2caa.

Revert "Make checked subpath absolute in test"

d9f791d

This reverts commit 3059564.

Revert "Fix mailbox instantiation in test"

e0d4f8c

This reverts commit 9a42867.

Revert "Add test for raising error if maildir is invalid"

48dd6d8

This reverts commit 26f16a2.

Revert "Ensure maildir's subdirs exist upon initialization"

3ff5052

This reverts commit a451dc7.

Revert "Add test for creation of maildir subdirs"

0104260

This reverts commit 55f1670.

📝 Document Mailbox(create=True) existing behavior

f7aa474

webknjaz force-pushed the bugfix/mailbox-maildir-create-dir-structure branch from e2059dc to f7aa474 Compare July 13, 2019 12:37

webknjaz requested a review from a team as a code owner July 13, 2019 12:37

📜🤖 Added by blurb_it.

71282da

webknjaz changed the title ~~bpo-30088: Fix creation of dir structure in mailbox.Maildir (when create=True)~~ bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir Jul 13, 2019

asvetlov approved these changes Jul 13, 2019

View reviewed changes

bedevere-bot added awaiting merge and removed awaiting review labels Jul 13, 2019

asvetlov added needs backport to 3.7 labels Jul 13, 2019

miss-islington merged commit e441847 into python:master Jul 13, 2019

bedevere-bot removed the awaiting merge label Jul 13, 2019

bedevere-bot removed the needs backport to 3.8 label Jul 13, 2019

bedevere-bot removed the needs backport to 3.7 label Jul 13, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir #1163

bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir #1163

Uh oh!

webknjaz commented Apr 16, 2017 •

edited by bedevere-bot

Loading

Uh oh!

the-knights-who-say-ni commented Apr 16, 2017

Uh oh!

webknjaz commented Apr 16, 2017

Uh oh!

serhiy-storchaka commented Apr 17, 2017

Uh oh!

webknjaz commented Apr 17, 2017

Uh oh!

louisom commented Apr 17, 2017

Uh oh!

webknjaz commented Apr 17, 2017

Uh oh!

csabella commented Jul 3, 2019

Uh oh!

maxking commented Jul 4, 2019

Uh oh!

webknjaz commented Jul 13, 2019

Uh oh!

miss-islington commented Jul 13, 2019

Uh oh!

bedevere-bot commented Jul 13, 2019

Uh oh!

bedevere-bot commented Jul 13, 2019

Uh oh!

Uh oh!

Uh oh!

bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir #1163

bpo-30088: Document that existing dir structure isn't verified by mailbox.Maildir #1163

Uh oh!

Conversation

webknjaz commented Apr 16, 2017 • edited by bedevere-bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

the-knights-who-say-ni commented Apr 16, 2017

Uh oh!

webknjaz commented Apr 16, 2017

Uh oh!

serhiy-storchaka commented Apr 17, 2017

Uh oh!

webknjaz commented Apr 17, 2017

Uh oh!

louisom commented Apr 17, 2017

Uh oh!

webknjaz commented Apr 17, 2017

Uh oh!

csabella commented Jul 3, 2019

Uh oh!

maxking commented Jul 4, 2019

Uh oh!

webknjaz commented Jul 13, 2019

Uh oh!

miss-islington commented Jul 13, 2019

Uh oh!

bedevere-bot commented Jul 13, 2019

Uh oh!

bedevere-bot commented Jul 13, 2019

Uh oh!

Uh oh!

webknjaz commented Apr 16, 2017 •

edited by bedevere-bot

Loading