Fix PermissionError when loading .netrc (#7237) #7378

jgosmann · 2023-07-18T19:23:45Z

What do these changes do?

If no NETRC environment variable is provided and the .netrc path cannot be accessed due to missing permission, a PermissionError was raised instead of returning None. See issue #7237. This PR fixes the issue.

If the changes look good, I can also prepare backports.

Are there changes in behavior for the user?

If the .netrc cannot be accessed due to a permission problem (and the NETRC environment variable is unset), no PermissionError will be raised. Instead it will be silently ignored.

Related issue number

Fixes #7237

Checklist

I think the code is well written
Unit tests for the changes exist
Documentation reflects the changes (<- I think no changes were necessary as it is a pure bugfix.)
If you provide code modification, please add yourself to CONTRIBUTORS.txt
- The format is <Name> <Surname>.
- Please keep alphabetical order, the file is sorted by names.
Add a new news fragment into the CHANGES folder
- name it <issue_id>.<type> for example (588.bugfix)
- if you don't have an issue_id change it to the pr id after creating the pr
- ensure type is one of the following:
  - .feature: Signifying a new feature.
  - .bugfix: Signifying a bug fix.
  - .doc: Signifying a documentation improvement.
  - .removal: Signifying a deprecation or removal of public API.
  - .misc: A ticket has been closed, but it is not of interest to users.
- Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

If no NETRC environment variable is provided and the .netrc path cannot be accessed due to missing permission, a PermissionError was raised instead of returning None.

Dreamsorcerer · 2023-07-18T19:35:04Z

Looks good to me.

aiohttp/helpers.py

@@ -3,6 +3,7 @@
 import asyncio
 import base64
 import binascii
+import contextlib


codecov · 2023-07-18T19:49:11Z

Codecov Report

Merging #7378 (ee74b1f) into master (41e2c4c) will increase coverage by 0.00%.
The diff coverage is 94.44%.

@@           Coverage Diff           @@
##           master    #7378   +/-   ##
=======================================
  Coverage   97.27%   97.27%           
=======================================
  Files         106      106           
  Lines       31411    31428   +17     
  Branches     3927     3930    +3     
=======================================
+ Hits        30556    30573   +17     
  Misses        650      650           
  Partials      205      205

Flag	Coverage Δ
CI-GHA	`97.22% <94.44%> (+<0.01%)`	⬆️
OS-Linux	`96.89% <94.44%> (+<0.01%)`	⬆️
OS-Windows	`95.35% <94.44%> (+<0.01%)`	⬆️
OS-macOS	`96.58% <94.44%> (+<0.01%)`	⬆️
Py-3.10.11	`95.27% <94.44%> (+<0.01%)`	⬆️
Py-3.10.12	`96.78% <94.44%> (+<0.01%)`	⬆️
Py-3.11.0	`96.53% <94.44%> (+<0.01%)`	⬆️
Py-3.8.10	`95.24% <94.44%> (+<0.01%)`	⬆️
Py-3.8.17	`96.72% <94.44%> (+<0.01%)`	⬆️
Py-3.9.13	`95.24% <94.44%> (+<0.01%)`	⬆️
Py-3.9.17	`96.75% <94.44%> (+<0.01%)`	⬆️
Py-pypy7.3.11	`94.23% <88.88%> (+0.01%)`	⬆️
VM-macos	`96.58% <94.44%> (+<0.01%)`	⬆️
VM-ubuntu	`96.89% <94.44%> (+<0.01%)`	⬆️
VM-windows	`95.35% <94.44%> (+<0.01%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
aiohttp/helpers.py	`95.07% <80.00%> (+0.03%)`	⬆️
tests/test_helpers.py	`99.01% <100.00%> (+0.02%)`	⬆️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

patchback · 2023-07-18T20:54:40Z

Backport to 3.8: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 0d2e43b on top of patchback/backports/3.8/0d2e43bf2a920975a5da4d9295e0ba887080bf5b/pr-7378

Backporting merged PR #7378 into master

Ensure you have a local repo clone of your fork. Unless you cloned it
from the upstream, this would be your origin remote.
Make sure you have an upstream repo added as a remote too. In these
instructions you'll refer to it by the name upstream. If you don't
have it, here's how you can add it:
```
$ git remote add upstream https://github.com/aio-libs/aiohttp.git
```

Ensure you have the latest copy of upstream and prepare a branch
that will hold the backported code:

$ git fetch upstream
$ git checkout -b patchback/backports/3.8/0d2e43bf2a920975a5da4d9295e0ba887080bf5b/pr-7378 upstream/3.8

Now, cherry-pick PR Fix PermissionError when loading .netrc (#7237) #7378 contents into that branch:
```
$ git cherry-pick -x 0d2e43bf2a920975a5da4d9295e0ba887080bf5b
```
If it'll yell at you with something like fatal: Commit 0d2e43bf2a920975a5da4d9295e0ba887080bf5b is a merge but no -m option was given., add -m 1 as follows instead:
```
$ git cherry-pick -m1 -x 0d2e43bf2a920975a5da4d9295e0ba887080bf5b
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Fix PermissionError when loading .netrc (#7237) #7378 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/3.8/0d2e43bf2a920975a5da4d9295e0ba887080bf5b/pr-7378

Create a PR, ensure that the CI is green. If it's not — update it so that
the tests and any other checks pass. This is it!
Now relax and wait for the maintainers to process your pull request
when they have some cycles to do reviews. Don't worry — they'll tell you if
any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback · 2023-07-18T20:54:46Z

Backport to 3.9: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 0d2e43b on top of patchback/backports/3.9/0d2e43bf2a920975a5da4d9295e0ba887080bf5b/pr-7378

Backporting merged PR #7378 into master

Ensure you have a local repo clone of your fork. Unless you cloned it
from the upstream, this would be your origin remote.
Make sure you have an upstream repo added as a remote too. In these
instructions you'll refer to it by the name upstream. If you don't
have it, here's how you can add it:
```
$ git remote add upstream https://github.com/aio-libs/aiohttp.git
```

Ensure you have the latest copy of upstream and prepare a branch
that will hold the backported code:

$ git fetch upstream
$ git checkout -b patchback/backports/3.9/0d2e43bf2a920975a5da4d9295e0ba887080bf5b/pr-7378 upstream/3.9

Now, cherry-pick PR Fix PermissionError when loading .netrc (#7237) #7378 contents into that branch:
```
$ git cherry-pick -x 0d2e43bf2a920975a5da4d9295e0ba887080bf5b
```
If it'll yell at you with something like fatal: Commit 0d2e43bf2a920975a5da4d9295e0ba887080bf5b is a merge but no -m option was given., add -m 1 as follows instead:
```
$ git cherry-pick -m1 -x 0d2e43bf2a920975a5da4d9295e0ba887080bf5b
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Fix PermissionError when loading .netrc (#7237) #7378 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/3.9/0d2e43bf2a920975a5da4d9295e0ba887080bf5b/pr-7378

Create a PR, ensure that the CI is green. If it's not — update it so that
the tests and any other checks pass. This is it!
Now relax and wait for the maintainers to process your pull request
when they have some cycles to do reviews. Don't worry — they'll tell you if
any improvements are necessary when the time comes!

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

Dreamsorcerer · 2023-07-18T20:55:28Z

If you could setup the backports with the above instructions, that would be great.

## What do these changes do? If no NETRC environment variable is provided and the .netrc path cannot be accessed due to missing permission, a PermissionError was raised instead of returning None. See issue aio-libs#7237. This PR fixes the issue. If the changes look good, I can also prepare backports. ## Are there changes in behavior for the user? If the .netrc cannot be accessed due to a permission problem (and the `NETRC` environment variable is unset), no `PermissionError` will be raised. Instead it will be silently ignored. ## Related issue number Fixes aio-libs#7237 (cherry picked from commit 0d2e43b) # Conflicts: # aiohttp/helpers.py

## What do these changes do? If no NETRC environment variable is provided and the .netrc path cannot be accessed due to missing permission, a PermissionError was raised instead of returning None. See issue aio-libs#7237. This PR fixes the issue. If the changes look good, I can also prepare backports. ## Are there changes in behavior for the user? If the .netrc cannot be accessed due to a permission problem (and the `NETRC` environment variable is unset), no `PermissionError` will be raised. Instead it will be silently ignored. ## Related issue number Fixes aio-libs#7237 (cherry picked from commit 0d2e43b) # Conflicts: # CONTRIBUTORS.txt # aiohttp/helpers.py # tests/test_helpers.py

## What do these changes do? If no NETRC environment variable is provided and the .netrc path cannot be accessed due to missing permission, a PermissionError was raised instead of returning None. See issue #7237. This PR fixes the issue. If the changes look good, I can also prepare backports. ## Are there changes in behavior for the user? If the .netrc cannot be accessed due to a permission problem (and the `NETRC` environment variable is unset), no `PermissionError` will be raised. Instead it will be silently ignored. ## Related issue number Fixes #7237 Backport of #7378 (cherry picked from commit 0d2e43b) ## Checklist - [x] I think the code is well written - [x] Unit tests for the changes exist - [x] Documentation reflects the changes - [x] If you provide code modification, please add yourself to `CONTRIBUTORS.txt` * The format is <Name> <Surname>. * Please keep alphabetical order, the file is sorted by names. - [x] Add a new news fragment into the `CHANGES` folder * name it `<issue_id>.<type>` for example (588.bugfix) * if you don't have an `issue_id` change it to the pr id after creating the pr * ensure type is one of the following: * `.feature`: Signifying a new feature. * `.bugfix`: Signifying a bug fix. * `.doc`: Signifying a documentation improvement. * `.removal`: Signifying a deprecation or removal of public API. * `.misc`: A ticket has been closed, but it is not of interest to users. * Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

jgosmann added 2 commits July 18, 2023 21:17

Fix PermissionError when loading .netrc (aio-libs#7237)

9c64318

If no NETRC environment variable is provided and the .netrc path cannot be accessed due to missing permission, a PermissionError was raised instead of returning None.

Add Jan Gosmann to contributors

ee74b1f

jgosmann requested review from webknjaz and asvetlov as code owners July 18, 2023 19:23

psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Jul 18, 2023

Dreamsorcerer added backport-3.8 backport-3.9 Trigger automatic backporting to the 3.9 release branch by Patchback robot labels Jul 18, 2023

github-advanced-security bot found potential problems Jul 18, 2023

View reviewed changes

aiohttp/helpers.py

@@ -3,6 +3,7 @@

import asyncio

import base64

import binascii

import contextlib

Check notice

Code scanning / CodeQL

Module is imported with 'import' and 'import from' Note

Module 'contextlib' is imported with both 'import' and 'import from'.

Dreamsorcerer merged commit 0d2e43b into aio-libs:master Jul 18, 2023
29 of 32 checks passed

jgosmann mentioned this pull request Jul 20, 2023

Fix PermissionError when loading .netrc (#7237) (#7378) #7394

Merged

5 tasks

jgosmann mentioned this pull request Jul 20, 2023

Fix PermissionError when loading .netrc (#7237) (#7378) #7395

Merged

5 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix PermissionError when loading .netrc (#7237) #7378

Fix PermissionError when loading .netrc (#7237) #7378

jgosmann commented Jul 18, 2023 •

edited by Dreamsorcerer

Dreamsorcerer commented Jul 18, 2023

codecov bot commented Jul 18, 2023 •

edited

patchback bot commented Jul 18, 2023 •

edited

patchback bot commented Jul 18, 2023 •

edited

Dreamsorcerer commented Jul 18, 2023

Fix PermissionError when loading .netrc (#7237) #7378

Fix PermissionError when loading .netrc (#7237) #7378

Conversation

jgosmann commented Jul 18, 2023 • edited by Dreamsorcerer

What do these changes do?

Are there changes in behavior for the user?

Related issue number

Checklist

Dreamsorcerer commented Jul 18, 2023

codecov bot commented Jul 18, 2023 • edited

Codecov Report

patchback bot commented Jul 18, 2023 • edited

Backport to 3.8: 💔 cherry-picking failed — conflicts found

Backporting merged PR #7378 into master

patchback bot commented Jul 18, 2023 • edited

Backport to 3.9: 💔 cherry-picking failed — conflicts found

Backporting merged PR #7378 into master

Dreamsorcerer commented Jul 18, 2023

jgosmann commented Jul 18, 2023 •

edited by Dreamsorcerer

codecov bot commented Jul 18, 2023 •

edited

patchback bot commented Jul 18, 2023 •

edited

patchback bot commented Jul 18, 2023 •

edited