Fix type of SSLContext for some static type checkers #10099

AlanBogarin · 2024-12-04T06:24:21Z

What do these changes do?

Fix partially unknown bug in all references to SSLContext

Are there changes in behavior for the user?

No, it's only for type checkers

Is it a substantial burden for the maintainers to support this?

No, it only requires knowledge of run-time and type checking.

Checklist

I think the code is well written
Unit tests for the changes exist
Documentation reflects the changes
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_or_pr_num>.<type>.rst (e.g. 588.bugfix.rst)
- if you don't have an issue number, change it to the pull request
  number after creating the PR
  - .bugfix: A bug fix for something the maintainers deemed an
    improper undesired behavior that got corrected to match
    pre-agreed expectations.
  - .feature: A new behavior, public APIs. That sort of stuff.
  - .deprecation: A declaration of future API removals and breaking
    changes in behavior.
  - .breaking: When something public is removed in a breaking way.
    Could be deprecated in an earlier release.
  - .doc: Notable updates to the documentation structure or build
    process.
  - .packaging: Notes for downstreams about unobvious side effects
    and tooling. Changes in the test invocation considerations and
    runtime assumptions.
  - .contrib: Stuff that affects the contributor experience. e.g.
    Running tests, building the docs, setting up the development
    environment.
  - .misc: Changes that are hard to assign to any of the above
    categories.
- Make sure to use full sentences with correct case and punctuation,
  for example:
```
Fixed issue with non-ascii contents in doctest text files
-- by :user:`contributor-gh-handle`.
```
  Use the past tense or the present tense a non-imperative mood,
  referring to what's changed compared to the last released version
  of this project.

for more information, see https://pre-commit.ci

codecov · 2024-12-04T06:45:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.75%. Comparing base (dbd77ad) to head (2183fa2).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master   #10099   +/-   ##
=======================================
  Coverage   98.74%   98.75%           
=======================================
  Files         122      122           
  Lines       36956    36954    -2     
  Branches     4411     4411           
=======================================
  Hits        36494    36494           
+ Misses        315      313    -2     
  Partials      147      147

Flag	Coverage Δ
CI-GHA	`98.64% <100.00%> (+<0.01%)`	⬆️
OS-Linux	`98.33% <100.00%> (+<0.01%)`	⬆️
OS-Windows	`96.17% <83.33%> (+<0.01%)`	⬆️
OS-macOS	`97.43% <100.00%> (+<0.01%)`	⬆️
Py-3.10.11	`97.27% <100.00%> (+<0.01%)`	⬆️
Py-3.10.15	`97.85% <100.00%> (+0.04%)`	⬆️
Py-3.11.10	`97.86% <100.00%> (+<0.01%)`	⬆️
Py-3.11.9	`97.32% <100.00%> (-0.01%)`	⬇️
Py-3.12.7	`98.38% <100.00%> (+<0.01%)`	⬆️
Py-3.13.0	`97.19% <100.00%> (+<0.01%)`	⬆️
Py-3.13.1	`98.35% <100.00%> (+<0.01%)`	⬆️
Py-3.9.13	`97.19% <100.00%> (+<0.01%)`	⬆️
Py-3.9.20	`97.73% <100.00%> (-0.04%)`	⬇️
Py-pypy7.3.16	`97.35% <100.00%> (+<0.01%)`	⬆️
VM-macos	`97.43% <100.00%> (+<0.01%)`	⬆️
VM-ubuntu	`98.33% <100.00%> (+<0.01%)`	⬆️
VM-windows	`96.17% <83.33%> (+<0.01%)`	⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

codspeed-hq · 2024-12-04T06:45:50Z

CodSpeed Performance Report

Merging #10099 will not alter performance

_{Comparing AlanBogarin:patch-1 (2183fa2) with master (dbd77ad)}

Summary

✅ 47 untouched benchmarks

Dreamsorcerer · 2024-12-04T12:59:05Z

We've been using this without issue for quite some time. You'll need to provide a reproducer demonstrating the bug you're claiming to fix.

webknjaz · 2024-12-04T14:08:14Z

I don't even know if the try/except is needed these days. I don't know of a Python distribution being shipped without the ssl module by default post Python 2.7.9. Someone could disable it when compiling CPython but I don't know that we want to support such custom builds anyway.

Dreamsorcerer · 2024-12-04T14:39:27Z

Yep, maybe it's time to remove it then.

asvetlov · 2024-12-04T16:35:33Z

