Skip to content
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.

Sign up for GitHub

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

Jump to bottom

gh-115911: Ignore PermissionError during import from cwd #116131

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

gh-115911: Ignore PermissionError during import from cwd #116131

wants to merge 1 commit into from
+58 −5

Conversation

moreati
Copy link
Contributor

@moreati moreati commented Feb 29, 2024 •
edited
Loading

On macOS getcwd(3) can return EACCES if a path component isn't readable, resulting in PermissionError. PathFinder.find_spec() now catches these and ignores them - the same treatment as a missing/deleted cwd.

Introduces test.support.os_helper.save_mode(path, ...), a context manager that restores the mode of a path on exit.

This is allows finer control of exception handling and robust environment restoration across platforms in FinderTests.test_permission_error_cwd().

Fixes #115911

📚 Documentation preview 📚: https://cpython-previews--116131.org.readthedocs.build/

@bedevere-app bedevere-app bot mentioned this pull request Feb 29, 2024
Open
@moreati moreati force-pushed the issue115911 branch 2 times, most recently from 8b1cbd4 to ff4dfda Compare March 1, 2024 07:56
@moreati moreati marked this pull request as draft March 1, 2024 08:06
@moreati moreati force-pushed the issue115911 branch 2 times, most recently from c026bb9 to 10ebce0 Compare March 1, 2024 10:52
@moreati
Copy link
Contributor Author

moreati commented Mar 1, 2024

The new test fails (as intended) without the accompanying fix. Local test run on macOS 14.3.1

======================================================================
ERROR: test_permission_error_cwd (test.test_importlib.import_.test_path.Frozen_FindModuleTests.test_permission_error_cwd)
----------------------------------------------------------------------
Traceback (most recent call last):
  File "/Users/alex/src/cpython/Lib/test/test_importlib/import_/test_path.py", line 175, in test_permission_error_cwd
    self.assertIsNone(self.machinery.PathFinder.find_spec('whatever'))
                      ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^
  File "<frozen importlib._bootstrap_external>", line 1544, in find_spec
  File "<frozen importlib._bootstrap_external>", line 1516, in _get_spec
  File "<frozen importlib._bootstrap_external>", line 1495, in _path_importer_cache
PermissionError: [Errno 13] Permission denied

@moreati moreati marked this pull request as ready for review March 1, 2024 11:46
@moreati moreati requested a review from jaraco as a code owner May 13, 2024 08:55
@jaraco jaraco mentioned this pull request Jun 20, 2024
Closed
@moreati moreati force-pushed the issue115911 branch 2 times, most recently from c48c021 to f06124d Compare June 21, 2024 13:08
@jaraco jaraco self-assigned this Aug 29, 2024
jaraco
jaraco reviewed Aug 29, 2024
View reviewed changes
Copy link
Member

@jaraco jaraco left a comment

Choose a reason for hiding this comment

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

Looks good to me, but I'd like to see another review from someone more familiar with importlib internals.

Lib/test/test_importlib/import_/test_path.py Outdated Show resolved Hide resolved
Lib/test/support/os_helper.py Outdated Show resolved Hide resolved
Lib/test/support/os_helper.py Outdated Show resolved Hide resolved
Lib/test/test_importlib/import_/test_path.py Outdated Show resolved Hide resolved
Doc/reference/import.rst Outdated Show resolved Hide resolved
@jaraco jaraco removed their assignment Aug 29, 2024
@moreati moreati force-pushed the issue115911 branch 2 times, most recently from 076a29d to b79fd8d Compare August 31, 2024 21:27
brettcannon
brettcannon requested changes Sep 13, 2024
View reviewed changes
Copy link
Member

@brettcannon brettcannon left a comment

Choose a reason for hiding this comment

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

I think one of the decorators you're adding might not be necessary, or at least can be simplified. Otherwise LGTM!

Lib/test/support/os_helper.py Outdated Show resolved Hide resolved
Lib/test/support/os_helper.py Outdated Show resolved Hide resolved
Lib/test/support/os_helper.py Outdated Show resolved Hide resolved
Lib/test/test_importlib/import_/test_path.py Outdated Show resolved Hide resolved
@bedevere-app
Copy link

bedevere-app bot commented Sep 13, 2024

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

moreati added a commit to moreati/cpython that referenced this pull request Sep 14, 2024
@moreati
Sanity check presence of save_cwd() in PR python#116131
f2ad774
@moreati moreati mentioned this pull request Sep 14, 2024
Closed
@moreati
Copy link
Contributor Author

moreati commented Sep 14, 2024

I have made the requested changes; please review again

@bedevere-app
Copy link

bedevere-app bot commented Sep 14, 2024

Thanks for making the requested changes!

@brettcannon: please review the changes made to this pull request.

@moreati moreati force-pushed the issue115911 branch 2 times, most recently from f4d5e67 to 03f2dd6 Compare November 5, 2024 10:12
@moreati @jaraco @brettcannon
Ignore PermissionError when checking cwd during import
cf4a38a 
On macOS `getcwd(3)` can return EACCES if a path component isn't readable,
resulting in PermissionError. `PathFinder.find_spec()` now catches these and
ignores them - the same treatment as a missing/deleted cwd.

Introduces `test.support.os_helper.save_mode(path, ...)`, a context manager
that restores the mode of a path on exit.

This is allows finer control of exception handling and robust environment
restoration across platforms in `FinderTests.test_permission_error_cwd()`.

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
Co-authored-by: Brett Cannon <brett@python.org>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jaraco jaraco jaraco left review comments

@ericsnowcurrently ericsnowcurrently Awaiting requested review from ericsnowcurrently ericsnowcurrently is a code owner

@ncoghlan ncoghlan Awaiting requested review from ncoghlan ncoghlan is a code owner

@warsaw warsaw Awaiting requested review from warsaw warsaw is a code owner

@willingc willingc Awaiting requested review from willingc willingc is a code owner

@brettcannon brettcannon Awaiting requested review from brettcannon brettcannon is a code owner

Assignees
No one assigned
Labels
awaiting change review
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

importlib: PermissionError during startup if working directory isn't readable
3 participants
@moreati @brettcannon @jaraco