LTS v21.12 Deprecations #2306

ahopkins · 2021-11-07T21:34:27Z

There are a number of things we need to remove in the next release:

Most of these are straightforward. The open question is re: StreamingHTTPResponse. More particularly, the two convenience methods we had for instantiating it: response.stream and response.file_stream.

While the release notes and warning have made it clear that StreamingHTTPResponse would be removed, we also said that the convenience methods would stick around for some time. Therefore: we must provide backwards compat in v21.12.

I have accomplished this with a new ResponseStream object which is a fairly lightweight and is meant to be a compat layer. What we really need to do is to decide the fate of stream and file_stream.

I propose the following:

Deprecate stream and mark it for removal in v22.6.
Continue with support for file_stream in the form proposed in this PR.

There really is no longer a utility in stream. Even if we do not mark it for removal, I would advocate for removing it from the docs and leaving it as undocumented in the User Guide since it is no longer the preferred method for handling these. On the other hand, file_stream does have utility separate from StreamingHTTPResonse, so I think we should carry that one forward.

Other thoughts? Opinions?

Tronic · 2021-11-14T22:13:47Z

I am happy to see old streaming removed in all forms, even if it takes some time. The return file_stream(...) thing is quite useful, so we should support that based on the new streaming system. I cannot quite recall what the current state of this is.

Also, there actually might not be much use for supporting file and file_stream return values separately, they ought both be streaming when necessary, e.g. based on file size.

ahopkins · 2021-11-14T23:40:12Z

Also, there actually might not be much use for supporting file and file_stream return values separately, they ought both be streaming when necessary, e.g. based on file size.

@Tronic another point worth mentioning is the discussion that started in Discord re: sync v async file reads. While async like what is currently in Sanic is non-blocking, it is also much slower. Combining file and file_stream does make sense, but we should also consider what method to use for the reading since smaller files will actually be better served with a little bit of blocking using regular open.

Tronic · 2021-11-15T11:13:43Z

Combining file and file_stream does make sense, but we should also consider what method to use for the reading since smaller files will actually be better served with a little bit of blocking using regular open.

Strictly all blocking disk I/O is best avoided when the server is running. Unfortunately even the simplest disk access can take 10+ seconds when SSDs are doing their reorganization, when btrfs is doing its, or when mechanical drives are spinning up. Throughput needs to be optimized elsewhere, e.g. reading all small static files (if known not to change on disk, or if there is a background thread that monitors for changes) to RAM and serving from there (probably needs to be done by the application or at the very least an extension, as it is hard to see how Sanic core could offer that).

…ations

examples/blueprints.py

examples/delayed_response.py

examples/modify_header_example.py

examples/redirect_example.py

examples/request_stream/server.py

tests/test_deprecation.py

tests/test_exceptions.py

tests/test_exceptions_handler.py

tests/test_unix_socket.py

tests/test_versioning.py

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

…ations

This is actually going to become *VERY* important if we change the multiprocessing from `fork` to `spawn` in next version. Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

This is for compatibility with newly-released Sanic 21.12 which removed the deprecated `abort()` in sanic-org/sanic#2306. Before that, it was a simple wrapper around `raise SanicException` (https://github.com/sanic-org/sanic/blob/523db190a732177eda5a641768667173ba2e2452/sanic/exceptions.py#L262-L265), so this change makes it explicit and removes the dependency on `abort()`.

* Replace `abort()` with `raise SanicException` This is for compatibility with newly-released Sanic 21.12 which removed the deprecated `abort()` in sanic-org/sanic#2306. Before that, it was a simple wrapper around `raise SanicException` (https://github.com/sanic-org/sanic/blob/523db190a732177eda5a641768667173ba2e2452/sanic/exceptions.py#L262-L265), so this change makes it explicit and removes the dependency on `abort()`. * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * Add RELEASE.md * Bump sanic from 21.9.3 to 21.12.0 Bumps [sanic](https://github.com/sanic-org/sanic) from 21.9.3 to 21.12.0. - [Release notes](https://github.com/sanic-org/sanic/releases) - [Changelog](https://github.com/sanic-org/sanic/blob/main/CHANGELOG.rst) - [Commits](sanic-org/sanic@v21.9.3...v21.12.0) --- updated-dependencies: - dependency-name: sanic dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * Update sanic-testing to 0.8.2 (0.7.0 uses the old `app.test_client` attribute which has been deprecated in Sanic 21.12). * Update tests * Skip sanic tests on windows Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Patrick Arminio <patrick.arminio@gmail.com>

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

