Version 21.3.2

Bugfixes

#2081 Disable response timeout on websocket connections

#2085 Make sure that blueprints with no slash is maintained when applied

Version 21.3.1

Bugfixes

#2076 Static files inside subfolders are not accessible (404)

Version 21.3.0

Release Notes

Features

#1876 Unified streaming server

#2005 New Request.id property

#2008 Allow Pathlib Path objects to be passed to app.static() helper

#2010, #2031 New startup-optimized router

#2018 #2064 Listeners for main server process

#2032 Add raw header info to request object

#2042 #2060 #2061 Introduce Signals API

#2043 Add __str__ and __repr__ to Sanic and Blueprint

#2047 Enable versioning and strict slash on BlueprintGroup

#2053 Make get_app name argument optional

#2055 JSON encoder change via app

#2063 App and connection level context objects

Bugfixes and issues resolved

Resolve #1420 url_for where strict_slashes are on for a path ending in /

Resolve #1525 Routing is incorrect with some special characters

Resolve #1653 ASGI headers in body

Resolve #1722 Using curl in chunk mode

Resolve #1730 Extra content in ASGI streaming response

Resolve #1749 Restore broken middleware edge cases

Resolve #1785 #1804 Synchronous error handlers

Resolve #1790 Protocol errors did not support async error handlers #1790

Resolve #1824 Timeout on specific methods

Resolve #1875 Response timeout error from all routes after returning several timeouts from a specific route

Resolve #1988 Handling of safe methods with body

#2001 Raise ValueError when cookie max-age is not an integer

Deprecations and Removals

#2007

Config using from_envvar

Config using from_pyfile

Config using from_object

#2009 Remove Sanic test client to its own package

#2036, #2037 Drop Python 3.6 support

Request.endpoint deprecated in favor of Request.name

handler type name prefixes removed (static, websocket, etc)

Developer infrastructure

#1995 Create FUNDING.yml

#2013 Add codeql to CI pipeline

#2038 Codecov configuration updates

#2049 Updated setup.py to use find_packages

Improved Documentation

#1218 Documentation for sanic.log.* is missing

#1608 Add documentation on calver and LTS

#1731 Support mounting application elsewhere than at root path

#2006 Upgraded type annotations and improved docstrings and API documentation

#2052 Fix some examples and docs

Miscellaneous

Request.route property

Better websocket subprotocols support

Resolve bug with middleware in Blueprint Group when passed callable

Moves common logic between Blueprint and Sanic into mixins

Route naming changed to be more consistent

request endpoint is the route name

route names are fully namespaced

Some new convenience decorators:

@app.main_process_start

@app.main_process_stop

@app.before_server_start

@app.after_server_start

@app.before_server_stop

@app.after_server_stop

@app.on_request

@app.on_response

Fixes Allow header that did not include HEAD

Using "name" keyword in url_for for a "static" route where name does not exist

Cannot have multiple app.static() without using the named param

Using "filename" keyword in url_for on a file route

unquote in route def (not automatic)

routes_all is tuples

Handler arguments are kwarg only

request.match_info is now a cached (and not computed) property

Unknown static file mimetype is sent as application/octet-stream

_host keyword in url_for

Add charset default to utf-8 for text and js content types if not specified

Version for a route can be str, float, or int

Route has ctx property

App has routes_static, routes_dynamic, routes_regex

#2044 Code cleanup and refactoring

#2072 Remove BaseSanic metaclass

#2074 Performance adjustments in handle_request_

Version 20.12.3

Bugfixes

#2021 Remove prefix from websocket handler name

Version 20.12.2

Dependencies

#2026 Fix uvloop to 0.14 because 0.15 drops Python 3.6 support

#2029 Remove old chardet requirement, add in hard multidict requirement

Version 19.12.5

Dependencies

#2025 Fix uvloop to 0.14 because 0.15 drops Python 3.6 support

#2027 Remove old chardet requirement, add in hard multidict requirement

Version 20.12.0

Features

#1993 Add disable app registry

Version 20.12.0

Features

#1945 Static route more verbose if file not found

#1954 Fix static routes registration on a blueprint

#1961 Add Python 3.9 support

#1962 Sanic CLI upgrade

#1967 Update aiofile version requirements

#1969 Update multidict version requirements

#1970 Add py.typed file

#1972 Speed optimization in request handler

#1979 Add app registry and Sanic class level app retrieval

Bugfixes

#1965 Fix Chunked Transport-Encoding in ASGI streaming response

Deprecations and Removals

#1981 Cleanup and remove deprecated code

