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 aiohttp.tracing.TraceRequestHeadersSentParams into the top level file. #8947

Merged
merged 7 commits into from
Aug 31, 2024

Conversation

Hadock-is-ok
Copy link
Contributor

What do these changes do?

Add aiohttp.tracing.TraceRequestHeadersSentParams into the top level file

Are there changes in behavior for the user?

Typehints change from aiohttp.tracing.TraceRequestHeadersSent to aiohttp.TraceRequestHeadersSent.

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

No.

Related issue number

Fixes #8946

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.

@Hadock-is-ok Hadock-is-ok changed the title Update __init__.py Add aiohttp.tracing.TraceRequestHeadersSentParams into the top level file. Aug 30, 2024
Copy link

codecov bot commented Aug 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.27%. Comparing base (76a00d1) to head (925e9cf).
Report is 6 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #8947   +/-   ##
=======================================
  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% <ø> (-0.01%) ⬇️
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 Dreamsorcerer added backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot labels Aug 30, 2024
aiohttp/__init__.py Outdated Show resolved Hide resolved
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Aug 31, 2024
aiohttp/__init__.py Outdated Show resolved Hide resolved
@Hadock-is-ok
Copy link
Contributor Author

@Dreamsorcerer thanks for cleaning up my mess :^)

@Dreamsorcerer Dreamsorcerer merged commit e2437a4 into aio-libs:master Aug 31, 2024
34 of 35 checks passed
Copy link
Contributor

patchback bot commented Aug 31, 2024

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

❌ Failed to cleanly apply e2437a4 on top of patchback/backports/3.10/e2437a48ec31f830100606a62bb822e44bab1114/pr-8947

Backporting merged PR #8947 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:/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.10/e2437a48ec31f830100606a62bb822e44bab1114/pr-8947 upstream/3.10
  4. Now, cherry-pick PR Add aiohttp.tracing.TraceRequestHeadersSentParams into the top level file. #8947 contents into that branch:
    $ git cherry-pick -x e2437a48ec31f830100606a62bb822e44bab1114
    If it'll yell at you with something like fatal: Commit e2437a48ec31f830100606a62bb822e44bab1114 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x e2437a48ec31f830100606a62bb822e44bab1114
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add aiohttp.tracing.TraceRequestHeadersSentParams into the top level file. #8947 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.10/e2437a48ec31f830100606a62bb822e44bab1114/pr-8947
  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:/sanitizers/patchback-github-app.

Copy link
Contributor

patchback bot commented Aug 31, 2024

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

❌ Failed to cleanly apply e2437a4 on top of patchback/backports/3.11/e2437a48ec31f830100606a62bb822e44bab1114/pr-8947

Backporting merged PR #8947 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:/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/e2437a48ec31f830100606a62bb822e44bab1114/pr-8947 upstream/3.11
  4. Now, cherry-pick PR Add aiohttp.tracing.TraceRequestHeadersSentParams into the top level file. #8947 contents into that branch:
    $ git cherry-pick -x e2437a48ec31f830100606a62bb822e44bab1114
    If it'll yell at you with something like fatal: Commit e2437a48ec31f830100606a62bb822e44bab1114 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x e2437a48ec31f830100606a62bb822e44bab1114
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add aiohttp.tracing.TraceRequestHeadersSentParams into the top level file. #8947 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.11/e2437a48ec31f830100606a62bb822e44bab1114/pr-8947
  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:/sanitizers/patchback-github-app.

@Dreamsorcerer
Copy link
Member

I was hoping patchback would sort that one automatically. Could you sort out the backports with the above instructions?

@Hadock-is-ok
Copy link
Contributor Author

I was hoping patchback would sort that one automatically. Could you sort out the backports with the above instructions?

sure can, 2 moments.

Hadock-is-ok added a commit to Hadock-is-ok/aiohttp that referenced this pull request Aug 31, 2024
Hadock-is-ok added a commit to Hadock-is-ok/aiohttp that referenced this pull request Aug 31, 2024
@Hadock-is-ok
Copy link
Contributor Author

what branch do i pr my 3.10 changes to? i dont see any backports branch.

@Hadock-is-ok
Copy link
Contributor Author

ok, i see my eror, i pr'd to the wrong branch 👎

@Hadock-is-ok
Copy link
Contributor Author

@Dreamsorcerer would you mind making sure I did everything correct? Having a bit of a panic making sure I didn't mess anything up.

Dreamsorcerer pushed a commit that referenced this pull request Aug 31, 2024
Dreamsorcerer pushed a commit that referenced this pull request Aug 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot 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.

on_request_headers_sent params type was never imported into the top-level file.
2 participants