Vasanko/sanic
2
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity
1a63b9bec0
sanic/CHANGELOG.rst
Adam Hopkins 4ad8168bb0
Version 22.12 release notes (#2637)
2022-12-27 16:50:36 +02:00

1162 lines
38 KiB
ReStructuredText
Raw Blame History

.. note::
CHANGELOG files are maintained in ``./docs/sanic/releases``. To view the full CHANGELOG, please visit https://sanic.readthedocs.io/en/stable/sanic/changelog.html.
Version 21.6.1
--------------
**Bugfixes**
* `#2178 <https://github.com/sanic-org/sanic/pull/2178>`_
Update sanic-routing to allow for better splitting of complex URI templates
* `#2183 <https://github.com/sanic-org/sanic/pull/2183>`_
Proper handling of chunked request bodies to resolve phantom 503 in logs
* `#2181 <https://github.com/sanic-org/sanic/pull/2181>`_
Resolve regression in exception logging
* `#2201 <https://github.com/sanic-org/sanic/pull/2201>`_
Cleanup request info in pipelined requests
Version 21.6.0
--------------
**Features**
* `#2094 <https://github.com/sanic-org/sanic/pull/2094>`_
Add ``response.eof()`` method for closing a stream in a handler
* `#2097 <https://github.com/sanic-org/sanic/pull/2097>`_
Allow case-insensitive HTTP Upgrade header
* `#2104 <https://github.com/sanic-org/sanic/pull/2104>`_
Explicit usage of CIMultiDict getters
* `#2109 <https://github.com/sanic-org/sanic/pull/2109>`_
Consistent use of error loggers
* `#2114 <https://github.com/sanic-org/sanic/pull/2114>`_
New ``client_ip`` access of connection info instance
* `#2119 <https://github.com/sanic-org/sanic/pull/2119>`_
Alternatate classes on instantiation for ``Config`` and ``Sanic.ctx``
* `#2133 <https://github.com/sanic-org/sanic/pull/2133>`_
Implement new version of AST router
* Proper differentiation between ``alpha`` and ``string`` param types
* Adds a ``slug`` param type, example: ``<foo:slug>``
* Deprecates ``<foo:string>`` in favor of ``<foo:str>``
* Deprecates ``<foo:number>`` in favor of ``<foo:float>``
* Adds a ``route.uri`` accessor
* `#2136 <https://github.com/sanic-org/sanic/pull/2136>`_
CLI improvements with new optional params
* `#2137 <https://github.com/sanic-org/sanic/pull/2137>`_
Add ``version_prefix`` to URL builders
* `#2140 <https://github.com/sanic-org/sanic/pull/2140>`_
Event autoregistration with ``EVENT_AUTOREGISTER``
* `#2146 <https://github.com/sanic-org/sanic/pull/2146>`_, `#2147 <https://github.com/sanic-org/sanic/pull/2147>`_
Require stricter names on ``Sanic()`` and ``Blueprint()``
* `#2150 <https://github.com/sanic-org/sanic/pull/2150>`_
Infinitely reusable and nestable ``Blueprint`` and ``BlueprintGroup``
* `#2154 <https://github.com/sanic-org/sanic/pull/2154>`_
Upgrade ``websockets`` dependency to min version
* `#2155 <https://github.com/sanic-org/sanic/pull/2155>`_
Allow for maximum header sizes to be increased: ``REQUEST_MAX_HEADER_SIZE``
* `#2157 <https://github.com/sanic-org/sanic/pull/2157>`_
Allow app factory pattern in CLI
* `#2165 <https://github.com/sanic-org/sanic/pull/2165>`_
Change HTTP methods to enums
* `#2167 <https://github.com/sanic-org/sanic/pull/2167>`_
Allow auto-reloading on additional directories
* `#2168 <https://github.com/sanic-org/sanic/pull/2168>`_
Add simple HTTP server to CLI
* `#2170 <https://github.com/sanic-org/sanic/pull/2170>`_
Additional methods for attaching ``HTTPMethodView``
**Bugfixes**
* `#2091 <https://github.com/sanic-org/sanic/pull/2091>`_
Fix ``UserWarning`` in ASGI mode for missing ``__slots__``
* `#2099 <https://github.com/sanic-org/sanic/pull/2099>`_
Fix static request handler logging exception on 404
* `#2110 <https://github.com/sanic-org/sanic/pull/2110>`_
Fix request.args.pop removes parameters inconsistently
* `#2107 <https://github.com/sanic-org/sanic/pull/2107>`_
Fix type hinting for load_env
* `#2127 <https://github.com/sanic-org/sanic/pull/2127>`_
Make sure ASGI ws subprotocols is a list
* `#2128 <https://github.com/sanic-org/sanic/pull/2128>`_
Fix issue where Blueprint exception handlers do not consistently route to proper handler
**Deprecations and Removals**
* `#2156 <https://github.com/sanic-org/sanic/pull/2156>`_
Remove config value ``REQUEST_BUFFER_QUEUE_SIZE``
* `#2170 <https://github.com/sanic-org/sanic/pull/2170>`_
``CompositionView`` deprecated and marked for removal in 21.12
* `#2172 <https://github.com/sanic-org/sanic/pull/2170>`_
Deprecate StreamingHTTPResponse
**Developer infrastructure**
* `#2149 <https://github.com/sanic-org/sanic/pull/2149>`_
Remove Travis CI in favor of GitHub Actions
**Improved Documentation**
* `#2164 <https://github.com/sanic-org/sanic/pull/2164>`_
Fix typo in documentation
* `#2100 <https://github.com/sanic-org/sanic/pull/2100>`_
Remove documentation for non-existent arguments
Version 21.3.2
--------------
**Bugfixes**
* `#2081 <https://github.com/sanic-org/sanic/pull/2081>`_
Disable response timeout on websocket connections
* `#2085 <https://github.com/sanic-org/sanic/pull/2085>`_
Make sure that blueprints with no slash is maintained when applied
Version 21.3.1
--------------
**Bugfixes**
* `#2076 <https://github.com/sanic-org/sanic/pull/2076>`_
Static files inside subfolders are not accessible (404)
Version 21.3.0
--------------
`Release Notes <https://sanicframework.org/en/guide/release-notes/v21.3.html>`_
**Features**
*
`#1876 <https://github.com/sanic-org/sanic/pull/1876>`_
Unified streaming server
*
`#2005 <https://github.com/sanic-org/sanic/pull/2005>`_
New ``Request.id`` property
*
`#2008 <https://github.com/sanic-org/sanic/pull/2008>`_
Allow Pathlib Path objects to be passed to ``app.static()`` helper
*
`#2010 <https://github.com/sanic-org/sanic/pull/2010>`_, `#2031 <https://github.com/sanic-org/sanic/pull/2031>`_
New startup-optimized router
*
`#2018 <https://github.com/sanic-org/sanic/pull/2018>`_
`#2064 <https://github.com/sanic-org/sanic/pull/2064>`_
Listeners for main server process
*
`#2032 <https://github.com/sanic-org/sanic/pull/2032>`_
Add raw header info to request object
*
`#2042 <https://github.com/sanic-org/sanic/pull/2042>`_
`#2060 <https://github.com/sanic-org/sanic/pull/2060>`_
`#2061 <https://github.com/sanic-org/sanic/pull/2061>`_
Introduce Signals API
*
`#2043 <https://github.com/sanic-org/sanic/pull/2043>`_
Add ``__str__`` and ``__repr__`` to Sanic and Blueprint
*
`#2047 <https://github.com/sanic-org/sanic/pull/2047>`_
Enable versioning and strict slash on BlueprintGroup
*
`#2053 <https://github.com/sanic-org/sanic/pull/2053>`_
Make ``get_app`` name argument optional
*
`#2055 <https://github.com/sanic-org/sanic/pull/2055>`_
JSON encoder change via app
*
`#2063 <https://github.com/sanic-org/sanic/pull/2063>`_
App and connection level context objects
**Bugfixes**
* Resolve `#1420 <https://github.com/sanic-org/sanic/pull/1420>`_
``url_for`` where ``strict_slashes`` are on for a path ending in ``/``
* Resolve `#1525 <https://github.com/sanic-org/sanic/pull/1525>`_
Routing is incorrect with some special characters
* Resolve `#1653 <https://github.com/sanic-org/sanic/pull/1653>`_
ASGI headers in body
* Resolve `#1722 <https://github.com/sanic-org/sanic/pull/1722>`_
Using curl in chunk mode
* Resolve `#1730 <https://github.com/sanic-org/sanic/pull/1730>`_
Extra content in ASGI streaming response
* Resolve `#1749 <https://github.com/sanic-org/sanic/pull/1749>`_
Restore broken middleware edge cases
* Resolve `#1785 <https://github.com/sanic-org/sanic/pull/1785>`_
`#1804 <https://github.com/sanic-org/sanic/pull/1804>`_
Synchronous error handlers
* Resolve `#1790 <https://github.com/sanic-org/sanic/pull/1790>`_
Protocol errors did not support async error handlers #1790
* Resolve `#1824 <https://github.com/sanic-org/sanic/pull/1824>`_
Timeout on specific methods
* Resolve `#1875 <https://github.com/sanic-org/sanic/pull/1875>`_
Response timeout error from all routes after returning several timeouts from a specific route
* Resolve `#1988 <https://github.com/sanic-org/sanic/pull/1988>`_
Handling of safe methods with body
*
`#2001 <https://github.com/sanic-org/sanic/pull/2001>`_
Raise ValueError when cookie max-age is not an integer
**Deprecations and Removals**
*
`#2007 <https://github.com/sanic-org/sanic/pull/2007>`_
* Config using ``from_envvar``
* Config using ``from_pyfile``
* Config using ``from_object``
*
`#2009 <https://github.com/sanic-org/sanic/pull/2009>`_
Remove Sanic test client to its own package
*
`#2036 <https://github.com/sanic-org/sanic/pull/2036>`_,
`#2037 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/1995>`_
Create FUNDING.yml
*
`#2013 <https://github.com/sanic-org/sanic/pull/2013>`_
Add codeql to CI pipeline
*
`#2038 <https://github.com/sanic-org/sanic/pull/2038>`_
Codecov configuration updates
*
`#2049 <https://github.com/sanic-org/sanic/pull/2049>`_
Updated setup.py to use ``find_packages``
**Improved Documentation**
*
`#1218 <https://github.com/sanic-org/sanic/pull/1218>`_
Documentation for sanic.log.* is missing
*
`#1608 <https://github.com/sanic-org/sanic/pull/1608>`_
Add documentation on calver and LTS
*
`#1731 <https://github.com/sanic-org/sanic/pull/1731>`_
Support mounting application elsewhere than at root path
*
`#2006 <https://github.com/sanic-org/sanic/pull/2006>`_
Upgraded type annotations and improved docstrings and API documentation
*
`#2052 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/2044>`_
Code cleanup and refactoring
*
`#2072 <https://github.com/sanic-org/sanic/pull/2072>`_
Remove ``BaseSanic`` metaclass
*
`#2074 <https://github.com/sanic-org/sanic/pull/2074>`_
Performance adjustments in ``handle_request_``
Version 20.12.3
---------------
`Current LTS version`
**Bugfixes**
*
`#2021 <https://github.com/sanic-org/sanic/pull/2021>`_
Remove prefix from websocket handler name
Version 20.12.2
---------------
**Dependencies**
*
`#2026 <https://github.com/sanic-org/sanic/pull/2026>`_
Fix uvloop to 0.14 because 0.15 drops Python 3.6 support
*
`#2029 <https://github.com/sanic-org/sanic/pull/2029>`_
Remove old chardet requirement, add in hard multidict requirement
Version 19.12.5
---------------
**Dependencies**
*
`#2025 <https://github.com/sanic-org/sanic/pull/2025>`_
Fix uvloop to 0.14 because 0.15 drops Python 3.6 support
*
`#2027 <https://github.com/sanic-org/sanic/pull/2027>`_
Remove old chardet requirement, add in hard multidict requirement
Version 20.12.0
---------------
**Features**
*
`#1993 <https://github.com/sanic-org/sanic/pull/1993>`_
Add disable app registry
*
`#1945 <https://github.com/sanic-org/sanic/pull/1945>`_
Static route more verbose if file not found
*
`#1954 <https://github.com/sanic-org/sanic/pull/1954>`_
Fix static routes registration on a blueprint
*
`#1961 <https://github.com/sanic-org/sanic/pull/1961>`_
Add Python 3.9 support
*
`#1962 <https://github.com/sanic-org/sanic/pull/1962>`_
Sanic CLI upgrade
*
`#1967 <https://github.com/sanic-org/sanic/pull/1967>`_
Update aiofile version requirements
*
`#1969 <https://github.com/sanic-org/sanic/pull/1969>`_
Update multidict version requirements
*
`#1970 <https://github.com/sanic-org/sanic/pull/1970>`_
Add py.typed file
*
`#1972 <https://github.com/sanic-org/sanic/pull/1972>`_
Speed optimization in request handler
*
`#1979 <https://github.com/sanic-org/sanic/pull/1979>`_
Add app registry and Sanic class level app retrieval
**Bugfixes**
*
`#1965 <https://github.com/sanic-org/sanic/pull/1965>`_
Fix Chunked Transport-Encoding in ASGI streaming response
**Deprecations and Removals**
*
`#1981 <https://github.com/sanic-org/sanic/pull/1981>`_
Cleanup and remove deprecated code
**Developer infrastructure**
*
`#1956 <https://github.com/sanic-org/sanic/pull/1956>`_
Fix load module test
*
`#1973 <https://github.com/sanic-org/sanic/pull/1973>`_
Transition Travis from .org to .com
*
`#1986 <https://github.com/sanic-org/sanic/pull/1986>`_
Update tox requirements
**Improved Documentation**
*
`#1951 <https://github.com/sanic-org/sanic/pull/1951>`_
Documentation improvements
*
`#1983 <https://github.com/sanic-org/sanic/pull/1983>`_
Remove duplicate contents in testing.rst
*
`#1984 <https://github.com/sanic-org/sanic/pull/1984>`_
Fix typo in routing.rst
Version 20.9.1
---------------
**Bugfixes**
*
`#1954 <https://github.com/sanic-org/sanic/pull/1954>`_
Fix static route registration on blueprints
*
`#1957 <https://github.com/sanic-org/sanic/pull/1957>`_
Removes duplicate headers in ASGI streaming body
Version 19.12.3
---------------
**Bugfixes**
*
`#1959 <https://github.com/sanic-org/sanic/pull/1959>`_
Removes duplicate headers in ASGI streaming body
Version 20.9.0
---------------
**Features**
*
`#1887 <https://github.com/sanic-org/sanic/pull/1887>`_
Pass subprotocols in websockets (both sanic server and ASGI)
*
`#1894 <https://github.com/sanic-org/sanic/pull/1894>`_
Automatically set ``test_mode`` flag on app instance
*
`#1903 <https://github.com/sanic-org/sanic/pull/1903>`_
Add new unified method for updating app values
*
`#1906 <https://github.com/sanic-org/sanic/pull/1906>`_,
`#1909 <https://github.com/sanic-org/sanic/pull/1909>`_
Adds WEBSOCKET_PING_TIMEOUT and WEBSOCKET_PING_INTERVAL configuration values
*
`#1935 <https://github.com/sanic-org/sanic/pull/1935>`_
httpx version dependency updated, it is slated for removal as a dependency in v20.12
*
`#1937 <https://github.com/sanic-org/sanic/pull/1937>`_
Added auto, text, and json fallback error handlers (in v21.3, the default will change form html to auto)
**Bugfixes**
*
`#1897 <https://github.com/sanic-org/sanic/pull/1897>`_
Resolves exception from unread bytes in stream
**Deprecations and Removals**
*
`#1903 <https://github.com/sanic-org/sanic/pull/1903>`_
config.from_envar, config.from_pyfile, and config.from_object are deprecated and set to be removed in v21.3
**Developer infrastructure**
*
`#1890 <https://github.com/sanic-org/sanic/pull/1890>`_,
`#1891 <https://github.com/sanic-org/sanic/pull/1891>`_
Update isort calls to be compatible with new API
*
`#1893 <https://github.com/sanic-org/sanic/pull/1893>`_
Remove version section from setup.cfg
*
`#1924 <https://github.com/sanic-org/sanic/pull/1924>`_
Adding --strict-markers for pytest
**Improved Documentation**
*
`#1922 <https://github.com/sanic-org/sanic/pull/1922>`_
Add explicit ASGI compliance to the README
Version 20.6.3
---------------
**Bugfixes**
*
`#1884 <https://github.com/sanic-org/sanic/pull/1884>`_
Revert change to multiprocessing mode
Version 20.6.2
---------------
**Features**
*
`#1641 <https://github.com/sanic-org/sanic/pull/1641>`_
Socket binding implemented properly for IPv6 and UNIX sockets
Version 20.6.1
---------------
**Features**
*
`#1760 <https://github.com/sanic-org/sanic/pull/1760>`_
Add version parameter to websocket routes
*
`#1866 <https://github.com/sanic-org/sanic/pull/1866>`_
Add ``sanic`` as an entry point command
*
`#1880 <https://github.com/sanic-org/sanic/pull/1880>`_
Add handler names for websockets for url_for usage
**Bugfixes**
*
`#1776 <https://github.com/sanic-org/sanic/pull/1776>`_
Bug fix for host parameter issue with lists
*
`#1842 <https://github.com/sanic-org/sanic/pull/1842>`_
Fix static _handler pickling error
*
`#1827 <https://github.com/sanic-org/sanic/pull/1827>`_
Fix reloader on OSX py38 and Windows
*
`#1848 <https://github.com/sanic-org/sanic/pull/1848>`_
Reverse named_response_middlware execution order, to match normal response middleware execution order
*
`#1853 <https://github.com/sanic-org/sanic/pull/1853>`_
Fix pickle error when attempting to pickle an application which contains websocket routes
**Deprecations and Removals**
*
`#1739 <https://github.com/sanic-org/sanic/pull/1739>`_
Deprecate body_bytes to merge into body
**Developer infrastructure**
*
`#1852 <https://github.com/sanic-org/sanic/pull/1852>`_
Fix naming of CI test env on Python nightlies
*
`#1857 <https://github.com/sanic-org/sanic/pull/1857>`_
Adjust websockets version to setup.py
*
`#1869 <https://github.com/sanic-org/sanic/pull/1869>`_
Wrap run()'s "protocol" type annotation in Optional[]
**Improved Documentation**
*
`#1846 <https://github.com/sanic-org/sanic/pull/1846>`_
Update docs to clarify response middleware execution order
*
`#1865 <https://github.com/sanic-org/sanic/pull/1865>`_
Fixing rst format issue that was hiding documentation
Version 20.6.0
---------------
*Released, but unintentionally omitting PR #1880, so was replaced by 20.6.1*
Version 20.3.0
---------------
**Features**
*
`#1762 <https://github.com/sanic-org/sanic/pull/1762>`_
Add ``srv.start_serving()`` and ``srv.serve_forever()`` to ``AsyncioServer``
*
`#1767 <https://github.com/sanic-org/sanic/pull/1767>`_
Make Sanic usable on ``hypercorn -k trio myweb.app``
*
`#1768 <https://github.com/sanic-org/sanic/pull/1768>`_
No tracebacks on normal errors and prettier error pages
*
`#1769 <https://github.com/sanic-org/sanic/pull/1769>`_
Code cleanup in file responses
*
`#1793 <https://github.com/sanic-org/sanic/pull/1793>`_ and
`#1819 <https://github.com/sanic-org/sanic/pull/1819>`_
Upgrade ``str.format()`` to f-strings
*
`#1798 <https://github.com/sanic-org/sanic/pull/1798>`_
Allow multiple workers on MacOS with Python 3.8
*
`#1820 <https://github.com/sanic-org/sanic/pull/1820>`_
Do not set content-type and content-length headers in exceptions
**Bugfixes**
*
`#1748 <https://github.com/sanic-org/sanic/pull/1748>`_
Remove loop argument in ``asyncio.Event`` in Python 3.8
*
`#1764 <https://github.com/sanic-org/sanic/pull/1764>`_
Allow route decorators to stack up again
*
`#1789 <https://github.com/sanic-org/sanic/pull/1789>`_
Fix tests using hosts yielding incorrect ``url_for``
*
`#1808 <https://github.com/sanic-org/sanic/pull/1808>`_
Fix Ctrl+C and tests on Windows
**Deprecations and Removals**
*
`#1800 <https://github.com/sanic-org/sanic/pull/1800>`_
Begin deprecation in way of first-class streaming, removal of ``body_init``, ``body_push``, and ``body_finish``
*
`#1801 <https://github.com/sanic-org/sanic/pull/1801>`_
Complete deprecation from `#1666 <https://github.com/sanic-org/sanic/pull/1666>`_ of dictionary context on ``request`` objects.
*
`#1807 <https://github.com/sanic-org/sanic/pull/1807>`_
Remove server config args that can be read directly from app
*
`#1818 <https://github.com/sanic-org/sanic/pull/1818>`_
Complete deprecation of ``app.remove_route`` and ``request.raw_args``
**Dependencies**
*
`#1794 <https://github.com/sanic-org/sanic/pull/1794>`_
Bump ``httpx`` to 0.11.1
*
`#1806 <https://github.com/sanic-org/sanic/pull/1806>`_
Import ``ASGIDispatch`` from top-level ``httpx`` (from third-party deprecation)
**Developer infrastructure**
*
`#1833 <https://github.com/sanic-org/sanic/pull/1833>`_
Resolve broken documentation builds
**Improved Documentation**
*
`#1755 <https://github.com/sanic-org/sanic/pull/1755>`_
Usage of ``response.empty()``
*
`#1778 <https://github.com/sanic-org/sanic/pull/1778>`_
Update README
*
`#1783 <https://github.com/sanic-org/sanic/pull/1783>`_
Fix typo
*
`#1784 <https://github.com/sanic-org/sanic/pull/1784>`_
Corrected changelog for docs move of MD to RST (`#1691 <https://github.com/sanic-org/sanic/pull/1691>`_)
*
`#1803 <https://github.com/sanic-org/sanic/pull/1803>`_
Update config docs to match DEFAULT_CONFIG
*
`#1814 <https://github.com/sanic-org/sanic/pull/1814>`_
Update getting_started.rst
*
`#1821 <https://github.com/sanic-org/sanic/pull/1821>`_
Update to deployment
*
`#1822 <https://github.com/sanic-org/sanic/pull/1822>`_
Update docs with changes done in 20.3
*
`#1834 <https://github.com/sanic-org/sanic/pull/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 :code:`@app` and :code:`@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 :code:`@blueprint.middleware` then it will apply only to the routes defined by the blueprint.
- If you register a middleware via :code:`@blueprint_group.middleware` then it will apply to all blueprint based routes that are part of the group.
- If you define a middleware via :code:`@app.middleware` then it will be applied on all available routes (`#37 <https://github.com/sanic-org/sanic/issues/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 <https://github.com/sanic-org/sanic/issues/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 <https://github.com/sanic-org/sanic/issues/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 <https://github.com/sanic-org/sanic/issues/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 <https://github.com/sanic-org/sanic/issues/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 <https://github.com/sanic-org/sanic/issues/1631>`__)
Version 19.6.2
--------------
**Features**
*
`#1562 <https://github.com/sanic-org/sanic/pull/1562>`_
Remove ``aiohttp`` dependency and create new ``SanicTestClient`` based upon
`requests-async <https://github.com/encode/requests-async>`_
*
`#1475 <https://github.com/sanic-org/sanic/pull/1475>`_
Added ASGI support (Beta)
*
`#1436 <https://github.com/sanic-org/sanic/pull/1436>`_
Add Configure support from object string
**Bugfixes**
*
`#1587 <https://github.com/sanic-org/sanic/pull/1587>`_
Add missing handle for Expect header.
*
`#1560 <https://github.com/sanic-org/sanic/pull/1560>`_
Allow to disable Transfer-Encoding: chunked.
*
`#1558 <https://github.com/sanic-org/sanic/pull/1558>`_
Fix graceful shutdown.
*
`#1594 <https://github.com/sanic-org/sanic/pull/1594>`_
Strict Slashes behavior fix
**Deprecations and Removals**
*
`#1544 <https://github.com/sanic-org/sanic/pull/1544>`_
Drop dependency on distutil
*
`#1562 <https://github.com/sanic-org/sanic/pull/1562>`_
Drop support for Python 3.5
*
`#1568 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/1497>`_
Add support for zero-length and RFC 5987 encoded filename for
multipart/form-data requests.
*
`#1484 <https://github.com/sanic-org/sanic/pull/1484>`_
The type of ``expires`` attribute of ``sanic.cookies.Cookie`` is now
enforced to be of type ``datetime``.
*
`#1482 <https://github.com/sanic-org/sanic/pull/1482>`_
Add support for the ``stream`` parameter of ``sanic.Sanic.add_route()``
available to ``sanic.Blueprint.add_route()``.
*
`#1481 <https://github.com/sanic-org/sanic/pull/1481>`_
Accept negative values for route parameters with type ``int`` or ``number``.
*
`#1476 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/1499>`_
Added a set of test cases that test and benchmark route resolution.
*
`#1457 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/1445>`_
Added the ``endpoint`` attribute to an incoming ``request``\ , containing the
name of the handler function.
*
`#1423 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/1500>`_
*
`#1501 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/1376>`_
Allow sanic test client to bind to a random port by specifying
``port=None`` when constructing a ``SanicTestClient``
*
`#1399 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/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 <https://github.com/sanic-org/sanic/pull/1529>`_ Update project PyPI credentials
* `#1515 <https://github.com/sanic-org/sanic/pull/1515>`_ fix linter issue causing travis build failures (fix #1514)
* `#1490 <https://github.com/sanic-org/sanic/pull/1490>`_ Fix python version in doc build
* `#1478 <https://github.com/sanic-org/sanic/pull/1478>`_ Upgrade setuptools version and use native docutils in doc build
* `#1464 <https://github.com/sanic-org/sanic/pull/1464>`_ Upgrade pytest, and fix caplog unit tests
**Improved Documentation**
* `#1516 <https://github.com/sanic-org/sanic/pull/1516>`_ Fix typo at the exception documentation
* `#1510 <https://github.com/sanic-org/sanic/pull/1510>`_ fix typo in Asyncio example
* `#1486 <https://github.com/sanic-org/sanic/pull/1486>`_ Documentation typo
* `#1477 <https://github.com/sanic-org/sanic/pull/1477>`_ Fix grammar in README.md
* `#1489 <https://github.com/sanic-org/sanic/pull/1489>`_ Added "databases" to the extensions list
* `#1483 <https://github.com/sanic-org/sanic/pull/1483>`_ Add sanic-zipkin to extensions list
* `#1487 <https://github.com/sanic-org/sanic/pull/1487>`_ Removed link to deleted repo, Sanic-OAuth, from the extensions list
* `#1460 <https://github.com/sanic-org/sanic/pull/1460>`_ 18.12 changelog
* `#1449 <https://github.com/sanic-org/sanic/pull/1449>`_ Add example of amending request object
* `#1446 <https://github.com/sanic-org/sanic/pull/1446>`_ Update README
* `#1444 <https://github.com/sanic-org/sanic/pull/1444>`_ Update README
* `#1443 <https://github.com/sanic-org/sanic/pull/1443>`_ Update README, including new logo
* `#1440 <https://github.com/sanic-org/sanic/pull/1440>`_ fix minor type and pip install instruction mismatch
* `#1424 <https://github.com/sanic-org/sanic/pull/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 requirement 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 Timeout 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
Reference in New Issue View Git Blame Copy Permalink