Developer infrastructure

#1956 Fix load module test

#1973 Transition Travis from .org to .com

#1986 Update tox requirements

Improved Documentation

#1951 Documentation improvements

#1983 Remove duplicate contents in testing.rst

#1984 Fix typo in routing.rst

Version 20.9.1

Bugfixes

#1954 Fix static route registration on blueprints

#1957 Removes duplicate headers in ASGI streaming body

Version 19.12.3

Bugfixes

#1959 Removes duplicate headers in ASGI streaming body

Version 20.9.0

Features

#1887 Pass subprotocols in websockets (both sanic server and ASGI)

#1894 Automatically set test_mode flag on app instance

#1903 Add new unified method for updating app values

#1906, #1909 Adds WEBSOCKET_PING_TIMEOUT and WEBSOCKET_PING_INTERVAL configuration values

#1935 httpx version dependency updated, it is slated for removal as a dependency in v20.12

#1937 Added auto, text, and json fallback error handlers (in v21.3, the default will change form html to auto)

Bugfixes

#1897 Resolves exception from unread bytes in stream

Deprecations and Removals

#1903 config.from_envar, config.from_pyfile, and config.from_object are deprecated and set to be removed in v21.3

Developer infrastructure

#1890, #1891 Update isort calls to be compatible with new API

#1893 Remove version section from setup.cfg

#1924 Adding --strict-markers for pytest

Improved Documentation

#1922 Add explicit ASGI compliance to the README

Version 20.6.3

Bugfixes

#1884 Revert change to multiprocessing mode

Version 20.6.2

Features

#1641 Socket binding implemented properly for IPv6 and UNIX sockets

Version 20.6.1

Features

#1760 Add version parameter to websocket routes

#1866 Add sanic as an entry point command

#1880 Add handler names for websockets for url_for usage

Bugfixes

#1776 Bug fix for host parameter issue with lists

#1842 Fix static _handler pickling error

#1827 Fix reloader on OSX py38 and Windows

#1848 Reverse named_response_middlware execution order, to match normal response middleware execution order

#1853 Fix pickle error when attempting to pickle an application which contains websocket routes

Deprecations and Removals

#1739 Deprecate body_bytes to merge into body

Developer infrastructure

#1852 Fix naming of CI test env on Python nightlies

#1857 Adjust websockets version to setup.py

#1869 Wrap run()'s "protocol" type annotation in Optional[]

Improved Documentation

#1846 Update docs to clarify response middleware execution order

#1865 Fixing rst format issue that was hiding documentation

Version 20.6.0

Released, but unintentionally ommitting PR #1880, so was replaced by 20.6.1

Version 20.3.0

Features

#1762 Add srv.start_serving() and srv.serve_forever() to AsyncioServer

#1767 Make Sanic usable on hypercorn -k trio myweb.app

#1768 No tracebacks on normal errors and prettier error pages

#1769 Code cleanup in file responses

#1793 and #1819 Upgrade str.format() to f-strings

#1798 Allow multiple workers on MacOS with Python 3.8

#1820 Do not set content-type and content-length headers in exceptions

Bugfixes

#1748 Remove loop argument in asyncio.Event in Python 3.8

#1764 Allow route decorators to stack up again

#1789 Fix tests using hosts yielding incorrect url_for

#1808

Fix Ctrl+C and tests on Windows

Deprecations and Removals

#1800 Begin deprecation in way of first-class streaming, removal of body_init, body_push, and body_finish

#1801 Complete deprecation from #1666 of dictionary context on request objects.

#1807 Remove server config args that can be read directly from app

#1818 Complete deprecation of app.remove_route and request.raw_args

Dependencies

#1794 Bump httpx to 0.11.1

#1806 Import ASGIDispatch from top-level httpx (from third-party deprecation)

Developer infrastructure

#1833 Resolve broken documentation builds

Improved Documentation

#1755 Usage of response.empty()

#1778 Update README

#1783 Fix typo

#1784 Corrected changelog for docs move of MD to RST (#1691)

#1803 Update config docs to match DEFAULT_CONFIG

#1814 Update getting_started.rst

#1821 Update to deployment

#1822 Update docs with changes done in 20.3

#1834 Order of listeners

Version 19.12.0

Bugfixes

Fix blueprint middleware application

Currently, any blueprint middleware registered, irrespective of which blueprint was used to do so, was being applied to all of the routes created by the @app and @blueprint alike.

