Add `strategy` argument to `StreamResponse.enable_compression()` method #6257

shootkin · 2021-11-06T10:55:05Z

What do these changes do?

This PR adds strategy argument to StreamResponse.enable_compression() method.
For example, tests show that download speed becomes 2x faster for .png images when using
zlib.Z_RLE compresson strategy, like

response.enable_compression(strategy=zlib.Z_RLE)

Are there changes in behavior for the user?

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_id>.<type> for example (588.bugfix)
- if you don't have an issue_id change it to the pr id after creating the pr
- ensure type is one of the following:
  - .feature: Signifying a new feature.
  - .bugfix: Signifying a bug fix.
  - .doc: Signifying a documentation improvement.
  - .removal: Signifying a deprecation or removal of public API.
  - .misc: A ticket has been closed, but it is not of interest to users.
- Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

for more information, see https://pre-commit.ci

CHANGES/6257.feature

docs/web_reference.rst

webknjaz · 2021-11-06T11:53:10Z

Oh, the deps are broken, that's unrelated.

webknjaz · 2021-11-06T13:46:03Z

@shootkin your commits don't match your GitHub profile. You need to fix your local git config setup with the proper email for this to work.

aiohttp/web_response.py

Co-authored-by: Sam Bull <aa6bs0@sambull.org>

shootkin · 2021-11-06T14:12:15Z

@shootkin your commits don't match your GitHub profile. You need to fix your local git config setup with the proper email for this to work.

Just changed email

Dreamsorcerer · 2021-11-06T14:30:17Z

If you merge master now, then the checks will run properly.

shootkin · 2021-11-06T15:01:00Z

If you merge master now, then the checks will run properly.

Sorry, merge which way? I cannot merge it to master because it is master

Dreamsorcerer · 2021-11-06T17:20:10Z

If you merge master now, then the checks will run properly.

Sorry, merge which way? I cannot merge it to master because it is master

aio-libs:master into your branch.

shootkin

Add strategy argument to StreamResponse.enable_compression() method

aiohttp/web_response.py

…j() does not accept Optional[int]

shootkin

Please review

aiohttp/web_response.py

codecov · 2021-11-07T13:48:06Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.30%. Comparing base (94685fb) to head (118099b).
Report is 1065 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #6257   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files         107      107           
  Lines       34427    34432    +5     
  Branches     4085     4085           
=======================================
+ Hits        33844    33849    +5     
  Misses        411      411           
  Partials      172      172

Flag	Coverage Δ
CI-GHA	`98.20% <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.09%)`	⬆️
Py-3.11.9	`97.80% <100.00%> (+0.02%)`	⬆️
Py-3.12.5	`97.92% <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.08% <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.

aiohttp/web_response.py

for more information, see https://pre-commit.ci

aiohttp/abc.py

aiohttp/web_response.py

docs/web_reference.rst

docs/conf.py

aiohttp/web_response.py

patchback · 2024-09-10T22:21:48Z

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

❌ Failed to cleanly apply b8eca27 on top of patchback/backports/3.11/b8eca2754de8b30148c7bc2233f019d8045bce36/pr-6257

Backporting merged PR #6257 into master

Ensure you have a local repo clone of your fork. Unless you cloned it
from the upstream, this would be your origin remote.
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
```

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.11/b8eca2754de8b30148c7bc2233f019d8045bce36/pr-6257 upstream/3.11

Now, cherry-pick PR Add strategy argument to StreamResponse.enable_compression() method #6257 contents into that branch:
```
$ git cherry-pick -x b8eca2754de8b30148c7bc2233f019d8045bce36
```
If it'll yell at you with something like fatal: Commit b8eca2754de8b30148c7bc2233f019d8045bce36 is a merge but no -m option was given., add -m 1 as follows instead:
```
$ git cherry-pick -m1 -x b8eca2754de8b30148c7bc2233f019d8045bce36
```
At this point, you'll probably encounter some merge conflicts. You must
resolve them in to preserve the patch from PR Add strategy argument to StreamResponse.enable_compression() method #6257 as close to the
original as possible.

