diff --git a/CHANGELOG.md b/CHANGELOG.md index a5d3b7f5..0d92c563 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,39 @@ +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 diff --git a/README.rst b/README.rst index aafcdec7..3bd3a91e 100644 --- a/README.rst +++ b/README.rst @@ -111,6 +111,11 @@ Documentation `Documentation on Readthedocs `_. +Changelog +--------- + +`Release Changelogs `_. + Questions and Discussion ------------------------ diff --git a/docs/index.rst b/docs/index.rst index dd4801c6..4123d32c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,9 +29,10 @@ Guides sanic/testing sanic/deploying sanic/extensions + sanic/examples + sanic/changelog sanic/contributing sanic/api_reference - sanic/examples Module Documentation diff --git a/docs/sanic/changelog.md b/docs/sanic/changelog.md new file mode 100644 index 00000000..0d92c563 --- /dev/null +++ b/docs/sanic/changelog.md @@ -0,0 +1,135 @@ +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 'huge-success' + +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