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.

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

[PR #10551/d067260d backport][3.11] Re-raise OSError as ClientConnectionError when failing to explicitly close connector socket #10561

Conversation

patchback[bot]
Copy link
Contributor

@patchback patchback bot commented Mar 16, 2025

This is a backport of PR #10551 as merged into master (d067260).

What do these changes do?

This is a followup to #10464 to handle the case where socket.close() can also raise. This matches the logic we have in aiohappyeyeballs:

https://github.com/aio-libs/aiohappyeyeballs/blob/e3bd5bdf44f5d187802de6dcb08d27e1ca6da048/src/aiohappyeyeballs/impl.py#L227

We shouldn't raising OSError externally from this method as callers expect a ClientError

Are there changes in behavior for the user?

bugfix

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

no

Related issue number

fixes #10506

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.

…close connector socket (#10551)

<!-- Thank you for your contribution! -->

## What do these changes do?

This is a followup to #10464 to handle the case where `socket.close()`
can also raise. This matches the logic we have in aiohappyeyeballs:

https://github.com/aio-libs/aiohappyeyeballs/blob/e3bd5bdf44f5d187802de6dcb08d27e1ca6da048/src/aiohappyeyeballs/impl.py#L227

We shouldn't raising `OSError` externally from this method as callers
expect a `ClientError`

## Are there changes in behavior for the user?

bugfix

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

no

## Related issue number

fixes #10506

## 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 &lt;Name&gt; &lt;Surname&gt;.
  * Please keep alphabetical order, the file is sorted by names.
- [x] 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:
    ```rst
    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.

(cherry picked from commit d067260)
@bdraco bdraco enabled auto-merge (squash) March 16, 2025 00:33
Copy link

codecov bot commented Mar 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.09%. Comparing base (e9f3f03) to head (ae7c211).
Report is 1 commits behind head on 3.11.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             3.11   #10561   +/-   ##
=======================================
  Coverage   98.09%   98.09%           
=======================================
  Files         123      123           
  Lines       37398    37409   +11     
  Branches     4512     4513    +1     
=======================================
+ Hits        36684    36695   +11     
  Misses        538      538           
  Partials      176      176           
Flag Coverage Δ
CI-GHA 97.98% <100.00%> (+<0.01%) ⬆️
OS-Linux 97.68% <100.00%> (+<0.01%) ⬆️
OS-Windows 94.73% <100.00%> (+<0.01%) ⬆️
OS-macOS 96.81% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 96.66% <100.00%> (-0.01%) ⬇️
Py-3.10.16 97.24% <100.00%> (+<0.01%) ⬆️
Py-3.11.11 97.27% <100.00%> (-0.04%) ⬇️
Py-3.11.9 96.74% <100.00%> (+<0.01%) ⬆️
Py-3.12.9 97.74% <100.00%> (+<0.01%) ⬆️
Py-3.13.2 97.74% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 96.58% <91.66%> (+<0.01%) ⬆️
Py-3.9.21 97.13% <91.66%> (-0.01%) ⬇️
Py-pypy7.3.16 96.73% <91.66%> (+<0.01%) ⬆️
VM-macos 96.81% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 97.68% <100.00%> (+<0.01%) ⬆️
VM-windows 94.73% <100.00%> (+<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.

Copy link

codspeed-hq bot commented Mar 16, 2025

CodSpeed Performance Report

Merging #10561 will not alter performance

Comparing patchback/backports/3.11/d067260df75e4d04a23a0481cf9cf8f7194c80f1/pr-10551 (ae7c211) with 3.11 (e9f3f03)

Summary

✅ 47 untouched benchmarks

@bdraco bdraco merged commit 6357c05 into 3.11 Mar 16, 2025
36 checks passed
@bdraco bdraco deleted the patchback/backports/3.11/d067260df75e4d04a23a0481cf9cf8f7194c80f1/pr-10551 branch March 16, 2025 00:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant