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

rename a shadowed test and re-enable F811 to catch future cases #8139

Merged
merged 6 commits into from
Feb 8, 2024

Conversation

alexmac
Copy link
Contributor

@alexmac alexmac commented Feb 7, 2024

What do these changes do?

Small fix to un-shadow a test that wasn't being run

Are there changes in behavior for the user?

no

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

Depends, was there a reason F811 was set to ignore?

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 Feb 7, 2024
CHANGES/8139.bugfix.rst Outdated Show resolved Hide resolved
tests/test_urldispatch.py Outdated Show resolved Hide resolved
setup.cfg Show resolved Hide resolved
Copy link

codecov bot commented Feb 7, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5df14cf) 97.51% compared to head (42e404c) 97.51%.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #8139   +/-   ##
=======================================
  Coverage   97.51%   97.51%           
=======================================
  Files         107      107           
  Lines       32745    32743    -2     
  Branches     3829     3829           
=======================================
  Hits        31930    31930           
+ Misses        614      612    -2     
  Partials      201      201           
Flag Coverage Δ
CI-GHA 97.43% <100.00%> (+<0.01%) ⬆️
OS-Linux 97.10% <100.00%> (+0.01%) ⬆️
OS-Windows 95.61% <100.00%> (+0.01%) ⬆️
OS-macOS 96.92% <100.00%> (+0.01%) ⬆️
Py-3.10.11 95.54% <100.00%> (+0.01%) ⬆️
Py-3.10.13 96.91% <100.00%> (+0.01%) ⬆️
Py-3.11.7 96.57% <100.00%> (+0.01%) ⬆️
Py-3.12.1 96.70% <100.00%> (+<0.01%) ⬆️
Py-3.8.10 95.51% <100.00%> (+0.01%) ⬆️
Py-3.8.18 96.84% <100.00%> (+0.01%) ⬆️
Py-3.9.13 95.51% <100.00%> (+0.01%) ⬆️
Py-3.9.18 96.87% <100.00%> (+0.01%) ⬆️
Py-pypy7.3.15 96.41% <100.00%> (+0.01%) ⬆️
VM-macos 96.92% <100.00%> (+0.01%) ⬆️
VM-ubuntu 97.10% <100.00%> (+0.01%) ⬆️
VM-windows 95.61% <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.

@Dreamsorcerer Dreamsorcerer added backport-3.9 Trigger automatic backporting to the 3.9 release branch by Patchback robot backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot labels Feb 8, 2024
@Dreamsorcerer Dreamsorcerer merged commit 3c0f1eb into aio-libs:master Feb 8, 2024
32 of 34 checks passed
Copy link
Contributor

patchback bot commented Feb 8, 2024

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

❌ Failed to cleanly apply 3c0f1eb on top of patchback/backports/3.9/3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00/pr-8139

Backporting merged PR #8139 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/3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00/pr-8139 upstream/3.9
  4. Now, cherry-pick PR rename a shadowed test and re-enable F811 to catch future cases #8139 contents into that branch:
    $ git cherry-pick -x 3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00
    If it'll yell at you with something like fatal: Commit 3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR rename a shadowed test and re-enable F811 to catch future cases #8139 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.9/3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00/pr-8139
  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.

Copy link
Contributor

patchback bot commented Feb 8, 2024

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

❌ Failed to cleanly apply 3c0f1eb on top of patchback/backports/3.10/3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00/pr-8139

Backporting merged PR #8139 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.10/3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00/pr-8139 upstream/3.10
  4. Now, cherry-pick PR rename a shadowed test and re-enable F811 to catch future cases #8139 contents into that branch:
    $ git cherry-pick -x 3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00
    If it'll yell at you with something like fatal: Commit 3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR rename a shadowed test and re-enable F811 to catch future cases #8139 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/3.10/3c0f1eb29d3512419ea65e7cdeb61ba3f3496f00/pr-8139
  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

@alexmac If you could follow the instructions to create the backports, that'd be appreciated.

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

None yet

3 participants