Push this branch to your fork on GitHub:

$ git push origin patchback/backports/3.11/b8eca2754de8b30148c7bc2233f019d8045bce36/pr-6257

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.

…od (#6257) (cherry picked from commit b8eca27)

#9114) …od (#6257) (cherry picked from commit b8eca27) Co-authored-by: Konstantin Shootkin <1991konstantin@gmail.com>

Added "strategy" argument to StreamResponse.enable_compression() method

ad33e74

shootkin requested review from asvetlov and webknjaz as code owners November 6, 2021 10:55

pre-commit-ci bot and others added 2 commits November 6, 2021 10:55

[pre-commit.ci] auto fixes from pre-commit.com hooks

69829fc

for more information, see https://pre-commit.ci

Added feature file to CHANGES folder

36bff94

psf-chronographer bot added the bot:chronographer:provided There is a change note present in this PR label Nov 6, 2021

shootkin mentioned this pull request Nov 6, 2021

Added "strategy" argument to StreamResponse.enable_compression() method #6256

Closed

5 tasks

webknjaz reviewed Nov 6, 2021

View reviewed changes

CHANGES/6257.feature Outdated Show resolved Hide resolved

webknjaz changed the title ~~Added "strategy" argument to StreamResponse.enable_compression() method~~ Add strategy argument to StreamResponse.enable_compression() method Nov 6, 2021

webknjaz reviewed Nov 6, 2021

View reviewed changes

docs/web_reference.rst Outdated Show resolved Hide resolved

webknjaz reviewed Nov 6, 2021

View reviewed changes

docs/web_reference.rst Outdated Show resolved Hide resolved

webknjaz requested a review from Dreamsorcerer November 6, 2021 11:52

Kostya Shutkin added 2 commits November 6, 2021 14:53

Changed .feature text format to rst

3cd4450

Fixed docs

fdc072f

shootkin requested a review from webknjaz November 6, 2021 12:41

Changed user email

5bbe03a

Dreamsorcerer requested changes Nov 6, 2021

View reviewed changes

aiohttp/web_response.py Show resolved Hide resolved

aiohttp/web_response.py Outdated Show resolved Hide resolved

Changed arg format

9ea70e4

Co-authored-by: Sam Bull <aa6bs0@sambull.org>

shootkin requested a review from Dreamsorcerer November 6, 2021 14:13

Merge branch 'master' of https://github.com/aio-libs/aiohttp

3f52007

shootkin commented Nov 6, 2021

View reviewed changes

Added isinstance(self._payload_writer, StreamWriter) condition

eb501ab

Dreamsorcerer reviewed Nov 6, 2021

View reviewed changes

aiohttp/web_response.py Outdated Show resolved Hide resolved

Fixed docs and strategy parameter

aaf54f4

shootkin added 3 commits November 7, 2021 08:10

Changed Optional[int] to int because linter says that zlib.compressob…

204ced6

…j() does not accept Optional[int]

Removed redundant comma

d50ad03

Changed to new format

2d8621a

shootkin commented Nov 7, 2021

View reviewed changes

aiohttp/web_response.py Outdated Show resolved Hide resolved

Dreamsorcerer reviewed Nov 7, 2021

View reviewed changes

aiohttp/web_response.py Outdated Show resolved Hide resolved

Dreamsorcerer and others added 3 commits September 10, 2024 20:56

Merge branch 'master' into master

2c38be9

Update abc.py

f239e03

[pre-commit.ci] auto fixes from pre-commit.com hooks

405af4c

for more information, see https://pre-commit.ci

Dreamsorcerer reviewed Sep 10, 2024

View reviewed changes

aiohttp/abc.py Outdated Show resolved Hide resolved

Dreamsorcerer added 4 commits September 10, 2024 21:18

Update aiohttp/abc.py

f0f283b

Update aiohttp/web_response.py

830a0a2

Update abc.py

b14f170

Update 6257.feature

a56f34a

github-advanced-security bot found potential problems Sep 10, 2024

View reviewed changes

aiohttp/web_response.py Fixed Show fixed Hide fixed

Dreamsorcerer reviewed Sep 10, 2024

View reviewed changes

docs/web_reference.rst Outdated Show resolved Hide resolved

Dreamsorcerer reviewed Sep 10, 2024

View reviewed changes

docs/conf.py Outdated Show resolved Hide resolved

Apply suggestions from code review

2efc756

Dreamsorcerer reviewed Sep 10, 2024

View reviewed changes

aiohttp/web_response.py Outdated Show resolved Hide resolved

Update aiohttp/web_response.py

f462bf0

Dreamsorcerer added the backport-3.11 Trigger automatic backporting to the 3.11 release branch by Patchback robot label Sep 10, 2024

Dreamsorcerer added 4 commits September 10, 2024 21:28

Update web_response.py

b3b9483

Update web_response.py

5d0ac13

Update test_web_response.py

6bade93

Update test_web_response.py

118099b

Dreamsorcerer merged commit b8eca27 into aio-libs:master Sep 10, 2024
34 of 35 checks passed

Dreamsorcerer pushed a commit that referenced this pull request Sep 10, 2024

Add strategy argument to StreamResponse.enable_compression() meth…

4084913

…od (#6257) (cherry picked from commit b8eca27)

Dreamsorcerer mentioned this pull request Sep 10, 2024

Add strategy argument to StreamResponse.enable_compression() meth… #9114

Merged

Dreamsorcerer added a commit that referenced this pull request Sep 10, 2024

Add strategy argument to StreamResponse.enable_compression() meth… (

398eef2

#9114) …od (#6257) (cherry picked from commit b8eca27) Co-authored-by: Konstantin Shootkin <1991konstantin@gmail.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `strategy` argument to `StreamResponse.enable_compression()` method #6257

Add `strategy` argument to `StreamResponse.enable_compression()` method #6257

shootkin commented Nov 6, 2021 •

edited

Loading

webknjaz commented Nov 6, 2021

webknjaz commented Nov 6, 2021

shootkin commented Nov 6, 2021

Dreamsorcerer commented Nov 6, 2021

shootkin commented Nov 6, 2021 •

edited

Loading

Dreamsorcerer commented Nov 6, 2021 •

edited

Loading

shootkin left a comment

shootkin left a comment

codecov bot commented Nov 7, 2021 •

edited

Loading

patchback bot commented Sep 10, 2024 •

edited

Loading

Add strategy argument to StreamResponse.enable_compression() method #6257

Add strategy argument to StreamResponse.enable_compression() method #6257

Conversation

shootkin commented Nov 6, 2021 • edited Loading

What do these changes do?

Are there changes in behavior for the user?

Related issue number

Checklist

webknjaz commented Nov 6, 2021

webknjaz commented Nov 6, 2021

shootkin commented Nov 6, 2021

Dreamsorcerer commented Nov 6, 2021

shootkin commented Nov 6, 2021 • edited Loading

Dreamsorcerer commented Nov 6, 2021 • edited Loading

shootkin left a comment

Choose a reason for hiding this comment

shootkin left a comment

Choose a reason for hiding this comment

codecov bot commented Nov 7, 2021 • edited Loading

Codecov Report

patchback bot commented Sep 10, 2024 • edited Loading

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

Backporting merged PR #6257 into master

Add `strategy` argument to `StreamResponse.enable_compression()` method #6257

Add `strategy` argument to `StreamResponse.enable_compression()` method #6257

shootkin commented Nov 6, 2021 •

edited

Loading

shootkin commented Nov 6, 2021 •

edited

Loading

Dreamsorcerer commented Nov 6, 2021 •

edited

Loading

codecov bot commented Nov 7, 2021 •

edited

Loading

patchback bot commented Sep 10, 2024 •

edited

Loading