Skip to content

gh-99203: shutil.make_archive(): restore select CPython <= 3.10.5 behavior - #99802

Merged
serhiy-storchaka merged 6 commits into
python:mainfrom
6t8k:gh-99203
Aug 16, 2023
Merged

gh-99203: shutil.make_archive(): restore select CPython <= 3.10.5 behavior#99802
serhiy-storchaka merged 6 commits into
python:mainfrom
6t8k:gh-99203

Conversation

@6t8k

@6t8k6t8k commented Nov 26, 2022•
edited
Loading

Copy link
Copy Markdown
Contributor
  • Without this proposed change, if the path held by root_dir does not exist, or is not a directory, then CPython >3.10.5 will create an empty archive, so introduce an explicit check for it being a directory. shutil.make_archive() may then raise FileNotFoundError or NotADirectoryError before proceeding to call the internal format-specific archive creation function, as was formerly (implicitly) caused by os.chdir(root_dir), restoring CPython <=3.10.5 behavior.
  • For consistency, decided to raise the exception in dry run mode too
  • Add corresponding regression tests for both the _make_tarball() and _make_zipfile() scenario: although the former, unlike the latter, may already cause NotADirectoryError or FileNotFoundError to be raised with respect to root_dir without this proposed change, an empty archive will still be created. On the other hand, _make_zipfile(), is able to create an empty archive while not raising any exceptions, so test it as well, even though make_archive() would otherwise already be covered by test_make_tarfile_rootdir_nodir(), which runs regardless of zlib availability.

@bedevere-botbedevere-bot mentioned this pull request Nov 26, 2022
Closed
@6t8k

6t8k commented Nov 26, 2022•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Will look into the failed Windows tests later.

@6t8k
gh-99203:shutil.make_archive(): restore select CPython <= 3.10.5 b…
ec8b8d1
…ehavior
Restore following CPython <= 3.10.5 behavior of `shutil.make_archive()`
that went away as part of gh-93160:
Do not create an empty archive if `root_dir` is not a directory, and, in
that case, raise `FileNotFoundError` or `NotADirectoryError` regardless
of `format` choice. Beyond the brought-back behavior, the function may
now also raise these exceptions in `dry_run` mode.
@6t8k

6t8k commented Nov 27, 2022•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

@giampaolo if I'm not mistaken, the CODEOWNERS lines for ftplib and shutil seem to be missing a * suffix and do not seem to match the respective files as a result.

P.S.: I acknowledge [1], [2] and won't force-push here any longer, sorry.

serhiy-storchaka
serhiy-storchaka reviewed Jan 30, 2023
View reviewed changes

@serhiy-storchakaserhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Creating an empty archive without raising an exception is definitely a bug. Leaving an empty archive and raising an exception is more in a grey area, but in any case it is better to not create it if we can to detect an error earlier.

Comment threadLib/test/test_shutil.py Outdated
Comment threadLib/test/test_shutil.py Outdated
Comment threadLib/test/test_shutil.py Outdated
Comment threadLib/shutil.py Outdated
@6t8k

6t8k commented Jan 30, 2023

Copy link
Copy Markdown
ContributorAuthor

Thanks for the review! I addressed the findings.

@6t8k
6t8k requested review from serhiy-storchaka and removed request for giampaoloJanuary 30, 2023 20:34
serhiy-storchaka
serhiy-storchaka approved these changes Aug 16, 2023
View reviewed changes

@serhiy-storchakaserhiy-storchaka left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

Thank you for your response and sorry for the delay. This issue fell off my radar.

@serhiy-storchakaserhiy-storchaka added type-bug An unexpected behavior, bug, or error needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 16, 2023
@serhiy-storchaka
serhiy-storchaka merged commit a86df29 into python:mainAug 16, 2023
@miss-islington

miss-islington commented Aug 16, 2023

Copy link
Copy Markdown
Contributor

Thanks @6t8k for the PR, and @serhiy-storchaka for merging it 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington

miss-islington commented Aug 16, 2023

Copy link
Copy Markdown
Contributor