As part of this change, the blueprint based middleware application is enforced based on where they are registered.
- If you register a middleware via @blueprint.middleware then it will apply only to the routes defined by the blueprint.
- If you register a middleware via @blueprint_group.middleware then it will apply to all blueprint based routes that are part of the group.
- If you define a middleware via @app.middleware then it will be applied on all available routes (#37)
Fix url_for behavior with missing SERVER_NAME

If the SERVER_NAME was missing in the app.config entity, the url_for on the request and app were failing due to an AttributeError. This fix makes the availability of SERVER_NAME on our app.config an optional behavior. (#1707)

Improved Documentation

Move docs from MD to RST

Moved all docs from markdown to restructured text like the rest of the docs to unify the scheme and make it easier in the future to update documentation. (#1691)
Fix documentation for get and getlist of the request.args

Add additional example for showing the usage of getlist and fix the documentation string for request.args behavior (#1704)

Version 19.6.3

Features

Enable Towncrier Support

As part of this feature, towncrier is being introduced as a mechanism to partially automate the process of generating and managing change logs as part of each of pull requests. (#1631)

Improved Documentation

Documentation infrastructure changes
- Enable having a single common CHANGELOG file for both GitHub page and documentation
- Fix Sphinix deprecation warnings
- Fix documentation warnings due to invalid rst indentation
- Enable common contribution guidelines file across GitHub and documentation via CONTRIBUTING.rst (#1631)

Version 19.6.2

Features

#1562 Remove aiohttp dependency and create new SanicTestClient based upon requests-async

#1475 Added ASGI support (Beta)

#1436 Add Configure support from object string

Bugfixes

#1587 Add missing handle for Expect header.

#1560 Allow to disable Transfer-Encoding: chunked.

#1558 Fix graceful shutdown.

#1594 Strict Slashes behavior fix

Deprecations and Removals

#1544 Drop dependency on distutil

#1562 Drop support for Python 3.5

#1568 Deprecate route removal.

Warning

Sanic will not support Python 3.5 from version 19.6 and forward. However, version 18.12LTS will have its support period extended thru December 2020, and therefore passing Python's official support version 3.5, which is set to expire in September 2020.

Version 19.3

Features

#1497 Add support for zero-length and RFC 5987 encoded filename for multipart/form-data requests.

#1484 The type of expires attribute of sanic.cookies.Cookie is now enforced to be of type datetime.

#1482 Add support for the stream parameter of sanic.Sanic.add_route() available to sanic.Blueprint.add_route().

#1481 Accept negative values for route parameters with type int or number.

#1476 Deprecated the use of sanic.request.Request.raw_args - it has a fundamental flaw in which is drops repeated query string parameters. Added sanic.request.Request.query_args as a replacement for the original use-case.

#1472 Remove an unwanted None check in Request class repr implementation. This changes the default repr of a Request from <Request> to <Request: None />

#1470 Added 2 new parameters to sanic.app.Sanic.create_server:

return_asyncio_server - whether to return an asyncio.Server.

asyncio_server_kwargs - kwargs to pass to loop.create_server for the event loop that sanic is using.

This is a breaking change.

#1499 Added a set of test cases that test and benchmark route resolution.

#1457 The type of the "max-age" value in a sanic.cookies.Cookie is now enforced to be an integer. Non-integer values are replaced with 0.

#1445 Added the endpoint attribute to an incoming request, containing the name of the handler function.

#1423 Improved request streaming. request.stream is now a bounded-size buffer instead of an unbounded queue. Callers must now call await request.stream.read() instead of await request.stream.get() to read each portion of the body.

This is a breaking change.

Bugfixes

#1502 Sanic was prefetching time.time() and updating it once per second to avoid excessive time.time() calls. The implementation was observed to cause memory leaks in some cases. The benefit of the prefetch appeared to negligible, so this has been removed. Fixes #1500

#1501 Fix a bug in the auto-reloader when the process was launched as a module i.e. python -m init0.mod1 where the sanic server is started in init0/mod1.py with debug enabled and imports another module in init0.

#1376 Allow sanic test client to bind to a random port by specifying port=None when constructing a SanicTestClient

#1399 Added the ability to specify middleware on a blueprint group, so that all routes produced from the blueprints in the group have the middleware applied.

#1442 Allow the the use the SANIC_ACCESS_LOG environment variable to enable/disable the access log when not explicitly passed to app.run(). This allows the access log to be disabled for example when running via gunicorn.

Developer infrastructure

#1529 Update project PyPI credentials

#1515 fix linter issue causing travis build failures (fix #1514)

#1490 Fix python version in doc build

#1478 Upgrade setuptools version and use native docutils in doc build

#1464 Upgrade pytest, and fix caplog unit tests

Improved Documentation

#1516 Fix typo at the exception documentation

#1510 fix typo in Asyncio example

#1486 Documentation typo

#1477 Fix grammar in README.md

#1489 Added "databases" to the extensions list

#1483 Add sanic-zipkin to extensions list

#1487 Removed link to deleted repo, Sanic-OAuth, from the extensions list

#1460 18.12 changelog

#1449 Add example of amending request object

#1446 Update README

#1444 Update README

#1443 Update README, including new logo

#1440 fix minor type and pip install instruction mismatch

#1424 Documentation Enhancements

Note: 19.3.0 was skipped for packagement purposes and not released on PyPI

Version 18.12

18.12.0

Changes:
- Improved codebase test coverage from 81% to 91%.
- Added stream_large_files and host examples in static_file document
- Added methods to append and finish body content on Request (#1379)
- Integrated with .appveyor.yml for windows ci support
- Added documentation for AF_INET6 and AF_UNIX socket usage
- Adopt black/isort for codestyle
- Cancel task when connection_lost
- Simplify request ip and port retrieval logic
- Handle config error in load config file.
- Integrate with codecov for CI
- Add missed documentation for config section.
- Deprecate Handler.log
- Pinned httptools requirement to version 0.0.10+
Fixes:
- Fix remove_entity_headers helper function (#1415)
- Fix TypeError when use Blueprint.group() to group blueprint with default url_prefix, Use os.path.normpath to avoid invalid url_prefix like api//v1 f8a6af1 Rename the http module to helpers to prevent conflicts with the built-in Python http library (fixes #1323)
- Fix unittests on windows
- Fix Namespacing of sanic logger
- Fix missing quotes in decorator example
- Fix redirect with quoted param
- Fix doc for latest blueprint code
- Fix build of latex documentation relating to markdown lists
- Fix loop exception handling in app.py
- Fix content length mismatch in windows and other platform
- Fix Range header handling for static files (#1402)
- Fix the logger and make it work (#1397)
- Fix type pikcle->pickle in multiprocessing test
- Fix pickling blueprints Change the string passed in the "name" section of the namedtuples in Blueprint to match the name of the Blueprint module attribute name. This allows blueprints to be pickled and unpickled, without errors, which is a requirment of running Sanic in multiprocessing mode in Windows. Added a test for pickling and unpickling blueprints Added a test for pickling and unpickling sanic itself Added a test for enabling multiprocessing on an app with a blueprint (only useful to catch this bug if the tests are run on Windows).
- Fix document for logging

Version 0.8

0.8.3

Changes:
- Ownership changed to org 'sanic-org'

0.8.0

Changes:
- Add Server-Sent Events extension (Innokenty Lebedev)
- Graceful handling of request_handler_task cancellation (Ashley Sommer)
- Sanitize URL before redirection (aveao)
- Add url_bytes to request (johndoe46)
- py37 support for travisci (yunstanford)
- Auto reloader support for OSX (garyo)
- Add UUID route support (Volodymyr Maksymiv)
- Add pausable response streams (Ashley Sommer)
- Add weakref to request slots (vopankov)
- remove ubuntu 12.04 from test fixture due to deprecation (yunstanford)
- Allow streaming handlers in add_route (kinware)
- use travis_retry for tox (Raphael Deem)
- update aiohttp version for test client (yunstanford)
- add redirect import for clarity (yingshaoxo)
- Update HTTP Entity headers (Arnulfo Solís)
- Add register_listener method (Stephan Fitzpatrick)
- Remove uvloop/ujson dependencies for Windows (abuckenheimer)
- Content-length header on 204/304 responses (Arnulfo Solís)
- Extend WebSocketProtocol arguments and add docs (Bob Olde Hampsink, yunstanford)
- Update development status from pre-alpha to beta (Maksim Anisenkov)
- KeepAlive Timout log level changed to debug (Arnulfo Solís)
- Pin pytest to 3.3.2 because of pytest-dev/pytest#3170 (Maksim Aniskenov)
- Install Python 3.5 and 3.6 on docker container for tests (Shahin Azad)
- Add support for blueprint groups and nesting (Elias Tarhini)
- Remove uvloop for windows setup (Aleksandr Kurlov)
- Auto Reload (Yaser Amari)
- Documentation updates/fixups (multiple contributors)
Fixes:
- Fix: auto_reload in Linux (Ashley Sommer)
- Fix: broken tests for aiohttp >= 3.3.0 (Ashley Sommer)
- Fix: disable auto_reload by default on windows (abuckenheimer)
- Fix (1143): Turn off access log with gunicorn (hqy)
- Fix (1268): Support status code for file response (Cosmo Borsky)
- Fix (1266): Add content_type flag to Sanic.static (Cosmo Borsky)
- Fix: subprotocols parameter missing from add_websocket_route (ciscorn)
- Fix (1242): Responses for CI header (yunstanford)
- Fix (1237): add version constraint for websockets (yunstanford)
- Fix (1231): memory leak - always release resource (Phillip Xu)
- Fix (1221): make request truthy if transport exists (Raphael Deem)
- Fix failing tests for aiohttp>=3.1.0 (Ashley Sommer)
- Fix try_everything examples (PyManiacGR, kot83)
- Fix (1158): default to auto_reload in debug mode (Raphael Deem)
- Fix (1136): ErrorHandler.response handler call too restrictive (Julien Castiaux)
- Fix: raw requires bytes-like object (cloudship)
- Fix (1120): passing a list in to a route decorator's host arg (Timothy Ebiuwhe)
- Fix: Bug in multipart/form-data parser (DirkGuijt)
- Fix: Exception for missing parameter when value is null (NyanKiyoshi)
- Fix: Parameter check (Howie Hu)
- Fix (1089): Routing issue with named parameters and different methods (yunstanford)
- Fix (1085): Signal handling in multi-worker mode (yunstanford)
- Fix: single quote in readme.rst (Cosven)
- Fix: method typos (Dmitry Dygalo)
- Fix: log_response correct output for ip and port (Wibowo Arindrarto)
- Fix (1042): Exception Handling (Raphael Deem)
- Fix: Chinese URIs (Howie Hu)
- Fix (1079): timeout bug when self.transport is None (Raphael Deem)
- Fix (1074): fix strict_slashes when route has slash (Raphael Deem)
- Fix (1050): add samesite cookie to cookie keys (Raphael Deem)
- Fix (1065): allow add_task after server starts (Raphael Deem)
- Fix (1061): double quotes in unauthorized exception (Raphael Deem)
- Fix (1062): inject the app in add_task method (Raphael Deem)
- Fix: update environment.yml for readthedocs (Eli Uriegas)
- Fix: Cancel request task when response timeout is triggered (Jeong YunWon)
- Fix (1052): Method not allowed response for RFC7231 compliance (Raphael Deem)
- Fix: IPv6 Address and Socket Data Format (Dan Palmer)

Note: Changelog was unmaintained between 0.1 and 0.7

Version 0.1

0.1.7

Reversed static url and directory arguments to meet spec

0.1.6

Static files

Lazy Cookie Loading

0.1.5

Cookies

Blueprint listeners and ordering

Faster Router

Fix: Incomplete file reads on medium+ sized post requests

Breaking: after_start and before_stop now pass sanic as their first argument

0.1.4

Multiprocessing

0.1.3

Blueprint support

Faster Response processing

0.1.1 - 0.1.2

Struggling to update pypi via CI

0.1.0

Released to public

Files

CHANGELOG.rst

Latest commit

History

CHANGELOG.rst

File metadata and controls

Version 21.3.2

Bugfixes

Version 21.3.1

Bugfixes

Version 21.3.0

Features

Bugfixes and issues resolved

Deprecations and Removals

Developer infrastructure

Improved Documentation

Miscellaneous

Version 20.12.3

Bugfixes

Version 20.12.2

Dependencies

Version 19.12.5

Dependencies

Version 20.12.0

Features

Version 20.12.0

Features

Bugfixes

Deprecations and Removals

Developer infrastructure

Improved Documentation

Version 20.9.1

Bugfixes

Version 19.12.3

Bugfixes

Version 20.9.0

Features

Bugfixes

Deprecations and Removals

Developer infrastructure

Improved Documentation

Version 20.6.3

Bugfixes

Version 20.6.2

Features

Version 20.6.1

Features

Bugfixes

Deprecations and Removals

Developer infrastructure

Improved Documentation

Version 20.6.0

Version 20.3.0

Features

Bugfixes

Deprecations and Removals

Dependencies

Developer infrastructure

Improved Documentation

Version 19.12.0

Bugfixes

Improved Documentation

Version 19.6.3

Features

Improved Documentation

Version 19.6.2

Features

Bugfixes

Deprecations and Removals

Version 19.3

Features

Bugfixes

Developer infrastructure

Improved Documentation

Version 18.12

18.12.0

Version 0.8

0.8.3

0.8.0

Version 0.1