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

Remove use of typing.ByteString #8408

Merged
merged 1 commit into from
May 10, 2024

Conversation

AlexWaygood
Copy link
Contributor

What do these changes do?

This PR removes use of typing.ByteString from aiohttp. ByteString has been deprecated since Python 3.12, and has already been removed on the CPython main branch (though that change will not be released until Python 3.14 comes out). That means that aiohttp currently installs, but fails to be imported, on Python 3.14:

    import aiohttp
env/lib/python3.14/site-packages/aiohttp/__init__.py:6: in <module>
    from .client import (
env/lib/python3.14/site-packages/aiohttp/client.py:38: in <module>
    from . import hdrs, http, payload
env/lib/python3.14/site-packages/aiohttp/payload.py:10: in <module>
    from typing import (
E   ImportError: cannot import name 'ByteString' from 'typing' (/Users/alexw/dev/cpython/Lib/typing.py)

Are there changes in behavior for the user?

The user will now be able to import aiohttp using Python 3.14+

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

no

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.

@AlexWaygood
Copy link
Contributor Author

Not sure if this needs a changelog entry since the first Python 3.14 alpha version has yet to be released. But happy to add one if necessary. I suppose it fixes a DeprecationWarning on Python 3.12 and 3.13 as well.

@Dreamsorcerer Dreamsorcerer added bot:chronographer:skip This PR does not need to include a change note backport-3.10 Trigger automatic backporting to the 3.10 release branch by Patchback robot labels May 10, 2024
Copy link

codecov bot commented May 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.64%. Comparing base (06033c2) to head (4f0bdfc).
Report is 3 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #8408   +/-   ##
=======================================
  Coverage   97.64%   97.64%           
=======================================
  Files         107      107           
  Lines       33067    33067           
  Branches     3885     3885           
=======================================
  Hits        32288    32288           
  Misses        562      562           
  Partials      217      217           
Flag Coverage Δ
CI-GHA 97.55% <100.00%> (ø)
OS-Linux 97.22% <100.00%> (ø)
OS-Windows 95.64% <100.00%> (ø)
OS-macOS 96.80% <100.00%> (-0.09%) ⬇️
Py-3.10.11 97.03% <100.00%> (ø)
Py-3.10.14 96.98% <100.00%> (ø)
Py-3.11.9 97.18% <100.00%> (-0.04%) ⬇️
Py-3.12.3 97.33% <100.00%> (ø)
Py-3.8.10 95.41% <100.00%> (ø)
Py-3.8.18 96.87% <100.00%> (ø)
Py-3.9.13 95.46% <100.00%> (-1.55%) ⬇️
Py-3.9.19 96.97% <100.00%> (ø)
Py-pypy7.3.15 96.54% <100.00%> (-0.01%) ⬇️
VM-macos 96.80% <100.00%> (-0.09%) ⬇️
VM-ubuntu 97.22% <100.00%> (ø)
VM-windows 95.64% <100.00%> (ø)

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
Copy link
Member

I suppose it fixes a DeprecationWarning on Python 3.12 and 3.13 as well.

We error on warnings, so I don't think there's a warning being produced currently.

@Dreamsorcerer Dreamsorcerer merged commit 17c3971 into aio-libs:master May 10, 2024
38 of 40 checks passed
Copy link
Contributor

patchback bot commented May 10, 2024

Backport to 3.10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/3.10/17c39719a45a4a75550bb2c619f73ef0bb28dbe3/pr-8408

Backported as #8409

🤖 @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 May 10, 2024
@AlexWaygood AlexWaygood deleted the remove-bytestring branch May 10, 2024 22:43
Dreamsorcerer pushed a commit that referenced this pull request May 10, 2024
…8409)

**This is a backport of PR #8408 as merged into master
(17c3971).**

## What do these changes do?

This PR removes use of `typing.ByteString` from `aiohttp`. `ByteString`
has been deprecated since Python 3.12, and has already been removed on
the CPython `main` branch (though that change will not be released until
Python 3.14 comes out). That means that `aiohttp` currently installs,
but fails to be imported, on Python 3.14:

```pytb
    import aiohttp
env/lib/python3.14/site-packages/aiohttp/__init__.py:6: in <module>
    from .client import (
env/lib/python3.14/site-packages/aiohttp/client.py:38: in <module>
    from . import hdrs, http, payload
env/lib/python3.14/site-packages/aiohttp/payload.py:10: in <module>
    from typing import (
E   ImportError: cannot import name 'ByteString' from 'typing' (/Users/alexw/dev/cpython/Lib/typing.py)
```

## Are there changes in behavior for the user?

The user will now be able to import `aiohttp` using Python 3.14+

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

no

## 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: Alex Waygood <Alex.Waygood@Gmail.com>
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 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