Sorry, @6t8k and @serhiy-storchaka, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker a86df298df5b02e2d69ea6879e9ed10a7adb85d0 3.11

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 16, 2023
@6t8k@miss-islington
pythongh-99203: shutil.make_archive(): restore select CPython <= 3.10…
49d322b
….5 behavior (pythonGH-99802)
Restore following CPython <= 3.10.5 behavior of shutil.make_archive()
that went away as part of pythongh-93160:
Do not create an empty archive if root_dir is not a directory, and, in
that case, raise FileNotFoundError or NotADirectoryError regardless
of format choice. Beyond the brought-back behavior, the function may
now also raise these exceptions in dry_run mode.
(cherry picked from commit a86df29)
Co-authored-by: 6t8k <58048945+6t8k@users.noreply.github.com>
@bedevere-bot

bedevere-bot commented Aug 16, 2023

Copy link
Copy Markdown

GH-107998 is a backport of this pull request to the 3.12 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.12 only security fixes label Aug 16, 2023
serhiy-storchaka pushed a commit to serhiy-storchaka/cpython that referenced this pull request Aug 16, 2023
@6t8k@serhiy-storchaka
[3.11]pythongh-99203: shutil.make_archive(): restore select CPython …
a716563
…<= 3.10.5 behavior (pythonGH-99802)
Restore following CPython <= 3.10.5 behavior of shutil.make_archive()
that went away as part of pythongh-93160:
Do not create an empty archive if root_dir is not a directory, and, in
that case, raise FileNotFoundError or NotADirectoryError regardless
of format choice. Beyond the brought-back behavior, the function may
now also raise these exceptions in dry_run mode..
(cherry picked from commit a86df29)
Co-authored-by: 6t8k <58048945+6t8k@users.noreply.github.com>
@bedevere-bot

bedevere-bot commented Aug 16, 2023

Copy link
Copy Markdown

GH-107999 is a backport of this pull request to the 3.11 branch.

@bedevere-botbedevere-bot removed the needs backport to 3.11 only security fixes label Aug 16, 2023
@serhiy-storchakaserhiy-storchaka removed their assignment Aug 16, 2023
serhiy-storchaka added a commit that referenced this pull request Aug 16, 2023
@serhiy-storchaka@6t8k
[3.11]gh-99203: shutil.make_archive(): restore select CPython <= 3.1…
4cfbcff
…0.5 behavior (GH-99802) (GH-107999)
Restore following CPython <= 3.10.5 behavior of shutil.make_archive()
that went away as part of gh-93160:
Do not create an empty archive if root_dir is not a directory, and, in
that case, raise FileNotFoundError or NotADirectoryError regardless
of format choice. Beyond the brought-back behavior, the function may
now also raise these exceptions in dry_run mode.
(cherry picked from commit a86df29)
Co-authored-by: 6t8k <58048945+6t8k@users.noreply.github.com>
Yhg1s pushed a commit that referenced this pull request Aug 16, 2023
@miss-islington@6t8k
[3.12]gh-99203: shutil.make_archive(): restore select CPython <= 3.1…
5d9f20a
…0.5 behavior (GH-99802) (#107998)
gh-99203: shutil.make_archive(): restore select CPython <= 3.10.5 behavior (GH-99802)
Restore following CPython <= 3.10.5 behavior of shutil.make_archive()
that went away as part of gh-93160:
Do not create an empty archive if root_dir is not a directory, and, in
that case, raise FileNotFoundError or NotADirectoryError regardless
of format choice. Beyond the brought-back behavior, the function may
now also raise these exceptions in dry_run mode.
(cherry picked from commit a86df29)
Co-authored-by: 6t8k <58048945+6t8k@users.noreply.github.com>
@6t8k
6t8k deleted the gh-99203 branch August 16, 2023 19:49
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@serhiy-storchakaserhiy-storchakaserhiy-storchaka approved these changes

Assignees

No one assigned

Labels

type-bugAn unexpected behavior, bug, or error

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@6t8k@miss-islington@bedevere-bot@serhiy-storchaka