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 documentation for handler cancellation behaviour #7128

Merged
merged 14 commits into from
Jan 8, 2023

Conversation

Dreamsorcerer
Copy link
Member

@Dreamsorcerer Dreamsorcerer commented Dec 11, 2022

Documentation for #7056.

@Dreamsorcerer Dreamsorcerer added bot:chronographer:skip This PR does not need to include a change note backport-3.9 labels Dec 11, 2022
@codecov
Copy link

codecov bot commented Dec 11, 2022

Codecov Report

Merging #7128 (151bc04) into master (6798629) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #7128   +/-   ##
=======================================
  Coverage   97.37%   97.37%           
=======================================
  Files         106      106           
  Lines       31093    31093           
  Branches     3875     3875           
=======================================
  Hits        30278    30278           
  Misses        613      613           
  Partials      202      202           
Flag Coverage Δ
CI-GHA 97.28% <ø> (ø)
OS-Linux 96.93% <ø> (-0.01%) ⬇️
OS-Windows 95.34% <ø> (-0.01%) ⬇️
OS-macOS 96.50% <ø> (ø)
Py-3.10.9 97.03% <ø> (ø)
Py-3.11.0 95.59% <ø> (ø)
Py-3.7.15 96.75% <ø> (ø)
Py-3.7.9 95.23% <ø> (ø)
Py-3.8.10 95.13% <ø> (-0.01%) ⬇️
Py-3.8.15 96.65% <ø> (ø)
Py-3.9.13 95.12% <ø> (ø)
Py-3.9.16 96.66% <ø> (ø)
Py-pypy7.3.10 94.17% <ø> (-0.01%) ⬇️
VM-macos 96.50% <ø> (ø)
VM-ubuntu 96.93% <ø> (-0.01%) ⬇️
VM-windows 95.34% <ø> (-0.01%) ⬇️

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

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@Dreamsorcerer
Copy link
Member Author

@webknjaz Any concerns with this documentation?
I've also suggested to link to it at the end of the demo tutorial as well: aio-libs/aiohttp-demos#334

@Dreamsorcerer Dreamsorcerer merged commit 743c21f into master Jan 8, 2023
@Dreamsorcerer Dreamsorcerer deleted the Dreamsorcerer-patch-4 branch January 8, 2023 01:30
@patchback
Copy link
Contributor

patchback bot commented Jan 8, 2023

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

❌ Failed to cleanly apply 743c21f on top of patchback/backports/3.9/743c21f4f683e11ecef588a0955b433a3b3102e9/pr-7128

Backporting merged PR #7128 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.9/743c21f4f683e11ecef588a0955b433a3b3102e9/pr-7128 upstream/3.9
  4. Now, cherry-pick PR Add documentation for handler cancellation behaviour #7128 contents into that branch:
    $ git cherry-pick -x 743c21f4f683e11ecef588a0955b433a3b3102e9
    If it'll yell at you with something like fatal: Commit 743c21f4f683e11ecef588a0955b433a3b3102e9 is a merge but no -m option was given., add -m 1 as follows intead:
    $ git cherry-pick -m1 -x 743c21f4f683e11ecef588a0955b433a3b3102e9
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Add documentation for handler cancellation behaviour #7128 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.9/743c21f4f683e11ecef588a0955b433a3b3102e9/pr-7128
  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.

@mosquito
Copy link
Contributor

@Dreamsorcerer is is possible to release this? I have to use ==3.8.1 for handler cancellation behaviour for all my projects.

@Dreamsorcerer
Copy link
Member Author

It's in 3.9, will be looking at pushing a beta release soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bot:chronographer:skip This PR does not need to include a change note
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants