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

add proxy and proxy_auth varriables to ClientSession.__init__ #9207

Merged
merged 20 commits into from
Sep 27, 2024

Conversation

meshya
Copy link
Contributor

@meshya meshya commented Sep 20, 2024

What do these changes do?

Users are now able to set proxy and proxy_auth as defaults in ClientSession.__init__.

Are there changes in behavior for the user?

No, there is not

These changes will not affect applications written with previous versions of aiohttp.

However, they can now set default proxy settings when creating an instance of ClientSession.

NOTICE: If default settings are set and then a new proxy setting is specified in SessionClient.get (or post, etc.), the latter will take effect.

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

It is a simple patch and should not cause any issues.

Related issue number

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.

@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Sep 20, 2024
@meshya meshya marked this pull request as draft September 20, 2024 14:48
@meshya meshya marked this pull request as ready for review September 20, 2024 14:50
@meshya meshya marked this pull request as draft September 20, 2024 14:58
Copy link

codecov bot commented Sep 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.55%. Comparing base (7d1056b) to head (1057e95).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #9207   +/-   ##
=======================================
  Coverage   98.55%   98.55%           
=======================================
  Files         107      107           
  Lines       34867    34896   +29     
  Branches     4134     4138    +4     
=======================================
+ Hits        34364    34393   +29     
  Misses        335      335           
  Partials      168      168           
Flag Coverage Δ
CI-GHA 98.44% <100.00%> (+<0.01%) ⬆️
OS-Linux 98.11% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.52% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.79% <100.00%> (-0.01%) ⬇️
Py-3.10.11 97.78% <100.00%> (+<0.01%) ⬆️
Py-3.10.15 97.71% <100.00%> (+<0.01%) ⬆️
Py-3.11.10 97.67% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.74% <100.00%> (-0.01%) ⬇️
Py-3.12.6 98.16% <100.00%> (+<0.01%) ⬆️
Py-3.13.0-rc.2 98.15% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.67% <100.00%> (-0.01%) ⬇️
Py-3.9.20 97.61% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.22% <100.00%> (-0.01%) ⬇️
VM-macos 97.79% <100.00%> (-0.01%) ⬇️
VM-ubuntu 98.11% <100.00%> (+<0.01%) ⬆️
VM-windows 96.52% <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.

@meshya meshya marked this pull request as ready for review September 20, 2024 15:15
@Dreamsorcerer
Copy link
Member

Seems reasonable, but please resolve coverage.

@Dreamsorcerer Dreamsorcerer added the pr-unfinished The PR is unfinished and may need a volunteer to complete it label Sep 24, 2024
@meshya
Copy link
Contributor Author

meshya commented Sep 26, 2024

Ok, I try fix it today

@meshya meshya marked this pull request as draft September 26, 2024 14:20
tests/test_client_session.py Fixed Show fixed Hide fixed
tests/test_client_session.py Fixed Show fixed Hide fixed
tests/test_client_session.py Fixed Show fixed Hide fixed
@Dreamsorcerer Dreamsorcerer removed the pr-unfinished The PR is unfinished and may need a volunteer to complete it label Sep 26, 2024
@meshya meshya marked this pull request as ready for review September 26, 2024 21:55
@Dreamsorcerer Dreamsorcerer added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Sep 27, 2024
@Dreamsorcerer Dreamsorcerer merged commit 970c5d9 into aio-libs:master Sep 27, 2024
38 of 40 checks passed
Copy link
Contributor

patchback bot commented Sep 27, 2024

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

❌ Failed to cleanly apply 970c5d9 on top of patchback/backports/3.11/970c5d9d84afc8fb762ff04940b5e25449a1f6ae/pr-9207

Backporting merged PR #9207 into master

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. 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
  3. 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/970c5d9d84afc8fb762ff04940b5e25449a1f6ae/pr-9207 upstream/3.11
  4. Now, cherry-pick PR add proxy and proxy_auth varriables to ClientSession.__init__ #9207 contents into that branch:
    $ git cherry-pick -x 970c5d9d84afc8fb762ff04940b5e25449a1f6ae
    If it'll yell at you with something like fatal: Commit 970c5d9d84afc8fb762ff04940b5e25449a1f6ae is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 970c5d9d84afc8fb762ff04940b5e25449a1f6ae
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR add proxy and proxy_auth varriables to ClientSession.__init__ #9207 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/970c5d9d84afc8fb762ff04940b5e25449a1f6ae/pr-9207
  7. 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
Copy link
Member

Thanks, if you could do the backport as above, that'd be a great help.

@meshya
Copy link
Contributor Author

meshya commented Sep 28, 2024

Thanks for merge, I appreciate your time and effort, I'll do the backport soon.

meshya added a commit to meshya/aiohttp-fork that referenced this pull request Sep 28, 2024
bdraco pushed a commit that referenced this pull request Oct 1, 2024
…to ClientSession.__init__ (#9331)

Co-authored-by: J. Nick Koston <nick@koston.org>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Fixes #123'). -->
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot bot:chronographer:provided There is a change note present in this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants