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 clarification about auth parameter in ClientSession #8953

Merged
merged 2 commits into from
Aug 31, 2024
Merged

Add clarification about auth parameter in ClientSession #8953

merged 2 commits into from
Aug 31, 2024

Conversation

MaximZemskov
Copy link
Contributor

What do these changes do?

These changes clarify the behavior of the auth parameter in ClientSession.

Are there changes in behavior for the user?

No.

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

No.

Related issue number

#6764

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 Aug 31, 2024
Copy link

codecov bot commented Aug 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.27%. Comparing base (1d170d3) to head (7cef2bf).
Report is 1071 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #8953   +/-   ##
=======================================
  Coverage   98.27%   98.27%           
=======================================
  Files         107      107           
  Lines       34226    34226           
  Branches     4058     4058           
=======================================
  Hits        33637    33637           
  Misses        416      416           
  Partials      173      173           
Flag Coverage Δ
CI-GHA 98.17% <ø> (ø)
OS-Linux 97.83% <ø> (ø)
OS-Windows 96.24% <ø> (ø)
OS-macOS 97.51% <ø> (-0.01%) ⬇️
Py-3.10.11 97.60% <ø> (ø)
Py-3.10.14 97.53% <ø> (ø)
Py-3.11.9 97.77% <ø> (ø)
Py-3.12.5 97.88% <ø> (ø)
Py-3.9.13 97.49% <ø> (ø)
Py-3.9.19 97.43% <ø> (ø)
Py-pypy7.3.16 97.04% <ø> (ø)
VM-macos 97.51% <ø> (-0.01%) ⬇️
VM-ubuntu 97.83% <ø> (ø)
VM-windows 96.24% <ø> (ø)

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.

@Dreamsorcerer
Copy link
Member

I was thinking about this last night, and maybe one case we should restrict it to an origin would be when base_url is in use.
Might be worth looking at if you'd like to make another contribution?

@Dreamsorcerer Dreamsorcerer added backport-3.10 backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot labels Aug 31, 2024
@Dreamsorcerer Dreamsorcerer merged commit 51ea3b3 into aio-libs:master Aug 31, 2024
35 of 37 checks passed
Copy link
Contributor

patchback bot commented Aug 31, 2024

Backport to 3.10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.10/51ea3b39a454993dcea4bb9d3d3baa4f1a515eb0/pr-8953

Backported as #8954

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

Copy link
Contributor

patchback bot commented Aug 31, 2024

Backport to 3.11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.11/51ea3b39a454993dcea4bb9d3d3baa4f1a515eb0/pr-8953

Backported as #8955

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

patchback bot pushed a commit that referenced this pull request Aug 31, 2024
Dreamsorcerer pushed a commit that referenced this pull request Aug 31, 2024
…eter in ClientSession (#8955)

**This is a backport of PR #8953 as merged into master
(51ea3b3).**

Co-authored-by: Maxim Zemskov <[email protected]>
Dreamsorcerer pushed a commit that referenced this pull request Aug 31, 2024
…eter in ClientSession (#8954)

**This is a backport of PR #8953 as merged into master
(51ea3b3).**

Co-authored-by: Maxim Zemskov <[email protected]>
@MaximZemskov
Copy link
Contributor Author

@Dreamsorcerer I think that's a good idea. I'll make a PR either today or tomorrow.

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