ahopkins · 2022-07-03T18:28:11Z

This pull request has been mentioned on Sanic Community Discussion. There might be relevant details there:

https://community.sanicframework.org/t/v22-6-cant-not-use-sanic-auto-register-true/1035/2

Begin deprecations for v21.12

4c12bb7

ahopkins requested a review from Tronic November 7, 2021 21:34

Start slots

d52c954

ahopkins mentioned this pull request Dec 19, 2021

Optional uvloop use #2264

Merged

ahopkins and others added 9 commits December 20, 2021 15:07

Use common deprecation convenience wrapper

9d422db

Add slots to Sanic and Blueprint

0815979

Reorganize modules

c4a8f48

Reorganize modules

6da3a78

Begin cleaning up tests

426ff8d

Cleanup tests

6dd89a5

Deprecate register argument (#2342)

d693ffb

Resolve issues with existing tests

3b1f3c9

Merge branch 'deprecations' of github.com:sanic-org/sanic into deprec…

6e18d79

…ations

ahopkins marked this pull request as ready for review December 23, 2021 06:54

ahopkins requested review from a team as code owners December 23, 2021 06:54

ahopkins added 2 commits December 23, 2021 08:55

Resolve merge conflicts

e65d720

Resolve broken tests

8c15197

ahopkins changed the title ~~Begin deprecations for v21.12~~ LTS v21.12 Deprecations Dec 23, 2021

ahopkins added 3 commits December 23, 2021 09:30

Add deprecation test

7c145f7

Add deprecation test

c7759e2

Version

8b669c8

ahopkins added the needs review the PR appears ready but requires a review label Dec 23, 2021

Update changelog

73c751d

prryplatypus previously approved these changes Dec 23, 2021

View reviewed changes

Update tests/test_exceptions_handler.py

bb35492

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

ahopkins dismissed prryplatypus’s stale review via bb35492 December 23, 2021 19:49

ahopkins and others added 10 commits December 23, 2021 22:58

Update examples/blueprints.py

f5187e6

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

Update examples/delayed_response.py

77ff8f6

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

Merge conflicts

8f05a80

Merge branch 'deprecations' of github.com:sanic-org/sanic into deprec…

3ab870c

…ations

Update examples/modify_header_example.py

a672e36

This is actually going to become *VERY* important if we change the multiprocessing from `fork` to `spawn` in next version. Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

Update examples/request_stream/server.py

4689bd5

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

Update tests/test_app.py

72892f1

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

Update tests/test_unix_socket.py

e992138

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

Merge conflicts

f091321

squash

ebb50b7

ahopkins merged commit 8c07e38 into main Dec 23, 2021

ahopkins deleted the deprecations branch December 23, 2021 22:30

mildbyte mentioned this pull request Dec 28, 2021

Replace abort() with raise SanicException strawberry-graphql/strawberry#1520

Merged

11 tasks

ChihweiLHBird pushed a commit to ChihweiLHBird/sanic that referenced this pull request Jun 1, 2022

LTS v21.12 Deprecations (sanic-org#2306)

b4f2da4

Co-authored-by: Néstor Pérez <25409753+prryplatypus@users.noreply.github.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

LTS v21.12 Deprecations #2306

LTS v21.12 Deprecations #2306

ahopkins commented Nov 7, 2021 •

edited

Tronic commented Nov 14, 2021

ahopkins commented Nov 14, 2021

Tronic commented Nov 15, 2021 •

edited

ahopkins commented Jul 3, 2022

LTS v21.12 Deprecations #2306

LTS v21.12 Deprecations #2306

Conversation

ahopkins commented Nov 7, 2021 • edited

Tronic commented Nov 14, 2021

ahopkins commented Nov 14, 2021

Tronic commented Nov 15, 2021 • edited

ahopkins commented Jul 3, 2022

ahopkins commented Nov 7, 2021 •

edited

Tronic commented Nov 15, 2021 •

edited