Skip to content

[PR #8564/b543677e backport][3.10] Use Query typedef from yarl for params#9080

Merged
bdraco merged 1 commit into3.10from
patchback/backports/3.10/b543677e67424df5f1ca2144c462107a2f594556/pr-8564
Sep 9, 2024
Merged

[PR #8564/b543677e backport][3.10] Use Query typedef from yarl for params#9080
bdraco merged 1 commit into3.10from
patchback/backports/3.10/b543677e67424df5f1ca2144c462107a2f594556/pr-8564

Conversation

@patchback
Copy link
Copy Markdown
Contributor

@patchback patchback bot commented Sep 9, 2024

This is a backport of PR #8564 as merged into master (b543677).

What do these changes do?

The type signature for params does not match the functionality provided by yarl. Update the type signature to expose the full feature set of yarl.

Are there changes in behavior for the user?

No changes to the user, expect that type checking will now match the runtime functionality.

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

The only burden I see is that the type signature in yarl is not exported in the package, which means these two files should be kept in sync. I would recommend yarl be updated to export the type signature and aiohttp could use that directly.

Related issue number

Fixes #8563

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.

## What do these changes do?

The type signature for params does not match the functionality provided
by yarl. Update the type signature to expose the full feature set of
yarl.

## Are there changes in behavior for the user?

No changes to the user, expect that type checking will now match the
runtime functionality.

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

The only burden I see is that the type signature in yarl is not exported
in the package, which means these two files should be kept in sync. I
would recommend yarl be updated to export the type signature and aiohttp
could use that directly.

## Related issue number
Fixes #8563

## Checklist

- [x] 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 &lt;Name&gt; &lt;Surname&gt;.
  * 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:
    ```rst
    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.

---------

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>
Co-authored-by: Sam Bull <aa6bs0@sambull.org>
(cherry picked from commit b543677)
@patchback patchback bot mentioned this pull request Sep 9, 2024
5 tasks
@bdraco bdraco enabled auto-merge (squash) September 9, 2024 02:34
@codecov
Copy link
Copy Markdown

codecov bot commented Sep 9, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.76%. Comparing base (524bd16) to head (e1b2382).
Report is 178 commits behind head on 3.10.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             3.10    #9080   +/-   ##
=======================================
  Coverage   97.76%   97.76%           
=======================================
  Files         108      108           
  Lines       34462    34465    +3     
  Branches     4098     4098           
=======================================
+ Hits        33692    33695    +3     
  Misses        575      575           
  Partials      195      195           
Flag Coverage Δ
CI-GHA 97.66% <100.00%> (+<0.01%) ⬆️
OS-Linux 97.33% <100.00%> (+<0.01%) ⬆️
OS-Windows 94.91% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.03% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.11% <100.00%> (+<0.01%) ⬆️
Py-3.10.14 97.05% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.28% <100.00%> (+<0.01%) ⬆️
Py-3.12.5 97.38% <100.00%> (+<0.01%) ⬆️
Py-3.8.10 94.53% <100.00%> (+<0.01%) ⬆️
Py-3.8.18 96.84% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.01% <100.00%> (-0.01%) ⬇️
Py-3.9.19 96.96% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 96.55% <100.00%> (+<0.01%) ⬆️
VM-macos 97.03% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 97.33% <100.00%> (+<0.01%) ⬆️
VM-windows 94.91% <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.

@bdraco bdraco merged commit 19049fd into 3.10 Sep 9, 2024
@bdraco bdraco deleted the patchback/backports/3.10/b543677e67424df5f1ca2144c462107a2f594556/pr-8564 branch September 9, 2024 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants