From 32eb8abb635dba15deb4553cd7149c9b3d024730 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Sat, 13 Jul 2019 12:52:41 +0530 Subject: [PATCH 01/10] fix: #1631: add towncrier support and fix documentation warnings Signed-off-by: Harsha Narayana --- CHANGELOG.md | 288 --------------------------- CHANGELOG.rst | 375 ++++++++++++++++++++++++++++++++++++ Makefile | 14 ++ changelogs/1631.feature.rst | 4 + docs/conf.py | 9 +- docs/sanic/changelog.md | 288 --------------------------- docs/sanic/changelog.rst | 4 + docs/sanic/contributing.rst | 4 + docs/sanic/extensions.md | 4 +- docs/sanic/routing.md | 6 + pyproject.toml | 33 ++++ release.py | 13 +- sanic/__init__.py | 4 +- sanic/__version__.py | 1 + sanic/app.py | 24 +-- sanic/blueprint_group.py | 3 +- sanic/request.py | 26 ++- setup.cfg | 4 +- setup.py | 33 +++- 19 files changed, 513 insertions(+), 624 deletions(-) delete mode 100644 CHANGELOG.md create mode 100644 CHANGELOG.rst create mode 100644 changelogs/1631.feature.rst delete mode 100644 docs/sanic/changelog.md create mode 100644 docs/sanic/changelog.rst create mode 100644 pyproject.toml create mode 100644 sanic/__version__.py diff --git a/CHANGELOG.md b/CHANGELOG.md deleted file mode 100644 index dd79154c..00000000 --- a/CHANGELOG.md +++ /dev/null @@ -1,288 +0,0 @@ -Version 19.6 ------------- -19.6.0 - - Changes: - - [#1562](https://github.com/huge-success/sanic/pull/1562) - Remove `aiohttp` dependencey and create new `SanicTestClient` based upon - [`requests-async`](https://github.com/encode/requests-async). - - - [#1475](https://github.com/huge-success/sanic/pull/1475) - Added ASGI support (Beta) - - - [#1436](https://github.com/huge-success/sanic/pull/1436) - Add Configure support from object string - - - [#1544](https://github.com/huge-success/sanic/pull/1544) - Drop dependency on distutil - - - Fixes: - - [#1587](https://github.com/huge-success/sanic/pull/1587) - Add missing handle for Expect header. - - - [#1560](https://github.com/huge-success/sanic/pull/1560) - Allow to disable Transfer-Encoding: chunked. - - - [#1558](https://github.com/huge-success/sanic/pull/1558) - Fix graceful shutdown. - - - [#1594](https://github.com/huge-success/sanic/pull/1594) - Strict Slashes behavior fix - - - Deprecation: - - [#1562](https://github.com/huge-success/sanic/pull/1562) - Drop support for Python 3.5 - - - [#1568](https://github.com/huge-success/sanic/pull/1568) - Deprecate route removal. - -Note: 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 -------------- -19.3.1 - - Changes: - - [#1497](https://github.com/huge-success/sanic/pull/1497) - Add support for zero-length and RFC 5987 encoded filename for - multipart/form-data requests. - - - [#1484](https://github.com/huge-success/sanic/pull/1484) - The type of `expires` attribute of `sanic.cookies.Cookie` is now - enforced to be of type `datetime`. - - - [#1482](https://github.com/huge-success/sanic/pull/1482) - Add support for the `stream` parameter of `sanic.Sanic.add_route()` - available to `sanic.Blueprint.add_route()`. - - - [#1481](https://github.com/huge-success/sanic/pull/1481) - Accept negative values for route parameters with type `int` or `number`. - - - [#1476](https://github.com/huge-success/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/huge-success/sanic/pull/1472) - Remove an unwanted `None` check in Request class `repr` implementation. - This changes the default `repr` of a Request from `` to - `` - - - [#1470](https://github.com/huge-success/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/huge-success/sanic/pull/1499) - Added a set of test cases that test and benchmark route resolution. - - - [#1457](https://github.com/huge-success/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/huge-success/sanic/pull/1445) - Added the `endpoint` attribute to an incoming `request`, containing the - name of the handler function. - - - [#1423](https://github.com/huge-success/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. - - - Fixes: - - [#1502](https://github.com/huge-success/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/huge-success/sanic/pull/1500) - - - [#1501](https://github.com/huge-success/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/huge-success/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/huge-success/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/huge-success/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/huge-success/sanic/pull/1529) Update project PyPI credentials - - [#1515](https://github.com/huge-success/sanic/pull/1515) fix linter issue causing travis build failures (fix #1514) - - [#1490](https://github.com/huge-success/sanic/pull/1490) Fix python version in doc build - - [#1478](https://github.com/huge-success/sanic/pull/1478) Upgrade setuptools version and use native docutils in doc build - - [#1464](https://github.com/huge-success/sanic/pull/1464) Upgrade pytest, and fix caplog unit tests - - - Typos and Documentation: - - [#1516](https://github.com/huge-success/sanic/pull/1516) Fix typo at the exception documentation - - [#1510](https://github.com/huge-success/sanic/pull/1510) fix typo in Asyncio example - - [#1486](https://github.com/huge-success/sanic/pull/1486) Documentation typo - - [#1477](https://github.com/huge-success/sanic/pull/1477) Fix grammar in README.md - - [#1489](https://github.com/huge-success/sanic/pull/1489) Added "databases" to the extensions list - - [#1483](https://github.com/huge-success/sanic/pull/1483) Add sanic-zipkin to extensions list - - [#1487](https://github.com/huge-success/sanic/pull/1487) Removed link to deleted repo, Sanic-OAuth, from the extensions list - - [#1460](https://github.com/huge-success/sanic/pull/1460) 18.12 changelog - - [#1449](https://github.com/huge-success/sanic/pull/1449) Add example of amending request object - - [#1446](https://github.com/huge-success/sanic/pull/1446) Update README - - [#1444](https://github.com/huge-success/sanic/pull/1444) Update README - - [#1443](https://github.com/huge-success/sanic/pull/1443) Update README, including new logo - - [#1440](https://github.com/huge-success/sanic/pull/1440) fix minor type and pip install instruction mismatch - - [#1424](https://github.com/huge-success/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 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 diff --git a/CHANGELOG.rst b/CHANGELOG.rst new file mode 100644 index 00000000..4c3a6e86 --- /dev/null +++ b/CHANGELOG.rst @@ -0,0 +1,375 @@ +Version 19.6.2 +============== + +Features +******** + + * + `#1562 `_ + Remove ``aiohttp`` dependencey 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 ```` to + ```` + + * + `#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 '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 diff --git a/Makefile b/Makefile index a95326b2..3c0cb975 100644 --- a/Makefile +++ b/Makefile @@ -19,6 +19,13 @@ help: @echo "beautify [sort_imports=1] [include_tests=1]" @echo " Analyze and fix linting issue using black and optionally fix import sort using isort" @echo "" + @echo "docs" + @echo " Generate Sanic documentation" + @echo "" + @echo "clean-docs" + @echo " Clean Sanic documentation" + @echo "" + clean: find . ! -path "./.eggs/*" -name "*.pyc" -exec rm {} \; @@ -56,3 +63,10 @@ black: fix-import: black isort -rc sanic tests + + +docs-clean: + cd docs && make clean + +docs: docs-clean + cd docs && make html diff --git a/changelogs/1631.feature.rst b/changelogs/1631.feature.rst new file mode 100644 index 00000000..1379564c --- /dev/null +++ b/changelogs/1631.feature.rst @@ -0,0 +1,4 @@ +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. \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 7b70215d..d83c7288 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -10,10 +10,8 @@ import os import sys -# Add support for Markdown documentation using Recommonmark -from recommonmark.parser import CommonMarkParser - # Add support for auto-doc +import recommonmark from recommonmark.transform import AutoStructify # Ensure that sanic is present in the path, to allow sphinx-apidoc to @@ -25,12 +23,11 @@ import sanic # -- General configuration ------------------------------------------------ -extensions = ['sphinx.ext.autodoc', 'sphinxcontrib.asyncio'] +extensions = ['sphinx.ext.autodoc', "recommonmark"] templates_path = ['_templates'] # Enable support for both Restructured Text and Markdown -source_parsers = {'.md': CommonMarkParser} source_suffix = ['.rst', '.md'] # The master toctree document. @@ -149,6 +146,6 @@ suppress_warnings = ['image.nonlocal_uri'] def setup(app): app.add_config_value('recommonmark_config', { 'enable_eval_rst': True, - 'enable_auto_doc_ref': True, + 'enable_auto_doc_ref': False, }, True) app.add_transform(AutoStructify) diff --git a/docs/sanic/changelog.md b/docs/sanic/changelog.md deleted file mode 100644 index 025cc89f..00000000 --- a/docs/sanic/changelog.md +++ /dev/null @@ -1,288 +0,0 @@ -# Changelog - -## Version 19.6 - - - Changes: - - [#1562](https://github.com/huge-success/sanic/pull/1562) - Remove `aiohttp` dependencey and create new `SanicTestClient` based upon - [`requests-async`](https://github.com/encode/requests-async). - - - [#1475](https://github.com/huge-success/sanic/pull/1475) - Added ASGI support (Beta) - - - [#1436](https://github.com/huge-success/sanic/pull/1436) - Add Configure support from object string - - - [#1544](https://github.com/huge-success/sanic/pull/1544) - Drop dependency on distutil - - - Fixes: - - [#1587](https://github.com/huge-success/sanic/pull/1587) - Add missing handle for Expect header. - - - [#1560](https://github.com/huge-success/sanic/pull/1560) - Allow to disable Transfer-Encoding: chunked. - - - [#1558](https://github.com/huge-success/sanic/pull/1558) - Fix graceful shutdown. - - - [#1594](https://github.com/huge-success/sanic/pull/1594) - Strict Slashes behavior fix - - - Deprecation: - - [#1562](https://github.com/huge-success/sanic/pull/1562) - Drop support for Python 3.5 - - - [#1568](https://github.com/huge-success/sanic/pull/1568) - Deprecate route removal. - -Note: 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 - - - Changes: - - [#1497](https://github.com/huge-success/sanic/pull/1497) - Add support for zero-length and RFC 5987 encoded filename for - multipart/form-data requests. - - - [#1484](https://github.com/huge-success/sanic/pull/1484) - The type of `expires` attribute of `sanic.cookies.Cookie` is now - enforced to be of type `datetime`. - - - [#1482](https://github.com/huge-success/sanic/pull/1482) - Add support for the `stream` parameter of `sanic.Sanic.add_route()` - available to `sanic.Blueprint.add_route()`. - - - [#1481](https://github.com/huge-success/sanic/pull/1481) - Accept negative values for route parameters with type `int` or `number`. - - - [#1476](https://github.com/huge-success/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/huge-success/sanic/pull/1472) - Remove an unwanted `None` check in Request class `repr` implementation. - This changes the default `repr` of a Request from `` to - `` - - - [#1470](https://github.com/huge-success/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/huge-success/sanic/pull/1499) - Added a set of test cases that test and benchmark route resolution. - - - [#1457](https://github.com/huge-success/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/huge-success/sanic/pull/1445) - Added the `endpoint` attribute to an incoming `request`, containing the - name of the handler function. - - - [#1423](https://github.com/huge-success/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. - - - Fixes: - - [#1502](https://github.com/huge-success/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/huge-success/sanic/pull/1500) - - - [#1501](https://github.com/huge-success/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/huge-success/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/huge-success/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/huge-success/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/huge-success/sanic/pull/1529) Update project PyPI credentials - - [#1515](https://github.com/huge-success/sanic/pull/1515) fix linter issue causing travis build failures (fix #1514) - - [#1490](https://github.com/huge-success/sanic/pull/1490) Fix python version in doc build - - [#1478](https://github.com/huge-success/sanic/pull/1478) Upgrade setuptools version and use native docutils in doc build - - [#1464](https://github.com/huge-success/sanic/pull/1464) Upgrade pytest, and fix caplog unit tests - - - Typos and Documentation: - - [#1516](https://github.com/huge-success/sanic/pull/1516) Fix typo at the exception documentation - - [#1510](https://github.com/huge-success/sanic/pull/1510) fix typo in Asyncio example - - [#1486](https://github.com/huge-success/sanic/pull/1486) Documentation typo - - [#1477](https://github.com/huge-success/sanic/pull/1477) Fix grammar in README.md - - [#1489](https://github.com/huge-success/sanic/pull/1489) Added "databases" to the extensions list - - [#1483](https://github.com/huge-success/sanic/pull/1483) Add sanic-zipkin to extensions list - - [#1487](https://github.com/huge-success/sanic/pull/1487) Removed link to deleted repo, Sanic-OAuth, from the extensions list - - [#1460](https://github.com/huge-success/sanic/pull/1460) 18.12 changelog - - [#1449](https://github.com/huge-success/sanic/pull/1449) Add example of amending request object - - [#1446](https://github.com/huge-success/sanic/pull/1446) Update README - - [#1444](https://github.com/huge-success/sanic/pull/1444) Update README - - [#1443](https://github.com/huge-success/sanic/pull/1443) Update README, including new logo - - [#1440](https://github.com/huge-success/sanic/pull/1440) fix minor type and pip install instruction mismatch - - [#1424](https://github.com/huge-success/sanic/pull/1424) Documentation Enhancements - -Note: 19.3.0 was skipped for packagement purposes and not released on PyPI - -## Version 18.12 - - - 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 diff --git a/docs/sanic/changelog.rst b/docs/sanic/changelog.rst new file mode 100644 index 00000000..c643e67b --- /dev/null +++ b/docs/sanic/changelog.rst @@ -0,0 +1,4 @@ +Changelog +--------- + +.. include:: ../../CHANGELOG.rst \ No newline at end of file diff --git a/docs/sanic/contributing.rst b/docs/sanic/contributing.rst index ce4278eb..a7001b5c 100644 --- a/docs/sanic/contributing.rst +++ b/docs/sanic/contributing.rst @@ -40,6 +40,10 @@ the document that explains the way ``sanic`` manages dependencies inside the ``s | extras_require['docs'] | Dependencies required to enable building and | ``pip3 install -e '.[docs]'`` | | | enhancing sanic documentation | | +------------------------+-----------------------------------------------+--------------------------------+ +| extras_require['all'] | Dependencies required to perform all sanic | ``pip3 install -e '.[docs]'`` | +| | development activities including documenting | | ++------------------------+-----------------------------------------------+--------------------------------+ + Running tests ------------- diff --git a/docs/sanic/extensions.md b/docs/sanic/extensions.md index 157ee7cb..b13201af 100644 --- a/docs/sanic/extensions.md +++ b/docs/sanic/extensions.md @@ -1 +1,3 @@ -Moved to the [`awesome-sanic`](https://github.com/mekicha/awesome-sanic) list. \ No newline at end of file +# Extensions + +Moved to the [awesome-sanic](https://github.com/mekicha/awesome-sanic) list. \ No newline at end of file diff --git a/docs/sanic/routing.md b/docs/sanic/routing.md index 24b01544..c1477aab 100644 --- a/docs/sanic/routing.md +++ b/docs/sanic/routing.md @@ -203,16 +203,21 @@ async def post_handler(request, post_id): Other things to keep in mind when using `url_for`: - Keyword arguments passed to `url_for` that are not request parameters will be included in the URL's query string. For example: + ```python url = app.url_for('post_handler', post_id=5, arg_one='one', arg_two='two') # /posts/5?arg_one=one&arg_two=two ``` + - Multivalue argument can be passed to `url_for`. For example: + ```python url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two']) # /posts/5?arg_one=one&arg_one=two ``` + - Also some special arguments (`_anchor`, `_external`, `_scheme`, `_method`, `_server`) passed to `url_for` will have special url building (`_method` is not supported now and will be ignored). For example: + ```python url = app.url_for('post_handler', post_id=5, arg_one='one', _anchor='anchor') # /posts/5?arg_one=one#anchor @@ -229,6 +234,7 @@ url = app.url_for('post_handler', post_id=5, arg_one='one', _scheme='http', _ext url = app.url_for('post_handler', post_id=5, arg_one=['one', 'two'], arg_two=2, _anchor='anchor', _scheme='http', _external=True, _server='another_server:8888') # http://another_server:8888/posts/5?arg_one=one&arg_one=two&arg_two=2#anchor ``` + - All valid parameters must be passed to `url_for` to build a URL. If a parameter is not supplied, or if a parameter does not match the specified type, a `URLBuildError` will be raised. ## WebSocket routes diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..16cb395b --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,33 @@ +[tool.towncrier] + package = "sanic" + package_dir = "." + filename = "CHANGELOG.rst" + directory = "./changelogs" + underlines = ["=", "*", "~"] + issue_format = "`#{issue} `__" + title_format = "Version {version}" + +[[tool.towncrier.type]] + directory = "feature" + name = "Features" + showcontent = true + +[[tool.towncrier.type]] + directory = "bugfix" + name = "Bugfixes" + showcontent = true + +[[tool.towncrier.type]] + directory = "doc" + name = "Improved Documentation" + showcontent = true + +[[tool.towncrier.type]] + directory = "removal" + name = "Deprecations and Removals" + showcontent = true + +[[tool.towncrier.type]] + directory = "misc" + name = "Miscellaneous internal changes" + showcontent = true diff --git a/release.py b/release.py index e24bac80..b74462de 100755 --- a/release.py +++ b/release.py @@ -125,7 +125,7 @@ def _update_release_version_for_sanic( config_parser.read_file(cfg) config_parser.set("version", "current_version", new_version) - version_file = config_parser.get("version", "file") + version_files = config_parser.get("version", "files") current_version_line = config_parser.get( "version", "current_version_pattern" ).format(current_version=current_version) @@ -133,12 +133,13 @@ def _update_release_version_for_sanic( "version", "new_version_pattern" ).format(new_version=new_version) - with open(version_file) as init_file: - data = init_file.read() + for version_file in version_files.split(","): + with open(version_file) as init_file: + data = init_file.read() - new_data = data.replace(current_version_line, new_version_line) - with open(version_file, "w") as init_file: - init_file.write(new_data) + new_data = data.replace(current_version_line, new_version_line) + with open(version_file, "w") as init_file: + init_file.write(new_data) with open(config_file, "w") as config: config_parser.write(config) diff --git a/sanic/__init__.py b/sanic/__init__.py index 82cb6a9e..448fc0fb 100644 --- a/sanic/__init__.py +++ b/sanic/__init__.py @@ -1,7 +1,5 @@ from sanic.app import Sanic from sanic.blueprints import Blueprint - - -__version__ = "19.6.2" +from sanic.__version__ import __version__ __all__ = ["Sanic", "Blueprint"] diff --git a/sanic/__version__.py b/sanic/__version__.py new file mode 100644 index 00000000..34be575c --- /dev/null +++ b/sanic/__version__.py @@ -0,0 +1 @@ +__version__ = "19.6.2" diff --git a/sanic/app.py b/sanic/app.py index 9a8db299..343ef0cf 100644 --- a/sanic/app.py +++ b/sanic/app.py @@ -441,14 +441,16 @@ class Sanic: def websocket( self, uri, host=None, strict_slashes=None, subprotocols=None, name=None ): - """Decorate a function to be registered as a websocket route + """ + Decorate a function to be registered as a websocket route + :param uri: path of the URL :param host: Host IP or FQDN details :param strict_slashes: If the API endpoint needs to terminate - with a "/" or not + with a "/" or not :param subprotocols: optional list of str with supported subprotocols :param name: A unique name assigned to the URL so that it can - be used with :func:`url_for` + be used with :func:`url_for` :return: decorated function """ self.enable_websocket() @@ -1049,8 +1051,8 @@ class Sanic: :param debug: Enables debug output (slows server) :type debug: bool :param ssl: SSLContext, or location of certificate and key - for SSL encryption of worker(s) - :type ssl:SSLContext or dict + for SSL encryption of worker(s) + :type ssl: SSLContext or dict :param sock: Socket for the server to accept connections from :type sock: socket :param workers: Number of processes received before it is respected @@ -1058,10 +1060,10 @@ class Sanic: :param protocol: Subclass of asyncio Protocol class :type protocol: type[Protocol] :param backlog: a number of unaccepted connections that the system - will allow before refusing new connections + will allow before refusing new connections :type backlog: int :param stop_event: event to be triggered - before stopping the app - deprecated + before stopping the app - deprecated :type stop_event: None :param register_sys_signals: Register SIG* events :type register_sys_signals: bool @@ -1178,17 +1180,17 @@ class Sanic: :param debug: Enables debug output (slows server) :type debug: bool :param ssl: SSLContext, or location of certificate and key - for SSL encryption of worker(s) - :type ssl:SSLContext or dict + for SSL encryption of worker(s) + :type ssl: SSLContext or dict :param sock: Socket for the server to accept connections from :type sock: socket :param protocol: Subclass of asyncio Protocol class :type protocol: type[Protocol] :param backlog: a number of unaccepted connections that the system - will allow before refusing new connections + will allow before refusing new connections :type backlog: int :param stop_event: event to be triggered - before stopping the app - deprecated + before stopping the app - deprecated :type stop_event: None :param access_log: Enables writing access logs (slows server) :type access_log: bool diff --git a/sanic/blueprint_group.py b/sanic/blueprint_group.py index 45453b95..3850cd20 100644 --- a/sanic/blueprint_group.py +++ b/sanic/blueprint_group.py @@ -4,7 +4,8 @@ from collections.abc import MutableSequence class BlueprintGroup(MutableSequence): """ This class provides a mechanism to implement a Blueprint Group - using the `Blueprint.group` method. To avoid having to re-write + using the :meth:`~sanic.blueprints.Blueprint.group` method in + :class:`~sanic.blueprints.Blueprint`. To avoid having to re-write some of the existing implementation, this class provides a custom iterator implementation that will let you use the object of this class as a list/tuple inside the existing implementation. diff --git a/sanic/request.py b/sanic/request.py index 9c87efd6..2fd748bc 100644 --- a/sanic/request.py +++ b/sanic/request.py @@ -212,20 +212,25 @@ class Request(dict): Method to parse `query_string` using `urllib.parse.parse_qs`. This methods is used by `args` property. Can be used directly if you need to change default parameters. - :param keep_blank_values: flag indicating whether blank values in + + :param keep_blank_values: + flag indicating whether blank values in percent-encoded queries should be treated as blank strings. A true value indicates that blanks should be retained as blank strings. The default false value indicates that blank values are to be ignored and treated as if they were not included. :type keep_blank_values: bool - :param strict_parsing: flag indicating what to do with parsing errors. + :param strict_parsing: + flag indicating what to do with parsing errors. If false (the default), errors are silently ignored. If true, errors raise a ValueError exception. :type strict_parsing: bool - :param encoding: specify how to decode percent-encoded sequences + :param encoding: + specify how to decode percent-encoded sequences into Unicode characters, as accepted by the bytes.decode() method. :type encoding: str - :param errors: specify how to decode percent-encoded sequences + :param errors: + specify how to decode percent-encoded sequences into Unicode characters, as accepted by the bytes.decode() method. :type errors: str :return: RequestParameters @@ -275,20 +280,25 @@ class Request(dict): Method to parse `query_string` using `urllib.parse.parse_qsl`. This methods is used by `query_args` property. Can be used directly if you need to change default parameters. - :param keep_blank_values: flag indicating whether blank values in + + :param keep_blank_values: + flag indicating whether blank values in percent-encoded queries should be treated as blank strings. A true value indicates that blanks should be retained as blank strings. The default false value indicates that blank values are to be ignored and treated as if they were not included. :type keep_blank_values: bool - :param strict_parsing: flag indicating what to do with parsing errors. + :param strict_parsing: + flag indicating what to do with parsing errors. If false (the default), errors are silently ignored. If true, errors raise a ValueError exception. :type strict_parsing: bool - :param encoding: specify how to decode percent-encoded sequences + :param encoding: + specify how to decode percent-encoded sequences into Unicode characters, as accepted by the bytes.decode() method. :type encoding: str - :param errors: specify how to decode percent-encoded sequences + :param errors: + specify how to decode percent-encoded sequences into Unicode characters, as accepted by the bytes.decode() method. :type errors: str :return: list diff --git a/setup.cfg b/setup.cfg index ae329e77..dc9b656d 100644 --- a/setup.cfg +++ b/setup.cfg @@ -14,7 +14,7 @@ multi_line_output = 3 not_skip = __init__.py [version] -current_version = 19.3.1 -file = sanic/__init__.py +current_version = 19.6.2 +files = sanic/__version__.py current_version_pattern = __version__ = "{current_version}" new_version_pattern = __version__ = "{new_version}" diff --git a/setup.py b/setup.py index 751f1549..3f23e4f6 100644 --- a/setup.py +++ b/setup.py @@ -36,7 +36,7 @@ def open_local(paths, mode="r", encoding="utf8"): return codecs.open(path, mode, encoding) -with open_local(["sanic", "__init__.py"], encoding="latin1") as fp: +with open_local(["sanic", "__version__.py"], encoding="latin1") as fp: try: version = re.findall( r"^__version__ = \"([^']+)\"\r?$", fp.read(), re.M @@ -99,6 +99,25 @@ tests_require = [ "pytest-benchmark", ] +docs_require = [ + "sphinx>=2.1.2", + "sphinx_rtd_theme", + "recommonmark>=0.5.0", + "docutils", + "pygments", +] + +dev_require = tests_require + [ + "aiofiles", + "tox", + "black", + "flake8", + "bandit", + "towncrier", +] + +all_require = dev_require + docs_require + if strtobool(os.environ.get("SANIC_NO_UJSON", "no")): print("Installing without uJSON") requirements.remove(ujson) @@ -112,15 +131,9 @@ if strtobool(os.environ.get("SANIC_NO_UVLOOP", "no")): extras_require = { "test": tests_require, - "dev": tests_require + ["aiofiles", "tox", "black", "flake8", "bandit"], - "docs": [ - "sphinx", - "sphinx_rtd_theme", - "recommonmark", - "sphinxcontrib-asyncio", - "docutils", - "pygments", - ], + "dev": dev_require, + "docs": docs_require, + "all": all_require, } setup_kwargs["install_requires"] = requirements From 4e50295bf003249c22ce36151932f5d56dc68290 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Sat, 13 Jul 2019 13:00:37 +0530 Subject: [PATCH 02/10] fix: #1631: add tox test support for documentation Signed-off-by: Harsha Narayana --- Makefile | 6 ++++++ tox.ini | 13 ++++++++++++- 2 files changed, 18 insertions(+), 1 deletion(-) diff --git a/Makefile b/Makefile index 3c0cb975..72e86aab 100644 --- a/Makefile +++ b/Makefile @@ -25,6 +25,9 @@ help: @echo "clean-docs" @echo " Clean Sanic documentation" @echo "" + @echo "docs-test" + @echo " Test Sanic Documentation for errors" + @echo "" clean: @@ -70,3 +73,6 @@ docs-clean: docs: docs-clean cd docs && make html + +docs-test: docs-clean + cd docs && make dummy diff --git a/tox.ini b/tox.ini index 3ff30ef8..daaeb7e6 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py36, py37, {py36,py37}-no-ext, lint, check, security +envlist = py36, py37, {py36,py37}-no-ext, lint, check, security, docs [testenv] usedevelop = True @@ -55,3 +55,14 @@ deps = commands = bandit --recursive sanic --skip B404,B101 --exclude sanic/reloader_helpers.py + +[testenv:docs] +deps = + sphinx>=2.1.2 + sphinx_rtd_theme>=0.4.3 + recommonmark>=0.5.0 + docutils + pygments + +commands = + make docs-test From b3ada6308bc992fd233929e93d58c6af478313e4 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Sat, 13 Jul 2019 13:20:13 +0530 Subject: [PATCH 03/10] fix: #1631: add doc test for travis CI Signed-off-by: Harsha Narayana --- .travis.yml | 12 ++++++++++++ tox.ini | 3 +++ 2 files changed, 15 insertions(+) diff --git a/.travis.yml b/.travis.yml index 8eff34cc..d304c701 100644 --- a/.travis.yml +++ b/.travis.yml @@ -7,24 +7,36 @@ matrix: include: - env: TOX_ENV=py36 python: 3.6 + name: "Python 3.6 with Extensions" - env: TOX_ENV=py36-no-ext python: 3.6 + name: "Python 3.6 without Extensions" - env: TOX_ENV=py37 python: 3.7 dist: xenial sudo: true + name: "Python 3.7 with Extensions" - env: TOX_ENV=py37-no-ext python: 3.7 dist: xenial sudo: true + name: "Python 3.7 without Extensions" - env: TOX_ENV=lint python: 3.6 + name: "Python 3.6 Linter checks" - env: TOX_ENV=check python: 3.6 + name: "Python 3.6 Package checks" - env: TOX_ENV=security python: 3.7 dist: xenial sudo: true + name: "Python 3.7 Bandit security scan" + - env: TOX_ENV=docs + python: 3.7 + dist: xenial + sudo: true + name: "Python 3.7 Documentation tests" install: - pip install -U tox - pip install codecov diff --git a/tox.ini b/tox.ini index daaeb7e6..d13dc67c 100644 --- a/tox.ini +++ b/tox.ini @@ -57,12 +57,15 @@ commands = bandit --recursive sanic --skip B404,B101 --exclude sanic/reloader_helpers.py [testenv:docs] +platform = linux2|darwin +whitelist_externals = make deps = sphinx>=2.1.2 sphinx_rtd_theme>=0.4.3 recommonmark>=0.5.0 docutils pygments + gunicorn commands = make docs-test From a019ff61e371b1775c25a86f9b8d3901756a1f46 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Sat, 13 Jul 2019 13:29:17 +0530 Subject: [PATCH 04/10] fix: #1631: linter fix and tox platform selector Signed-off-by: Harsha Narayana --- sanic/__init__.py | 5 +++-- tox.ini | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/sanic/__init__.py b/sanic/__init__.py index 448fc0fb..5fcb0fe8 100644 --- a/sanic/__init__.py +++ b/sanic/__init__.py @@ -1,5 +1,6 @@ +from sanic.__version__ import __version__ from sanic.app import Sanic from sanic.blueprints import Blueprint -from sanic.__version__ import __version__ -__all__ = ["Sanic", "Blueprint"] + +__all__ = ["Sanic", "Blueprint", "__version__"] diff --git a/tox.ini b/tox.ini index d13dc67c..5ae5b5b5 100644 --- a/tox.ini +++ b/tox.ini @@ -57,7 +57,7 @@ commands = bandit --recursive sanic --skip B404,B101 --exclude sanic/reloader_helpers.py [testenv:docs] -platform = linux2|darwin +platform = linux|linux2|darwin whitelist_externals = make deps = sphinx>=2.1.2 From 83864f890a67a1a9a00c15916c537fca577bf980 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Sat, 13 Jul 2019 14:10:41 +0530 Subject: [PATCH 05/10] fix: #1631: add common contribution guidelines and towncrier detail to contribution guides Signed-off-by: Harsha Narayana --- CONTRIBUTING.md | 141 -------------------- CONTRIBUTING.rst | 252 ++++++++++++++++++++++++++++++++++++ README.rst | 2 +- changelogs/1631.doc.rst | 6 + docs/sanic/contributing.rst | 94 +------------- 5 files changed, 260 insertions(+), 235 deletions(-) delete mode 100644 CONTRIBUTING.md create mode 100644 CONTRIBUTING.rst create mode 100644 changelogs/1631.doc.rst diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 1db3cdd4..00000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,141 +0,0 @@ -# Contributing - -Thank you for your interest! Sanic is always looking for contributors. If you -don't feel comfortable contributing code, adding docstrings to the source files -is very appreciated. - -We are committed to providing a friendly, safe and welcoming environment for all, -regardless of gender, sexual orientation, disability, ethnicity, religion, -or similar personal characteristic. -Our [code of conduct](./CONDUCT.md) sets the standards for behavior. - -## Installation - -To develop on sanic (and mainly to just run the tests) it is highly recommend to -install from sources. - -So assume you have already cloned the repo and are in the working directory with -a virtual environment already set up, then run: - -```bash -pip3 install -e . ".[dev]" -``` - -# Dependency Changes - -`Sanic` doesn't use `requirements*.txt` files to manage any kind of dependencies related to it in order to simplify the -effort required in managing the dependencies. Please make sure you have read and understood the following section of -the document that explains the way `sanic` manages dependencies inside the `setup.py` file. - -| Dependency Type | Usage | Installation | -| ------------------------------------------| -------------------------------------------------------------------------- | --------------------------- | -| requirements | Bare minimum dependencies required for sanic to function | pip3 install -e . | -| tests_require / extras_require['test'] | Dependencies required to run the Unit Tests for `sanic` | pip3 install -e '.[test]' | -| extras_require['dev'] | Additional Development requirements to add contributing | pip3 install -e '.[dev]' | -| extras_require['docs'] | Dependencies required to enable building and enhancing sanic documentation | pip3 install -e '.[docs]' | - -## Running all tests -To run the tests for Sanic it is recommended to use tox like so: - -```bash -tox -``` -See it's that simple! - -`tox.ini` contains different environments. Running `tox` without any arguments will -run all unittests, perform lint and other checks. - -## Run unittests : -`tox` environment -> `[testenv]` - -To execute only unittests, run `tox` with environment like so: - -```bash -tox -e py36 -v -- tests/test_config.py -# or -tox -e py37 -v -- tests/test_config.py -``` - -## Run lint checks : -`tox` environment -> `[testenv:lint]` - -Permform `flake8`, `black` and `isort` checks. -```bash -tox -e lint -``` - -## Run other checks : -`tox` environment -> `[testenv:check]` - -Perform other checks. -```bash -tox -e check -``` - -# Code Style -To maintain the code consistency, Sanic uses following tools. - -1. [isort](https://github.com/timothycrosley/isort) -2. [black](https://github.com/python/black) -2. [flake8](https://github.com/PyCQA/flake8) - - -## isort -`isort` sorts Python imports. It divides imports into three -categories sorted each in alphabetical order. - 1. built-in - 2. third-party - 3. project-specific - -## black -`black` is a Python code formatter. - -## flake8 -`flake8` is a Python style guide that wraps following tools into one. -1. PyFlakes -2. pycodestyle -3. Ned Batchelder's McCabe script - -`isort`, `black` and `flake8` checks are performed during `tox` lint checks. - -Refer [tox](https://tox.readthedocs.io/en/latest/index.html) documentation for more details. - -## Pull requests! - -So the pull request approval rules are pretty simple: -1. All pull requests must pass unit tests. -2. All pull requests must be reviewed and approved by at least - one current collaborator on the project. -3. All pull requests must pass flake8 checks. -4. All pull requests must be consistent with the existing code. -5. If you decide to remove/change anything from any common interface - a deprecation message should accompany it. -6. If you implement a new feature you should have at least one unit - test to accompany it. -7. An example must be one of the following: - * Example of how to use Sanic - * Example of how to use Sanic extensions - * Example of how to use Sanic and asynchronous library - -## Documentation - -Sanic's documentation is built -using [sphinx](http://www.sphinx-doc.org/en/1.5.1/). Guides are written in -Markdown and can be found in the `docs` folder, while the module reference is -automatically generated using `sphinx-apidoc`. - -To generate the documentation from scratch: - -```bash -sphinx-apidoc -fo docs/_api/ sanic -sphinx-build -b html docs docs/_build -``` - -The HTML documentation will be created in the `docs/_build` folder. - -## Warning - -One of the main goals of Sanic is speed. Code that lowers the performance of -Sanic without significant gains in usability, security, or features may not be -merged. Please don't let this intimidate you! If you have any concerns about an -idea, open an issue for discussion and help. diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..5d969477 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,252 @@ + +Contributing +============ + +Thank you for your interest! Sanic is always looking for contributors. If you +don't feel comfortable contributing code, adding docstrings to the source files +is very appreciated. + +We are committed to providing a friendly, safe and welcoming environment for all, +regardless of gender, sexual orientation, disability, ethnicity, religion, +or similar personal characteristic. +Our `code of conduct <./CONDUCT.md>`_ sets the standards for behavior. + +Installation +------------ + +To develop on sanic (and mainly to just run the tests) it is highly recommend to +install from sources. + +So assume you have already cloned the repo and are in the working directory with +a virtual environment already set up, then run: + +.. code-block:: bash + + pip3 install -e . ".[dev]" + +Dependency Changes +------------------ + +``Sanic`` doesn't use ``requirements*.txt`` files to manage any kind of dependencies related to it in order to simplify the +effort required in managing the dependencies. Please make sure you have read and understood the following section of +the document that explains the way ``sanic`` manages dependencies inside the ``setup.py`` file. + +.. list-table:: + :header-rows: 1 + + * - Dependency Type + - Usage + - Installation + * - requirements + - Bare minimum dependencies required for sanic to function + - ``pip3 install -e .`` + * - tests_require / extras_require['test'] + - Dependencies required to run the Unit Tests for ``sanic`` + - ``pip3 install -e '.[test]'`` + * - extras_require['dev'] + - Additional Development requirements to add contributing + - ``pip3 install -e '.[dev]'`` + * - extras_require['docs'] + - Dependencies required to enable building and enhancing sanic documentation + - ``pip3 install -e '.[docs]'`` + + +Running all tests +----------------- + +To run the tests for Sanic it is recommended to use tox like so: + +.. code-block:: bash + + tox + +See it's that simple! + +``tox.ini`` contains different environments. Running ``tox`` without any arguments will +run all unittests, perform lint and other checks. + +Run unittests +------------- + +``tox`` environment -> ``[testenv]` + +To execute only unittests, run ``tox`` with environment like so: + +.. code-block:: bash + + tox -e py36 -v -- tests/test_config.py + # or + tox -e py37 -v -- tests/test_config.py + +Run lint checks +--------------- + +``tox`` environment -> ``[testenv:lint]`` + +Permform ``flake8``\ , ``black`` and ``isort`` checks. + +.. code-block:: bash + + tox -e lint + +Run other checks +---------------- + +``tox`` environment -> ``[testenv:check]`` + +Perform other checks. + +.. code-block:: bash + + tox -e check + +Run Static Analysis +------------------- + +``tox`` environment -> ``[testenv:security]`` + +Perform static analysis security scan + +.. code-block:: bash + + tox -e security + +Run Documentation sanity check +------------------------------ + +``tox`` environment -> ``[testenv:docs]`` + +Perform sanity check on documentation + +.. code-block:: bash + + tox -e docs + + +Code Style +---------- + +To maintain the code consistency, Sanic uses following tools. + + +#. `isort `_ +#. `black `_ +#. `flake8 `_ + +isort +***** + +``isort`` sorts Python imports. It divides imports into three +categories sorted each in alphabetical order. + + +#. built-in +#. third-party +#. project-specific + +black +***** + +``black`` is a Python code formatter. + +flake8 +****** + +``flake8`` is a Python style guide that wraps following tools into one. + + +#. PyFlakes +#. pycodestyle +#. Ned Batchelder's McCabe script + +``isort``\ , ``black`` and ``flake8`` checks are performed during ``tox`` lint checks. + +Refer `tox `_ documentation for more details. + +Pull requests +------------- + +So the pull request approval rules are pretty simple: + +#. All pull requests must have a changelog details associated with it. +#. All pull requests must pass unit tests. +#. All pull requests must be reviewed and approved by at least one current collaborator on the project. +#. All pull requests must pass flake8 checks. +#. All pull requests must be consistent with the existing code. +#. If you decide to remove/change anything from any common interface a deprecation message should accompany it. +#. If you implement a new feature you should have at least one unit test to accompany it. +#. An example must be one of the following: + + * Example of how to use Sanic + * Example of how to use Sanic extensions + * Example of how to use Sanic and asynchronous library + + +Changelog +--------- + +It is mandatory to add documentation for Change log as part of your Pull request when you fix/contribute something +to the ``sanic`` community. This will enable us in generating better and well defined change logs during the +release which can aid community users in a great way. + +.. note:: + + Single line explaining the details of the PR in brief + + Detailed description of what the PR is about and what changes or enhancements are being done. + No need to include examples or any other details here. But it is important that you provide + enough context here to let user understand what this change is all about and why it is being + introduced into the ``sanic`` codebase. + + Make sure you leave an line space after the first line to make sure the document rendering is clean + + +.. list-table:: + :header-rows: 1 + + * - Contribution Type + - Changelog file name format + - Changelog file location + * - Features + - .feature.rst + - ``changelogs`` + * - Bugfixes + - .bugfix.rst + - ``changelogs`` + * - Improved Documentation + - .doc.rst + - ``changelogs`` + * - Deprecations and Removals + - .removal.rst + - ``changelogs`` + * - Miscellaneous internal changes + - .misc.rst + - ``changelogs`` + + +Documentation +------------- + +Sanic's documentation is built +using `sphinx `_. Guides are written in +Markdown and can be found in the ``docs`` folder, while the module reference is +automatically generated using ``sphinx-apidoc``. + +To generate the documentation from scratch: + +.. code-block:: bash + + sphinx-apidoc -fo docs/_api/ sanic + sphinx-build -b html docs docs/_build + + # There is a simple make command provided to ease the work required in generating + # the documentation + make docs + +The HTML documentation will be created in the ``docs/_build`` folder. + +.. warning:: + One of the main goals of Sanic is speed. Code that lowers the performance of + Sanic without significant gains in usability, security, or features may not be + merged. Please don't let this intimidate you! If you have any concerns about an + idea, open an issue for discussion and help. diff --git a/README.rst b/README.rst index c7d22cbc..e3d65138 100644 --- a/README.rst +++ b/README.rst @@ -142,4 +142,4 @@ Questions and Discussion Contribution ------------ -We are always happy to have new contributions. We have `marked issues good for anyone looking to get started `_, and welcome `questions on the forums `_. Please take a look at our `Contribution guidelines `_. +We are always happy to have new contributions. We have `marked issues good for anyone looking to get started `_, and welcome `questions on the forums `_. Please take a look at our `Contribution guidelines `_. diff --git a/changelogs/1631.doc.rst b/changelogs/1631.doc.rst new file mode 100644 index 00000000..03ffaedd --- /dev/null +++ b/changelogs/1631.doc.rst @@ -0,0 +1,6 @@ +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` \ No newline at end of file diff --git a/docs/sanic/contributing.rst b/docs/sanic/contributing.rst index a7001b5c..ac7b6bcf 100644 --- a/docs/sanic/contributing.rst +++ b/docs/sanic/contributing.rst @@ -1,93 +1 @@ -Contributing -============ - -Thank you for your interest! Sanic is always looking for contributors. -If you don’t feel comfortable contributing code, adding docstrings to -the source files is very appreciated. - -Installation ------------- - -To develop on sanic (and mainly to just run the tests) it is highly -recommend to install from sources. - -So assume you have already cloned the repo and are in the working -directory with a virtual environment already set up, then run: - -.. code:: bash - - pip3 install -e '.[dev]' - -Dependency Changes ------------------- - -``Sanic`` doesn't use ``requirements*.txt`` files to manage any kind of dependencies related to it in order to simplify the -effort required in managing the dependencies. Please make sure you have read and understood the following section of -the document that explains the way ``sanic`` manages dependencies inside the ``setup.py`` file. - -+------------------------+-----------------------------------------------+--------------------------------+ -| Dependency Type | Usage | Installation | -+========================+===============================================+================================+ -| requirements | Bare minimum dependencies required for sanic | ``pip3 install -e .`` | -| | to function | | -+------------------------+-----------------------------------------------+--------------------------------+ -| tests_require / | Dependencies required to run the Unit Tests | ``pip3 install -e '.[test]'`` | -| extras_require['test'] | for ``sanic`` | | -+------------------------+-----------------------------------------------+--------------------------------+ -| extras_require['dev'] | Additional Development requirements to add | ``pip3 install -e '.[dev]'`` | -| | for contributing | | -+------------------------+-----------------------------------------------+--------------------------------+ -| extras_require['docs'] | Dependencies required to enable building and | ``pip3 install -e '.[docs]'`` | -| | enhancing sanic documentation | | -+------------------------+-----------------------------------------------+--------------------------------+ -| extras_require['all'] | Dependencies required to perform all sanic | ``pip3 install -e '.[docs]'`` | -| | development activities including documenting | | -+------------------------+-----------------------------------------------+--------------------------------+ - - -Running tests -------------- - -To run the tests for sanic it is recommended to use tox like so: - -.. code:: bash - - tox - -See it’s that simple! - -Pull requests! --------------- - -So the pull request approval rules are pretty simple: - -* All pull requests must pass unit tests -* All pull requests must be reviewed and approved by at least one current collaborator on the project -* All pull requests must pass flake8 checks -* If you decide to remove/change anything from any common interface a deprecation message should accompany it. -* If you implement a new feature you should have at least one unit test to accompany it. - -Documentation -------------- - -Sanic’s documentation is built using `sphinx`_. Guides are written in -Markdown and can be found in the ``docs`` folder, while the module -reference is automatically generated using ``sphinx-apidoc``. - -To generate the documentation from scratch: - -.. code:: bash - - sphinx-apidoc -fo docs/_api/ sanic - sphinx-build -b html docs docs/_build - -The HTML documentation will be created in the ``docs/_build`` folder. - -.. warning:: - One of the main goals of Sanic is speed. Code that lowers the - performance of Sanic without significant gains in usability, security, - or features may not be merged. Please don’t let this intimidate you! If - you have any concerns about an idea, open an issue for discussion and - help. - -.. _sphinx: http://www.sphinx-doc.org/en/1.5.1/ \ No newline at end of file +.. include:: ../../CONTRIBUTING.rst From 95a0b2db2cad38fec726270bbaf8afb9c08682d5 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Sun, 14 Jul 2019 14:17:38 +0530 Subject: [PATCH 06/10] fix: #1631: move pyproject.toml to avoid PEP 517 conflict --- scripts/changelog.py | 42 ++++++++++++++++++++++++ pyproject.toml => scripts/pyproject.toml | 2 +- release.py => scripts/release.py | 17 ++++++++-- 3 files changed, 58 insertions(+), 3 deletions(-) create mode 100755 scripts/changelog.py rename pyproject.toml => scripts/pyproject.toml (95%) rename release.py => scripts/release.py (96%) diff --git a/scripts/changelog.py b/scripts/changelog.py new file mode 100755 index 00000000..1dc3567c --- /dev/null +++ b/scripts/changelog.py @@ -0,0 +1,42 @@ +#!/usr/bin/env python + +from os import path + +if __name__ == "__main__": + try: + import towncrier + import click + except ImportError: + print("Please make sure you have a installed towncrier and click before using this tool") + exit(1) + + @click.command() + @click.option( + "--draft", + "draft", + default=False, + flag_value=True, + help="Render the news fragments, don't write to files, " "don't check versions.", + ) + @click.option("--dir", "directory", default=path.dirname(path.abspath(__file__))) + @click.option("--name", "project_name", default=None) + @click.option( + "--version", + "project_version", + default=None, + help="Render the news fragments using given version.", + ) + @click.option("--date", "project_date", default=None) + @click.option( + "--yes", + "answer_yes", + default=False, + flag_value=True, + help="Do not ask for confirmation to remove news fragments.", + ) + def _main(draft, directory, project_name, project_version, project_date, answer_yes): + return towncrier.__main( + draft, directory, project_name, project_version, project_date, answer_yes + ) + + _main() diff --git a/pyproject.toml b/scripts/pyproject.toml similarity index 95% rename from pyproject.toml rename to scripts/pyproject.toml index 16cb395b..d73fb18f 100644 --- a/pyproject.toml +++ b/scripts/pyproject.toml @@ -1,7 +1,7 @@ [tool.towncrier] package = "sanic" package_dir = "." - filename = "CHANGELOG.rst" + filename = "../CHANGELOG.rst" directory = "./changelogs" underlines = ["=", "*", "~"] issue_format = "`#{issue} `__" diff --git a/release.py b/scripts/release.py similarity index 96% rename from release.py rename to scripts/release.py index b74462de..16693847 100755 --- a/release.py +++ b/scripts/release.py @@ -5,7 +5,7 @@ from collections import OrderedDict from configparser import RawConfigParser from datetime import datetime from json import dumps -from os import path +from os import path, chdir from subprocess import Popen, PIPE from jinja2 import Environment, BaseLoader @@ -56,6 +56,18 @@ RELEASE_NOTE_UPDATE_URL = ( ) +class Directory: + def __init__(self): + self._old_path = path.dirname(path.abspath(__file__)) + self._new_path = path.dirname(self._old_path) + + def __enter__(self): + chdir(self._new_path) + + def __exit__(self, exc_type, exc_val, exc_tb): + chdir(self._old_path) + + def _run_shell_command(command: list): try: process = Popen( @@ -302,4 +314,5 @@ if __name__ == "__main__": required=False, ) args = cli.parse_args() - release(args) + with Directory() as _: + release(args) From 3842eb36fd0faffe9675d0c6d6c195e53e8210e8 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Wed, 24 Jul 2019 04:28:11 +0530 Subject: [PATCH 07/10] fix: #1631: fix pyproject toml indentation Signed-off-by: Harsha Narayana --- scripts/pyproject.toml | 44 +++++++++++++++++++++--------------------- scripts/release.py | 2 +- 2 files changed, 23 insertions(+), 23 deletions(-) diff --git a/scripts/pyproject.toml b/scripts/pyproject.toml index d73fb18f..34acf03f 100644 --- a/scripts/pyproject.toml +++ b/scripts/pyproject.toml @@ -1,33 +1,33 @@ [tool.towncrier] - package = "sanic" - package_dir = "." - filename = "../CHANGELOG.rst" - directory = "./changelogs" - underlines = ["=", "*", "~"] - issue_format = "`#{issue} `__" - title_format = "Version {version}" +package = "sanic" +package_dir = "." +filename = "../CHANGELOG.rst" +directory = "./changelogs" +underlines = ["=", "*", "~"] +issue_format = "`#{issue} `__" +title_format = "Version {version}" [[tool.towncrier.type]] - directory = "feature" - name = "Features" - showcontent = true +directory = "feature" +name = "Features" +showcontent = true [[tool.towncrier.type]] - directory = "bugfix" - name = "Bugfixes" - showcontent = true +directory = "bugfix" +name = "Bugfixes" +showcontent = true [[tool.towncrier.type]] - directory = "doc" - name = "Improved Documentation" - showcontent = true +directory = "doc" +name = "Improved Documentation" +showcontent = true [[tool.towncrier.type]] - directory = "removal" - name = "Deprecations and Removals" - showcontent = true +directory = "removal" +name = "Deprecations and Removals" +showcontent = true [[tool.towncrier.type]] - directory = "misc" - name = "Miscellaneous internal changes" - showcontent = true +directory = "misc" +name = "Miscellaneous internal changes" +showcontent = true diff --git a/scripts/release.py b/scripts/release.py index 16693847..3cc88369 100755 --- a/scripts/release.py +++ b/scripts/release.py @@ -314,5 +314,5 @@ if __name__ == "__main__": required=False, ) args = cli.parse_args() - with Directory() as _: + with Directory(): release(args) From 80b32d0c7132f3c9573a11aa4f9ef223794dde77 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Wed, 24 Jul 2019 05:03:04 +0530 Subject: [PATCH 08/10] feat: #1631: enable make command to support settings up release Signed-off-by: Harsha Narayana --- Makefile | 24 ++++++++++++++++++++---- scripts/changelog.py | 27 ++++++++++++++++++++++----- scripts/release.py | 34 +++++++++++++++++++++++++--------- 3 files changed, 67 insertions(+), 18 deletions(-) diff --git a/Makefile b/Makefile index 72e86aab..5b805e06 100644 --- a/Makefile +++ b/Makefile @@ -13,21 +13,27 @@ help: @echo "docker-test" @echo " Run Sanic Unit Tests using Docker" @echo "black" - @echo " Analyze and fix linting issues using Black" + @echo " Analyze and fix linting issues using Black" @echo "fix-import" @echo " Analyze and fix import order using isort" @echo "beautify [sort_imports=1] [include_tests=1]" - @echo " Analyze and fix linting issue using black and optionally fix import sort using isort" + @echo " Analyze and fix linting issue using black and optionally fix import sort using isort" @echo "" @echo "docs" - @echo " Generate Sanic documentation" + @echo " Generate Sanic documentation" @echo "" @echo "clean-docs" - @echo " Clean Sanic documentation" + @echo " Clean Sanic documentation" @echo "" @echo "docs-test" @echo " Test Sanic Documentation for errors" @echo "" + @echo "changelog" + @echo " Generate changelog for Sanic to prepare for new release" + @echo "" + @echo "release" + @echo " Prepare Sanic for a new changes by version bump and changelog" + @echo "" clean: @@ -76,3 +82,13 @@ docs: docs-clean docs-test: docs-clean cd docs && make dummy + +changelog: + python scripts/changelog.py + +release: changelog +ifdef version + python scripts/release.py --release-version ${version} +else + python scripts/release.py +endif diff --git a/scripts/changelog.py b/scripts/changelog.py index 1dc3567c..a70dbbc7 100755 --- a/scripts/changelog.py +++ b/scripts/changelog.py @@ -7,7 +7,9 @@ if __name__ == "__main__": import towncrier import click except ImportError: - print("Please make sure you have a installed towncrier and click before using this tool") + print( + "Please make sure you have a installed towncrier and click before using this tool" + ) exit(1) @click.command() @@ -16,9 +18,12 @@ if __name__ == "__main__": "draft", default=False, flag_value=True, - help="Render the news fragments, don't write to files, " "don't check versions.", + help="Render the news fragments, don't write to files, " + "don't check versions.", + ) + @click.option( + "--dir", "directory", default=path.dirname(path.abspath(__file__)) ) - @click.option("--dir", "directory", default=path.dirname(path.abspath(__file__))) @click.option("--name", "project_name", default=None) @click.option( "--version", @@ -34,9 +39,21 @@ if __name__ == "__main__": flag_value=True, help="Do not ask for confirmation to remove news fragments.", ) - def _main(draft, directory, project_name, project_version, project_date, answer_yes): + def _main( + draft, + directory, + project_name, + project_version, + project_date, + answer_yes, + ): return towncrier.__main( - draft, directory, project_name, project_version, project_date, answer_yes + draft, + directory, + project_name, + project_version, + project_date, + answer_yes, ) _main() diff --git a/scripts/release.py b/scripts/release.py index 3cc88369..c5144e91 100755 --- a/scripts/release.py +++ b/scripts/release.py @@ -254,13 +254,14 @@ def release(args: Namespace): new_version=new_version, config_file=args.config, ) - _tag_release( - current_version=current_version, - new_version=new_version, - milestone=args.milestone, - release_name=args.release_name, - token=args.token, - ) + if args.tag_release: + _tag_release( + current_version=current_version, + new_version=new_version, + milestone=args.milestone, + release_name=args.release_name, + token=args.token, + ) if __name__ == "__main__": @@ -291,13 +292,13 @@ if __name__ == "__main__": "--token", "-t", help="Git access token with necessary access to Huge Sanic Org", - required=True, + required=False, ) cli.add_argument( "--milestone", "-ms", help="Git Release milestone information to include in relase note", - required=True, + required=False, ) cli.add_argument( "--release-name", @@ -313,6 +314,21 @@ if __name__ == "__main__": action="store_true", required=False, ) + cli.add_argument( + "--tag-release", + help="Tag a new release for Sanic", + default=False, + action="store_true", + required=False, + ) args = cli.parse_args() + if args.tag_release: + for key, value in { + "--token/-t": args.token, + "--milestone/-m": args.milestone, + }.items(): + if not value: + print(f"{key} is mandatory while using --tag-release") + exit(1) with Directory(): release(args) From c1a7e0e3cd61de1f97d205e2ccc128135d908314 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Wed, 24 Jul 2019 05:12:18 +0530 Subject: [PATCH 09/10] feat: #1631: enable change log as part of release script Signed-off-by: Harsha Narayana --- Makefile | 7 ++++--- scripts/release.py | 21 ++++++++++++++++++++- 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/Makefile b/Makefile index 5b805e06..a5af7243 100644 --- a/Makefile +++ b/Makefile @@ -86,9 +86,10 @@ docs-test: docs-clean changelog: python scripts/changelog.py -release: changelog +release: ifdef version - python scripts/release.py --release-version ${version} + python scripts/release.py --release-version ${version} --generate-changelog else - python scripts/release.py + python scripts/release.py --generate-changelog endif + diff --git a/scripts/release.py b/scripts/release.py index c5144e91..fce3f751 100755 --- a/scripts/release.py +++ b/scripts/release.py @@ -10,6 +10,7 @@ from subprocess import Popen, PIPE from jinja2 import Environment, BaseLoader from requests import patch +import towncrier GIT_COMMANDS = { "get_tag": ["git describe --tags --abbrev=0"], @@ -130,7 +131,7 @@ def _get_current_tag(git_command_name="get_tag"): def _update_release_version_for_sanic( - current_version, new_version, config_file + current_version, new_version, config_file, generate_changelog ): config_parser = RawConfigParser() with open(config_file) as cfg: @@ -156,6 +157,16 @@ def _update_release_version_for_sanic( with open(config_file, "w") as config: config_parser.write(config) + if generate_changelog: + towncrier.__main( + draft=False, + directory=path.dirname(path.abspath(__file__)), + project_name=None, + project_version=new_version, + project_date=None, + answer_yes=True, + ) + command = GIT_COMMANDS.get("commit_version_change") command[0] = command[0].format( new_version=new_version, current_version=current_version @@ -253,6 +264,7 @@ def release(args: Namespace): current_version=current_version, new_version=new_version, config_file=args.config, + generate_changelog=args.generate_changelog, ) if args.tag_release: _tag_release( @@ -321,6 +333,13 @@ if __name__ == "__main__": action="store_true", required=False, ) + cli.add_argument( + "--generate-changelog", + help="Generate changelog for Sanic as part of release", + default=False, + action="store_true", + required=False, + ) args = cli.parse_args() if args.tag_release: for key, value in { From 651c98d19ac6d99dfb22c155e78c60feda16dd23 Mon Sep 17 00:00:00 2001 From: Harsha Narayana Date: Wed, 24 Jul 2019 05:39:20 +0530 Subject: [PATCH 10/10] fix: #1631: add ignore file to ensure empty changelog dir is retained Signed-off-by: Harsha Narayana --- changelogs/.gitignore | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 changelogs/.gitignore diff --git a/changelogs/.gitignore b/changelogs/.gitignore new file mode 100644 index 00000000..6427e2a2 --- /dev/null +++ b/changelogs/.gitignore @@ -0,0 +1,2 @@ +# Except this file +!.gitignore \ No newline at end of file