Python itself support the build without ssl.
Asyncio has such conditional imports also.
I think we should keep it until CPython decide to make ssl mandatory (as it happened for threading module).

aiohttp/client_exceptions.py

AlanBogarin · 2024-12-06T04:07:46Z

What does CI/Linter (pull_request) do?

bdraco · 2024-12-06T05:32:41Z

What does CI/Linter (pull_request) do?

https://github.com/aio-libs/aiohttp/actions/runs/12192823875/job/34014087992?pr=10099

[towncrier-fragments]:194: : Spell check: pyright: for some static type checkers (e.g. pyright)..

Dreamsorcerer · 2024-12-06T12:58:15Z

That was my suggestion, have added to spelling list. Coverage is good now too.

patchback · 2024-12-08T15:09:04Z

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

❌ Failed to cleanly apply 6200513 on top of patchback/backports/3.11/6200513d8fd34a820a4d10d238ca92d9f73ce7ee/pr-10099

Backporting merged PR #10099 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.11/6200513d8fd34a820a4d10d238ca92d9f73ce7ee/pr-10099 upstream/3.11

Now, cherry-pick PR Fix type of SSLContext for some static type checkers #10099 contents into that branch:
```
$ git cherry-pick -x 6200513d8fd34a820a4d10d238ca92d9f73ce7ee
```
If it'll yell at you with something like fatal: Commit 6200513d8fd34a820a4d10d238ca92d9f73ce7ee is a merge but no -m option was given., add -m 1 as follows instead:
```
$ git cherry-pick -m1 -x 6200513d8fd34a820a4d10d238ca92d9f73ce7ee
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Fix type of SSLContext for some static type checkers #10099 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/3.11/6200513d8fd34a820a4d10d238ca92d9f73ce7ee/pr-10099

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 · 2024-12-08T15:09:10Z

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

❌ Failed to cleanly apply 6200513 on top of patchback/backports/3.12/6200513d8fd34a820a4d10d238ca92d9f73ce7ee/pr-10099

Backporting merged PR #10099 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.12/6200513d8fd34a820a4d10d238ca92d9f73ce7ee/pr-10099 upstream/3.12

Now, cherry-pick PR Fix type of SSLContext for some static type checkers #10099 contents into that branch:
```
$ git cherry-pick -x 6200513d8fd34a820a4d10d238ca92d9f73ce7ee
```
If it'll yell at you with something like fatal: Commit 6200513d8fd34a820a4d10d238ca92d9f73ce7ee is a merge but no -m option was given., add -m 1 as follows instead:
```
$ git cherry-pick -m1 -x 6200513d8fd34a820a4d10d238ca92d9f73ce7ee
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Fix type of SSLContext for some static type checkers #10099 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/3.12/6200513d8fd34a820a4d10d238ca92d9f73ce7ee/pr-10099

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.

(cherry picked from commit 6200513)

(cherry picked from commit 6200513) Co-authored-by: AlanBogarin <[email protected]>

AlanBogarin and others added 9 commits December 4, 2024 02:47

Update web.py

dd4d0d9

Update worker.py

b6f89bd

Update web_runner.py

38f0bbc

Update connector.py

e50b0b5

Update client_reqrep.py

30b48a7

Update client_exceptions.py

1ca2f2b

Update CONTRIBUTORS.txt

cdc0ae8

[pre-commit.ci] auto fixes from pre-commit.com hooks

1a5682b

for more information, see https://pre-commit.ci

Create 10099.bugfix.rst

aa0983a

psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Dec 4, 2024

AlanBogarin and others added 10 commits December 4, 2024 03:34

Update client_exceptions.py

588924e

[pre-commit.ci] auto fixes from pre-commit.com hooks

833de6e

for more information, see https://pre-commit.ci

Update connector.py

8162374

[pre-commit.ci] auto fixes from pre-commit.com hooks

d784612

for more information, see https://pre-commit.ci

Update client_exceptions.py

40f52db

[pre-commit.ci] auto fixes from pre-commit.com hooks

ba3986f

for more information, see https://pre-commit.ci

Update connector.py

8bb9230

[pre-commit.ci] auto fixes from pre-commit.com hooks

3fdb194

for more information, see https://pre-commit.ci

Update worker.py

e25d358

[pre-commit.ci] auto fixes from pre-commit.com hooks

ec84856

for more information, see https://pre-commit.ci

AlanBogarin marked this pull request as ready for review December 4, 2024 06:43

AlanBogarin requested review from webknjaz and asvetlov as code owners December 4, 2024 06:43

