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

Use Query typedef from yarl for params #8564

Merged
merged 18 commits into from
Sep 9, 2024

Conversation

lpetre
Copy link
Contributor

@lpetre lpetre commented Jul 31, 2024

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.

Copy link

codecov bot commented Jul 31, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.30%. Comparing base (a33270b) to head (4611950).
Report is 1078 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #8564   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files         107      107           
  Lines       34412    34415    +3     
  Branches     4080     4080           
=======================================
+ Hits        33828    33831    +3     
  Misses        412      412           
  Partials      172      172           
Flag Coverage Δ
CI-GHA 98.19% <100.00%> (+<0.01%) ⬆️
OS-Linux 97.86% <100.00%> (+<0.01%) ⬆️
OS-Windows 96.27% <100.00%> (+<0.01%) ⬆️
OS-macOS 97.54% <100.00%> (+<0.01%) ⬆️
Py-3.10.11 97.63% <100.00%> (+<0.01%) ⬆️
Py-3.10.14 97.57% <100.00%> (+<0.01%) ⬆️
Py-3.11.9 97.80% <100.00%> (+<0.01%) ⬆️
Py-3.12.5 97.91% <100.00%> (+<0.01%) ⬆️
Py-3.9.13 97.52% <100.00%> (+<0.01%) ⬆️
Py-3.9.19 97.46% <100.00%> (+<0.01%) ⬆️
Py-pypy7.3.16 97.07% <100.00%> (+<0.01%) ⬆️
VM-macos 97.54% <100.00%> (+<0.01%) ⬆️
VM-ubuntu 97.86% <100.00%> (+<0.01%) ⬆️
VM-windows 96.27% <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.

Copy link
Member

@Dreamsorcerer Dreamsorcerer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is overly complex. I suggest we merge this into 3.10, but then create another PR for yarl to export the type, and we use that in 3.11+.

@Dreamsorcerer
Copy link
Member

bdraco exported Query in yarl. So, we probably want a new PR using that type (and increasing the minimum yarl version).

aiohttp/client.py Outdated Show resolved Hide resolved
aiohttp/typedefs.py Outdated Show resolved Hide resolved
aiohttp/typedefs.py Fixed Show fixed Hide fixed
@psf-chronographer psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Sep 8, 2024
aiohttp/typedefs.py Outdated Show resolved Hide resolved
bdraco and others added 2 commits September 8, 2024 17:39
Co-authored-by: Sam Bull <aa6bs0@sambull.org>
@bdraco bdraco added backport-3.10 backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot labels Sep 8, 2024
aiohttp/typedefs.py Fixed Show fixed Hide fixed
@bdraco bdraco marked this pull request as ready for review September 9, 2024 00:51
Copy link
Member

@bdraco bdraco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @lpetre

@bdraco bdraco merged commit b543677 into aio-libs:master Sep 9, 2024
34 of 35 checks passed
Copy link
Contributor

patchback bot commented Sep 9, 2024

Backport to 3.10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.10/b543677e67424df5f1ca2144c462107a2f594556/pr-8564

Backported as #9080

🤖 @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 Sep 9, 2024
## 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)
Copy link
Contributor

patchback bot commented Sep 9, 2024

Backport to 3.11: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.11/b543677e67424df5f1ca2144c462107a2f594556/pr-8564

Backported as #9081

🤖 @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 Sep 9, 2024
## 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)
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.

params type signature does not match the runtime
3 participants