Merge branch 'master' into patch-1

43c5e67

Dreamsorcerer reviewed Dec 6, 2024

View reviewed changes

aiohttp/client_exceptions.py Outdated Show resolved Hide resolved

AlanBogarin added 7 commits December 6, 2024 00:55

Update client_exceptions.py

76dbad7

Update client_reqrep.py

8c7f0d5

Update connector.py

00af2cf

Update web.py

ece65d4

Update web_runner.py

d7a4f31

Update worker.py

9ae8b02

Merge branch 'master' into patch-1

78fc62a

AlanBogarin added 6 commits December 6, 2024 01:10

Update client_exceptions.py

e8a7598

Update client_reqrep.py

bed5d25

Update connector.py

f8d4404

Update web.py

d1eb102

Update web_runner.py

1ce4aa2

Update worker.py

53dbb9b

Allow pyright

e71f744

Dreamsorcerer approved these changes Dec 6, 2024

View reviewed changes

Merge branch 'master' into patch-1

9b92c88

bdraco approved these changes Dec 6, 2024

View reviewed changes

Merge branch 'master' into patch-1

2183fa2

Dreamsorcerer merged commit 6200513 into aio-libs:master Dec 8, 2024
40 checks passed

Dreamsorcerer pushed a commit that referenced this pull request Dec 8, 2024

Fix type of SSLContext for some static type checkers (#10099)

ab2560d

(cherry picked from commit 6200513)

Dreamsorcerer pushed a commit that referenced this pull request Dec 8, 2024

Fix type of SSLContext for some static type checkers (#10099)

c290144

(cherry picked from commit 6200513)

Dreamsorcerer added a commit that referenced this pull request Dec 8, 2024

Fix type of SSLContext for some static type checkers (#10099) (#10144)

eb42db8

(cherry picked from commit 6200513) Co-authored-by: AlanBogarin <[email protected]>

Dreamsorcerer added a commit that referenced this pull request Dec 8, 2024

Fix type of SSLContext for some static type checkers (#10099) (#10145)

b770b1a

(cherry picked from commit 6200513) Co-authored-by: AlanBogarin <[email protected]>

AlanBogarin deleted the patch-1 branch December 25, 2024 20:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix type of SSLContext for some static type checkers #10099

Fix type of SSLContext for some static type checkers #10099

AlanBogarin commented Dec 4, 2024 •

edited

Loading

codecov bot commented Dec 4, 2024 •

edited

Loading

codspeed-hq bot commented Dec 4, 2024 •

edited

Loading

Dreamsorcerer commented Dec 4, 2024

webknjaz commented Dec 4, 2024

Dreamsorcerer commented Dec 4, 2024

asvetlov commented Dec 4, 2024

AlanBogarin commented Dec 6, 2024

bdraco commented Dec 6, 2024

Dreamsorcerer commented Dec 6, 2024 •

edited

Loading

patchback bot commented Dec 8, 2024 •

edited

Loading

patchback bot commented Dec 8, 2024 •

edited

Loading

Fix type of SSLContext for some static type checkers #10099

Fix type of SSLContext for some static type checkers #10099

Conversation

AlanBogarin commented Dec 4, 2024 • edited Loading

What do these changes do?

Are there changes in behavior for the user?

Is it a substantial burden for the maintainers to support this?

Checklist

codecov bot commented Dec 4, 2024 • edited Loading

Codecov Report

codspeed-hq bot commented Dec 4, 2024 • edited Loading

CodSpeed Performance Report

Merging #10099 will not alter performance

Summary

Dreamsorcerer commented Dec 4, 2024

webknjaz commented Dec 4, 2024

Dreamsorcerer commented Dec 4, 2024

asvetlov commented Dec 4, 2024

AlanBogarin commented Dec 6, 2024

bdraco commented Dec 6, 2024

Dreamsorcerer commented Dec 6, 2024 • edited Loading

patchback bot commented Dec 8, 2024 • edited Loading

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

Backporting merged PR #10099 into master

patchback bot commented Dec 8, 2024 • edited Loading

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

Backporting merged PR #10099 into master

AlanBogarin commented Dec 4, 2024 •

edited

Loading

codecov bot commented Dec 4, 2024 •

edited

Loading

codspeed-hq bot commented Dec 4, 2024 •

edited

Loading

Dreamsorcerer commented Dec 6, 2024 •

edited

Loading

patchback bot commented Dec 8, 2024 •

edited

Loading

patchback bot commented Dec 8, 2024 •

edited

Loading