Enhancement: Brotli compression middleware #252

cofin · 2022-07-05T17:08:40Z

Hey all, spent some time with the framework over the past few days, and things look great!

On other Starlette projects, I have used a custom Brotli compression middleware instead of GZIP, and I wanted to propose adding this middleware as an optional installation component.

I've included the base changes required to implement this enhancement, and it would be great to get some feedback and potentially get this integrated as a new feature.

There are two things to note in this branch:

I renamed the Starlite gzip_config to compression_config as it now takes a BrotliConfig or GzipConfig. The correct backend will load based on what config type is passed.
I have created a contrib folder for future "optional extras". I considered adding this into the plugins folder, but decided against that since it exactly a plugin

Goldziher

So, first off - thanks a lot for the contribution. This is high quality work and it's appreciated.

I left several comments that should be addressed.

A few other points that are important -

I would like to consider a way to wrap both brotli and gzip in a single interface. Perhaps the pattern you have there is the simplest, but perhaps we can use a single compression config for both and have some generalization.
I don't like the branching logic when setting the app. I would love to see some splitting there.
I'm not sure about contrib. What's the argument against putting this under the Middleware namespace?

docs/usage/7-middleware.md

pyproject.toml

starlite/contrib/brotli.py

starlite/plugins/sql_alchemy.py

tests/contrib/test_brotli.py

Goldziher

Very good progress. Please finalize the PR and make sure documentation is up to date.

starlite/app.py

starlite/config.py

starlite/middleware/__init__.py

starlite/__init__.py

peterschutt · 2022-07-06T22:30:32Z

@cofin my only comment here beyond what @Goldziher has raised is doc strings on your contributions - we have #132 lined up to go over all the doc strings in the code base so it would be good for new work to have all that done upfront. Google style would be good.

peterschutt · 2022-07-07T01:47:09Z

Would you mind squashing down all the commits once this is ready to merge @cofin?

cofin · 2022-07-07T01:49:29Z

Sure thing. I'll also be sure to take care of the docstrings.

docs/usage/7-middleware.md

starlite/app.py

starlite/middleware/compression/brotli.py

starlite/utils/module_loading.py

starlite/middleware/compression/brotli.py

Goldziher

Ok, stuff looks good. Most of my comments are about code style etc., a couple are more serious.

Please make sure to add doc strings to all functions / methods. And for the components that are supposed to be user facing or could be user facing, make sure to document that API as well (no need to do this for private methods and stuff that is meant to be internal).

Goldziher

Great stuff

- Supports gzip - Optionally use brotli with a gzip fallback.

Goldziher · 2022-07-09T09:21:30Z

@all-contributors add @cofin code docs

allcontributors · 2022-07-09T09:21:38Z

@Goldziher

I've put up a pull request to add @cofin! 🎉

- PyProject addition to cover this vscode error: pydantic/pydantic#1961

…-api-main

* add route map extension * change maturin to dev dependency * rust ext: make Node::is_asgi default to false * rust ext: remove unused dependency * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Move rust extension out of starlite folder * Correct import * Include rust source in sdist build * Working extension poetry build * Rename build.py * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * rust ext: remove some uses of `Python::acquire_gil()` * rust ext: don't return `PyResult` for infallible operations * rust ext: hide plain route methods from python interface * rust ext: add route collection parameter to `add_routes` * rust ext: use `IntoPy` trait method for `Node` instead of `as_pydict` * rust ext: refactor parameters for `configure_route_map_node` * rust ext: remove outdated comment * rust_ext: change uses of `cur` to `cur_node` * rust ext: fix typo in route map comments * rust ext: downgrade add_node_to_route_map return value to shared ref * rust_ext: port build_route_middleware_stack into extension util, removing starlite instance dependence * rust ext: add minimal test * Enhancement: Brotli compression middleware (#252) * FEATURE: Added Compression Middleware - Existing Gzip Middleware - Brotli with an optional Gzip fallback. * 1.5.4 * updated pyproject.toml to exclude lines form coverage report * Add tests for `Starlite.construct_route_map` * Address flake8 validation rules * Removes `uuid4()` from within parametrized test cases. Vscode test discovery caches the test case names including parametrized values. This makes having `uuid4()` calls in the parametrized test cases an issue as vscode shows test case failures when it cannot find test cases that it has previously resolved. As the change doesn't affect the utility of the test, it is better to fix the case for vscode users so we don't get the same issue reported in the future. * Addresses cognitive complexity of `DTOFactory.__call__()` by breaking nested logic out into helper methods. Changes no logic, test cov still 100% and existing tests pass. For #203 * updated dependencies * Issue 187 layered parameters (#261) * feat: added parameters to all app layers * feat: refactored handler layer resolution logic * chore: cleanup signature modelling * feat: add layered parameters to kwargs model * fix test coverage * skipped failing test in py 3.7 * update OA params * updated implementation to use ModelField insteam of FieldInfo * add openapi parameter tests * add docs * 1.6.0 * 1.6.1 * Fix route-map path existence test logic (#275) (#277) * added after_response (#279) * added after_response * addressed review comments * Issue 188: resolve exceptions swallowing args (#281) * updated exception init * add tests * 1.6.2 * chore: updated maintainer list (#285) * docs: add cofin as a contributor for maintenance (#286) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Issue #255: allow single element query param in sequence types (#262) * Array handling in query params * Refactor array handling Co-authored-by: Joseph Daniel <jdn@logpoint.com> * docs: add josepdaniel as a contributor for code (#290) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Updates instructions to install `testing` extra. * LifecycleHook improvements. - Adds `LifecycleHook` for eager evaluation of sync vs async callables and centralisation of handler resolution. Generic on handler response. - Adds aliases `AfterRequestHook`, `AfterResponseHook`, `BeforeRequestHook` that are strongly typed to appropriate handler response type. - Adds support for lifecycle hooks that are instance methods by overwriting handlers assigned to class variables on `Controller` only if they are originally functions. Closes #284 * Enhancement: Tortoise-ORM Plugin (#283) * added tortoise to dev dependencies * added base plugin implementation * add tests * updated plugin implementation * cleanup dependencies * updated implementation * fixed issues * resolved issues * add openapi support * fix tests * updated tests * add docs * fix linter issues * updated tests * 1.7.0 * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity (#292) * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity * Make `openapi.create_paramter_for_handler`'s helper functions public * Revise misleading `openapi.get_recursive_handler_parameters` docstrings * Adds `exceptions.utils.create_exception_response()`. - makes `starlite.exceptions` a sub-package with same api as module it replaces. - adds `starlite.exceptions.utils` module to house the response generation helper function. * Supress warning generated from Tortoise ORM DTO test case. Warning: `RuntimeWarning: coroutine 'TortoiseORMPlugin.to_dict' was never awaited` The warning is expected for the underlying code logic and test case, so safe to supress. * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] * Fixes `!!! important` block and adds ``. * `orjson` use in `WebSocket.{receive,send}_json()` Implementations are functionally the same as upstream except for orjson usage and we raise our own exceptions. Adds tests for `connection.WebSocket`. Creates `tests/connection` and moved `tests/request` to that location. * Support for SwaggerUI (#302) (#303) * Support for SwaggerUI (#302) * Support for SwaggerUI As per #300 * Use built-in copy method * Add basic sanity check tests for ReDoc and Swagger UI routes (#304) Tests for #303 / #302 These tests check whether the UI handlers: - don't throw an Exception - return 200 OK - return HTML of some form * updated urls, add docs * fix memoization issue Co-authored-by: Tim Wedde <timwedde@icloud.com> * 1.7.1 * Allow Partial to annotate fields of nested classes (#288) * Allow Partial to annotate fields for superclasses * added test to ensure __annotations__ are resolved from parent classes * added test for runtime behaviour of Partial on classes that don't inherit from pydantic.BaseModel * use typing.get_type_hints() instead of __annotations__ for getting class type annotations * raise ImproperlyConfiguredException if class passed to Partial doesn't inherit from BaseModel * added test to ensure Partial raises ImproperlyConfiguredException if an invalid class is given * added Partial section to DTO docs * docs: add Harry-Lees as a contributor for code, doc (#305) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * update docs * Tidy grammar in comment. * `OpenAPIConfig.use_handler_docstrings` Adds ability to configure openapi schema generation to use the route handler docstring for operation description. If `False` docstrings are ignored, this is default behavior for backward compatibility. If `True`, `HTTPRouteHandler.description` takes precedence if set, otherwise the docstring is used. * Adds detail to exception raised during signature model creation. * 1.7.2 * add route map extension * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Correct import * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * fix some issues caused when rebasing Co-authored-by: Zachary Dremann <dremann@gmail.com> Co-authored-by: Cody Fincher <204685+cofin@users.noreply.github.com> Co-authored-by: Na'aman Hirschfeld <nhirschfeld@gmail.com> Co-authored-by: Dane Solberg <danesolberg@gmail.com> Co-authored-by: Peter Schutt <peter@topsport.com.au> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: josepdaniel <36941460+josepdaniel@users.noreply.github.com> Co-authored-by: Joseph Daniel <jdn@logpoint.com> Co-authored-by: cătălin <catalin@roboces.dev> Co-authored-by: Peter Schutt <peter.github@proton.me> Co-authored-by: Tim Wedde <timwedde@icloud.com> Co-authored-by: Harry <harry.lees@gmail.com>

* add route map extension * change maturin to dev dependency * rust ext: make Node::is_asgi default to false * rust ext: remove unused dependency * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Move rust extension out of starlite folder * Correct import * Include rust source in sdist build * Working extension poetry build * Rename build.py * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * rust ext: remove some uses of `Python::acquire_gil()` * rust ext: don't return `PyResult` for infallible operations * rust ext: hide plain route methods from python interface * rust ext: add route collection parameter to `add_routes` * rust ext: use `IntoPy` trait method for `Node` instead of `as_pydict` * rust ext: refactor parameters for `configure_route_map_node` * rust ext: remove outdated comment * rust_ext: change uses of `cur` to `cur_node` * rust ext: fix typo in route map comments * rust ext: downgrade add_node_to_route_map return value to shared ref * rust_ext: port build_route_middleware_stack into extension util, removing starlite instance dependence * rust ext: add minimal test * Enhancement: Brotli compression middleware (#252) * FEATURE: Added Compression Middleware - Existing Gzip Middleware - Brotli with an optional Gzip fallback. * 1.5.4 * updated pyproject.toml to exclude lines form coverage report * Add tests for `Starlite.construct_route_map` * Address flake8 validation rules * Removes `uuid4()` from within parametrized test cases. Vscode test discovery caches the test case names including parametrized values. This makes having `uuid4()` calls in the parametrized test cases an issue as vscode shows test case failures when it cannot find test cases that it has previously resolved. As the change doesn't affect the utility of the test, it is better to fix the case for vscode users so we don't get the same issue reported in the future. * Addresses cognitive complexity of `DTOFactory.__call__()` by breaking nested logic out into helper methods. Changes no logic, test cov still 100% and existing tests pass. For #203 * updated dependencies * Issue 187 layered parameters (#261) * feat: added parameters to all app layers * feat: refactored handler layer resolution logic * chore: cleanup signature modelling * feat: add layered parameters to kwargs model * fix test coverage * skipped failing test in py 3.7 * update OA params * updated implementation to use ModelField insteam of FieldInfo * add openapi parameter tests * add docs * 1.6.0 * 1.6.1 * Fix route-map path existence test logic (#275) (#277) * added after_response (#279) * added after_response * addressed review comments * Issue 188: resolve exceptions swallowing args (#281) * updated exception init * add tests * 1.6.2 * chore: updated maintainer list (#285) * docs: add cofin as a contributor for maintenance (#286) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Issue #255: allow single element query param in sequence types (#262) * Array handling in query params * Refactor array handling Co-authored-by: Joseph Daniel <jdn@logpoint.com> * docs: add josepdaniel as a contributor for code (#290) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Updates instructions to install `testing` extra. * LifecycleHook improvements. - Adds `LifecycleHook` for eager evaluation of sync vs async callables and centralisation of handler resolution. Generic on handler response. - Adds aliases `AfterRequestHook`, `AfterResponseHook`, `BeforeRequestHook` that are strongly typed to appropriate handler response type. - Adds support for lifecycle hooks that are instance methods by overwriting handlers assigned to class variables on `Controller` only if they are originally functions. Closes #284 * Enhancement: Tortoise-ORM Plugin (#283) * added tortoise to dev dependencies * added base plugin implementation * add tests * updated plugin implementation * cleanup dependencies * updated implementation * fixed issues * resolved issues * add openapi support * fix tests * updated tests * add docs * fix linter issues * updated tests * 1.7.0 * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity (#292) * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity * Make `openapi.create_paramter_for_handler`'s helper functions public * Revise misleading `openapi.get_recursive_handler_parameters` docstrings * Adds `exceptions.utils.create_exception_response()`. - makes `starlite.exceptions` a sub-package with same api as module it replaces. - adds `starlite.exceptions.utils` module to house the response generation helper function. * Supress warning generated from Tortoise ORM DTO test case. Warning: `RuntimeWarning: coroutine 'TortoiseORMPlugin.to_dict' was never awaited` The warning is expected for the underlying code logic and test case, so safe to supress. * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] * Fixes `!!! important` block and adds ``. * `orjson` use in `WebSocket.{receive,send}_json()` Implementations are functionally the same as upstream except for orjson usage and we raise our own exceptions. Adds tests for `connection.WebSocket`. Creates `tests/connection` and moved `tests/request` to that location. * Support for SwaggerUI (#302) (#303) * Support for SwaggerUI (#302) * Support for SwaggerUI As per #300 * Use built-in copy method * Add basic sanity check tests for ReDoc and Swagger UI routes (#304) Tests for #303 / #302 These tests check whether the UI handlers: - don't throw an Exception - return 200 OK - return HTML of some form * updated urls, add docs * fix memoization issue Co-authored-by: Tim Wedde <timwedde@icloud.com> * 1.7.1 * Allow Partial to annotate fields of nested classes (#288) * Allow Partial to annotate fields for superclasses * added test to ensure __annotations__ are resolved from parent classes * added test for runtime behaviour of Partial on classes that don't inherit from pydantic.BaseModel * use typing.get_type_hints() instead of __annotations__ for getting class type annotations * raise ImproperlyConfiguredException if class passed to Partial doesn't inherit from BaseModel * added test to ensure Partial raises ImproperlyConfiguredException if an invalid class is given * added Partial section to DTO docs * docs: add Harry-Lees as a contributor for code, doc (#305) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * update docs * Tidy grammar in comment. * `OpenAPIConfig.use_handler_docstrings` Adds ability to configure openapi schema generation to use the route handler docstring for operation description. If `False` docstrings are ignored, this is default behavior for backward compatibility. If `True`, `HTTPRouteHandler.description` takes precedence if set, otherwise the docstring is used. * Adds detail to exception raised during signature model creation. * 1.7.2 * add route map extension * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Correct import * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * fix some issues caused when rebasing Co-authored-by: Zachary Dremann <dremann@gmail.com> Co-authored-by: Cody Fincher <204685+cofin@users.noreply.github.com> Co-authored-by: Na'aman Hirschfeld <nhirschfeld@gmail.com> Co-authored-by: Dane Solberg <danesolberg@gmail.com> Co-authored-by: Peter Schutt <peter@topsport.com.au> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: josepdaniel <36941460+josepdaniel@users.noreply.github.com> Co-authored-by: Joseph Daniel <jdn@logpoint.com> Co-authored-by: cătălin <catalin@roboces.dev> Co-authored-by: Peter Schutt <peter.github@proton.me> Co-authored-by: Tim Wedde <timwedde@icloud.com> Co-authored-by: Harry <harry.lees@gmail.com> Fix issues with Rust route map bindings (#310) * fix poetry.lock error * put auto-initialize behind a feature flag * update poetry.lock * add back missing plain_routes attribute (will be removed) cleanup Misc rust fixes/changes (#312) * Expose RouteMap as a python stub * Remove unused duplicate of rust extension inside starlite dir * Rename module to just `route_map` It's not clear that we need the module to include `_rs` * Remove need for macro for get_attr_and_downcast * Replace macro with a lambda * Use entry.or_insert_with for getting/inserting nodes Should be slightly more efficent: We only have to look up once, rather than twice * Remove unneeded `.into()`/`to_object()` calls * Add back a comment to the top of the route_map type stubs Explain what the file is, and where the implementation is located Update rust setup (#314) * updated folder structure and add pre commit hooks * replace pyi file with py file * update codespell hook * turn off TC006 * update ci Rust Bindings: CI (#317) * updated ci to handle rust testing * update python path * fix coverage * addressed review comments * remove flag preventing install when deps are cached Rust bindings - Some unit tests (#319) * update poetry.lock * add some init tests * add doc comment for gett_attr_and_downcast * derive Default for Node * reformat python scripts for rust tests

…ngs (litestar-org#270) * add route map extension * change maturin to dev dependency * rust ext: make Node::is_asgi default to false * rust ext: remove unused dependency * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Move rust extension out of starlite folder * Correct import * Include rust source in sdist build * Working extension poetry build * Rename build.py * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * rust ext: remove some uses of `Python::acquire_gil()` * rust ext: don't return `PyResult` for infallible operations * rust ext: hide plain route methods from python interface * rust ext: add route collection parameter to `add_routes` * rust ext: use `IntoPy` trait method for `Node` instead of `as_pydict` * rust ext: refactor parameters for `configure_route_map_node` * rust ext: remove outdated comment * rust_ext: change uses of `cur` to `cur_node` * rust ext: fix typo in route map comments * rust ext: downgrade add_node_to_route_map return value to shared ref * rust_ext: port build_route_middleware_stack into extension util, removing starlite instance dependence * rust ext: add minimal test * Enhancement: Brotli compression middleware (litestar-org#252) * FEATURE: Added Compression Middleware - Existing Gzip Middleware - Brotli with an optional Gzip fallback. * 1.5.4 * updated pyproject.toml to exclude lines form coverage report * Add tests for `Starlite.construct_route_map` * Address flake8 validation rules * Removes `uuid4()` from within parametrized test cases. Vscode test discovery caches the test case names including parametrized values. This makes having `uuid4()` calls in the parametrized test cases an issue as vscode shows test case failures when it cannot find test cases that it has previously resolved. As the change doesn't affect the utility of the test, it is better to fix the case for vscode users so we don't get the same issue reported in the future. * Addresses cognitive complexity of `DTOFactory.__call__()` by breaking nested logic out into helper methods. Changes no logic, test cov still 100% and existing tests pass. For litestar-org#203 * updated dependencies * Issue 187 layered parameters (litestar-org#261) * feat: added parameters to all app layers * feat: refactored handler layer resolution logic * chore: cleanup signature modelling * feat: add layered parameters to kwargs model * fix test coverage * skipped failing test in py 3.7 * update OA params * updated implementation to use ModelField insteam of FieldInfo * add openapi parameter tests * add docs * 1.6.0 * 1.6.1 * Fix route-map path existence test logic (litestar-org#275) (litestar-org#277) * added after_response (litestar-org#279) * added after_response * addressed review comments * Issue 188: resolve exceptions swallowing args (litestar-org#281) * updated exception init * add tests * 1.6.2 * chore: updated maintainer list (litestar-org#285) * docs: add cofin as a contributor for maintenance (litestar-org#286) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Issue litestar-org#255: allow single element query param in sequence types (litestar-org#262) * Array handling in query params * Refactor array handling Co-authored-by: Joseph Daniel <jdn@logpoint.com> * docs: add josepdaniel as a contributor for code (litestar-org#290) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Updates instructions to install `testing` extra. * LifecycleHook improvements. - Adds `LifecycleHook` for eager evaluation of sync vs async callables and centralisation of handler resolution. Generic on handler response. - Adds aliases `AfterRequestHook`, `AfterResponseHook`, `BeforeRequestHook` that are strongly typed to appropriate handler response type. - Adds support for lifecycle hooks that are instance methods by overwriting handlers assigned to class variables on `Controller` only if they are originally functions. Closes litestar-org#284 * Enhancement: Tortoise-ORM Plugin (litestar-org#283) * added tortoise to dev dependencies * added base plugin implementation * add tests * updated plugin implementation * cleanup dependencies * updated implementation * fixed issues * resolved issues * add openapi support * fix tests * updated tests * add docs * fix linter issues * updated tests * 1.7.0 * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity (litestar-org#292) * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity * Make `openapi.create_paramter_for_handler`'s helper functions public * Revise misleading `openapi.get_recursive_handler_parameters` docstrings * Adds `exceptions.utils.create_exception_response()`. - makes `starlite.exceptions` a sub-package with same api as module it replaces. - adds `starlite.exceptions.utils` module to house the response generation helper function. * Supress warning generated from Tortoise ORM DTO test case. Warning: `RuntimeWarning: coroutine 'TortoiseORMPlugin.to_dict' was never awaited` The warning is expected for the underlying code logic and test case, so safe to supress. * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] * Fixes `!!! important` block and adds ``. * `orjson` use in `WebSocket.{receive,send}_json()` Implementations are functionally the same as upstream except for orjson usage and we raise our own exceptions. Adds tests for `connection.WebSocket`. Creates `tests/connection` and moved `tests/request` to that location. * Support for SwaggerUI (litestar-org#302) (litestar-org#303) * Support for SwaggerUI (litestar-org#302) * Support for SwaggerUI As per litestar-org#300 * Use built-in copy method * Add basic sanity check tests for ReDoc and Swagger UI routes (litestar-org#304) Tests for litestar-org#303 / litestar-org#302 These tests check whether the UI handlers: - don't throw an Exception - return 200 OK - return HTML of some form * updated urls, add docs * fix memoization issue Co-authored-by: Tim Wedde <timwedde@icloud.com> * 1.7.1 * Allow Partial to annotate fields of nested classes (litestar-org#288) * Allow Partial to annotate fields for superclasses * added test to ensure __annotations__ are resolved from parent classes * added test for runtime behaviour of Partial on classes that don't inherit from pydantic.BaseModel * use typing.get_type_hints() instead of __annotations__ for getting class type annotations * raise ImproperlyConfiguredException if class passed to Partial doesn't inherit from BaseModel * added test to ensure Partial raises ImproperlyConfiguredException if an invalid class is given * added Partial section to DTO docs * docs: add Harry-Lees as a contributor for code, doc (litestar-org#305) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * update docs * Tidy grammar in comment. * `OpenAPIConfig.use_handler_docstrings` Adds ability to configure openapi schema generation to use the route handler docstring for operation description. If `False` docstrings are ignored, this is default behavior for backward compatibility. If `True`, `HTTPRouteHandler.description` takes precedence if set, otherwise the docstring is used. * Adds detail to exception raised during signature model creation. * 1.7.2 * add route map extension * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Correct import * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * fix some issues caused when rebasing Co-authored-by: Zachary Dremann <dremann@gmail.com> Co-authored-by: Cody Fincher <204685+cofin@users.noreply.github.com> Co-authored-by: Na'aman Hirschfeld <nhirschfeld@gmail.com> Co-authored-by: Dane Solberg <danesolberg@gmail.com> Co-authored-by: Peter Schutt <peter@topsport.com.au> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: josepdaniel <36941460+josepdaniel@users.noreply.github.com> Co-authored-by: Joseph Daniel <jdn@logpoint.com> Co-authored-by: cătălin <catalin@roboces.dev> Co-authored-by: Peter Schutt <peter.github@proton.me> Co-authored-by: Tim Wedde <timwedde@icloud.com> Co-authored-by: Harry <harry.lees@gmail.com> Fix issues with Rust route map bindings (litestar-org#310) * fix poetry.lock error * put auto-initialize behind a feature flag * update poetry.lock * add back missing plain_routes attribute (will be removed) cleanup Misc rust fixes/changes (litestar-org#312) * Expose RouteMap as a python stub * Remove unused duplicate of rust extension inside starlite dir * Rename module to just `route_map` It's not clear that we need the module to include `_rs` * Remove need for macro for get_attr_and_downcast * Replace macro with a lambda * Use entry.or_insert_with for getting/inserting nodes Should be slightly more efficent: We only have to look up once, rather than twice * Remove unneeded `.into()`/`to_object()` calls * Add back a comment to the top of the route_map type stubs Explain what the file is, and where the implementation is located Update rust setup (litestar-org#314) * updated folder structure and add pre commit hooks * replace pyi file with py file * update codespell hook * turn off TC006 * update ci Rust Bindings: CI (litestar-org#317) * updated ci to handle rust testing * update python path * fix coverage * addressed review comments * remove flag preventing install when deps are cached Rust bindings - Some unit tests (litestar-org#319) * update poetry.lock * add some init tests * add doc comment for gett_attr_and_downcast * derive Default for Node * reformat python scripts for rust tests

* Issue #177: Add a baseline for Rust path resolution bindings (#270) * add route map extension * change maturin to dev dependency * rust ext: make Node::is_asgi default to false * rust ext: remove unused dependency * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Move rust extension out of starlite folder * Correct import * Include rust source in sdist build * Working extension poetry build * Rename build.py * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * rust ext: remove some uses of `Python::acquire_gil()` * rust ext: don't return `PyResult` for infallible operations * rust ext: hide plain route methods from python interface * rust ext: add route collection parameter to `add_routes` * rust ext: use `IntoPy` trait method for `Node` instead of `as_pydict` * rust ext: refactor parameters for `configure_route_map_node` * rust ext: remove outdated comment * rust_ext: change uses of `cur` to `cur_node` * rust ext: fix typo in route map comments * rust ext: downgrade add_node_to_route_map return value to shared ref * rust_ext: port build_route_middleware_stack into extension util, removing starlite instance dependence * rust ext: add minimal test * Enhancement: Brotli compression middleware (#252) * FEATURE: Added Compression Middleware - Existing Gzip Middleware - Brotli with an optional Gzip fallback. * 1.5.4 * updated pyproject.toml to exclude lines form coverage report * Add tests for `Starlite.construct_route_map` * Address flake8 validation rules * Removes `uuid4()` from within parametrized test cases. Vscode test discovery caches the test case names including parametrized values. This makes having `uuid4()` calls in the parametrized test cases an issue as vscode shows test case failures when it cannot find test cases that it has previously resolved. As the change doesn't affect the utility of the test, it is better to fix the case for vscode users so we don't get the same issue reported in the future. * Addresses cognitive complexity of `DTOFactory.__call__()` by breaking nested logic out into helper methods. Changes no logic, test cov still 100% and existing tests pass. For #203 * updated dependencies * Issue 187 layered parameters (#261) * feat: added parameters to all app layers * feat: refactored handler layer resolution logic * chore: cleanup signature modelling * feat: add layered parameters to kwargs model * fix test coverage * skipped failing test in py 3.7 * update OA params * updated implementation to use ModelField insteam of FieldInfo * add openapi parameter tests * add docs * 1.6.0 * 1.6.1 * Fix route-map path existence test logic (#275) (#277) * added after_response (#279) * added after_response * addressed review comments * Issue 188: resolve exceptions swallowing args (#281) * updated exception init * add tests * 1.6.2 * chore: updated maintainer list (#285) * docs: add cofin as a contributor for maintenance (#286) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Issue #255: allow single element query param in sequence types (#262) * Array handling in query params * Refactor array handling Co-authored-by: Joseph Daniel <jdn@logpoint.com> * docs: add josepdaniel as a contributor for code (#290) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Updates instructions to install `testing` extra. * LifecycleHook improvements. - Adds `LifecycleHook` for eager evaluation of sync vs async callables and centralisation of handler resolution. Generic on handler response. - Adds aliases `AfterRequestHook`, `AfterResponseHook`, `BeforeRequestHook` that are strongly typed to appropriate handler response type. - Adds support for lifecycle hooks that are instance methods by overwriting handlers assigned to class variables on `Controller` only if they are originally functions. Closes #284 * Enhancement: Tortoise-ORM Plugin (#283) * added tortoise to dev dependencies * added base plugin implementation * add tests * updated plugin implementation * cleanup dependencies * updated implementation * fixed issues * resolved issues * add openapi support * fix tests * updated tests * add docs * fix linter issues * updated tests * 1.7.0 * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity (#292) * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity * Make `openapi.create_paramter_for_handler`'s helper functions public * Revise misleading `openapi.get_recursive_handler_parameters` docstrings * Adds `exceptions.utils.create_exception_response()`. - makes `starlite.exceptions` a sub-package with same api as module it replaces. - adds `starlite.exceptions.utils` module to house the response generation helper function. * Supress warning generated from Tortoise ORM DTO test case. Warning: `RuntimeWarning: coroutine 'TortoiseORMPlugin.to_dict' was never awaited` The warning is expected for the underlying code logic and test case, so safe to supress. * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] * Fixes `!!! important` block and adds ``. * `orjson` use in `WebSocket.{receive,send}_json()` Implementations are functionally the same as upstream except for orjson usage and we raise our own exceptions. Adds tests for `connection.WebSocket`. Creates `tests/connection` and moved `tests/request` to that location. * Support for SwaggerUI (#302) (#303) * Support for SwaggerUI (#302) * Support for SwaggerUI As per #300 * Use built-in copy method * Add basic sanity check tests for ReDoc and Swagger UI routes (#304) Tests for #303 / #302 These tests check whether the UI handlers: - don't throw an Exception - return 200 OK - return HTML of some form * updated urls, add docs * fix memoization issue Co-authored-by: Tim Wedde <timwedde@icloud.com> * 1.7.1 * Allow Partial to annotate fields of nested classes (#288) * Allow Partial to annotate fields for superclasses * added test to ensure __annotations__ are resolved from parent classes * added test for runtime behaviour of Partial on classes that don't inherit from pydantic.BaseModel * use typing.get_type_hints() instead of __annotations__ for getting class type annotations * raise ImproperlyConfiguredException if class passed to Partial doesn't inherit from BaseModel * added test to ensure Partial raises ImproperlyConfiguredException if an invalid class is given * added Partial section to DTO docs * docs: add Harry-Lees as a contributor for code, doc (#305) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * update docs * Tidy grammar in comment. * `OpenAPIConfig.use_handler_docstrings` Adds ability to configure openapi schema generation to use the route handler docstring for operation description. If `False` docstrings are ignored, this is default behavior for backward compatibility. If `True`, `HTTPRouteHandler.description` takes precedence if set, otherwise the docstring is used. * Adds detail to exception raised during signature model creation. * 1.7.2 * add route map extension * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Correct import * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * fix some issues caused when rebasing Co-authored-by: Zachary Dremann <dremann@gmail.com> Co-authored-by: Cody Fincher <204685+cofin@users.noreply.github.com> Co-authored-by: Na'aman Hirschfeld <nhirschfeld@gmail.com> Co-authored-by: Dane Solberg <danesolberg@gmail.com> Co-authored-by: Peter Schutt <peter@topsport.com.au> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: josepdaniel <36941460+josepdaniel@users.noreply.github.com> Co-authored-by: Joseph Daniel <jdn@logpoint.com> Co-authored-by: cătălin <catalin@roboces.dev> Co-authored-by: Peter Schutt <peter.github@proton.me> Co-authored-by: Tim Wedde <timwedde@icloud.com> Co-authored-by: Harry <harry.lees@gmail.com> Fix issues with Rust route map bindings (#310) * fix poetry.lock error * put auto-initialize behind a feature flag * update poetry.lock * add back missing plain_routes attribute (will be removed) cleanup Misc rust fixes/changes (#312) * Expose RouteMap as a python stub * Remove unused duplicate of rust extension inside starlite dir * Rename module to just `route_map` It's not clear that we need the module to include `_rs` * Remove need for macro for get_attr_and_downcast * Replace macro with a lambda * Use entry.or_insert_with for getting/inserting nodes Should be slightly more efficent: We only have to look up once, rather than twice * Remove unneeded `.into()`/`to_object()` calls * Add back a comment to the top of the route_map type stubs Explain what the file is, and where the implementation is located Update rust setup (#314) * updated folder structure and add pre commit hooks * replace pyi file with py file * update codespell hook * turn off TC006 * update ci Rust Bindings: CI (#317) * updated ci to handle rust testing * update python path * fix coverage * addressed review comments * remove flag preventing install when deps are cached Rust bindings - Some unit tests (#319) * update poetry.lock * add some init tests * add doc comment for gett_attr_and_downcast * derive Default for Node * reformat python scripts for rust tests * First simple routing unit test * Import less of starlite The unit tests for the route_map extension should not need to (transitively) import starlite.route_map * Fix unit tests after rebase * Simplify creation of routes * Avoid stack overflow on drop * Heavily refactor rust code * Convert HandlerGroup to an enum * Include cargo files in sdist * Address comments * Fix pytests added around static handlers * Comment out slotscheck Co-authored-by: Nicholas Ramos <35410160+nramos0@users.noreply.github.com>

* Issue #177: Add a baseline for Rust path resolution bindings (#270) * add route map extension * change maturin to dev dependency * rust ext: make Node::is_asgi default to false * rust ext: remove unused dependency * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Move rust extension out of starlite folder * Correct import * Include rust source in sdist build * Working extension poetry build * Rename build.py * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * rust ext: remove some uses of `Python::acquire_gil()` * rust ext: don't return `PyResult` for infallible operations * rust ext: hide plain route methods from python interface * rust ext: add route collection parameter to `add_routes` * rust ext: use `IntoPy` trait method for `Node` instead of `as_pydict` * rust ext: refactor parameters for `configure_route_map_node` * rust ext: remove outdated comment * rust_ext: change uses of `cur` to `cur_node` * rust ext: fix typo in route map comments * rust ext: downgrade add_node_to_route_map return value to shared ref * rust_ext: port build_route_middleware_stack into extension util, removing starlite instance dependence * rust ext: add minimal test * Enhancement: Brotli compression middleware (#252) * FEATURE: Added Compression Middleware - Existing Gzip Middleware - Brotli with an optional Gzip fallback. * 1.5.4 * updated pyproject.toml to exclude lines form coverage report * Add tests for `Starlite.construct_route_map` * Address flake8 validation rules * Removes `uuid4()` from within parametrized test cases. Vscode test discovery caches the test case names including parametrized values. This makes having `uuid4()` calls in the parametrized test cases an issue as vscode shows test case failures when it cannot find test cases that it has previously resolved. As the change doesn't affect the utility of the test, it is better to fix the case for vscode users so we don't get the same issue reported in the future. * Addresses cognitive complexity of `DTOFactory.__call__()` by breaking nested logic out into helper methods. Changes no logic, test cov still 100% and existing tests pass. For #203 * updated dependencies * Issue 187 layered parameters (#261) * feat: added parameters to all app layers * feat: refactored handler layer resolution logic * chore: cleanup signature modelling * feat: add layered parameters to kwargs model * fix test coverage * skipped failing test in py 3.7 * update OA params * updated implementation to use ModelField insteam of FieldInfo * add openapi parameter tests * add docs * 1.6.0 * 1.6.1 * Fix route-map path existence test logic (#275) (#277) * added after_response (#279) * added after_response * addressed review comments * Issue 188: resolve exceptions swallowing args (#281) * updated exception init * add tests * 1.6.2 * chore: updated maintainer list (#285) * docs: add cofin as a contributor for maintenance (#286) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Issue #255: allow single element query param in sequence types (#262) * Array handling in query params * Refactor array handling Co-authored-by: Joseph Daniel <jdn@logpoint.com> * docs: add josepdaniel as a contributor for code (#290) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Updates instructions to install `testing` extra. * LifecycleHook improvements. - Adds `LifecycleHook` for eager evaluation of sync vs async callables and centralisation of handler resolution. Generic on handler response. - Adds aliases `AfterRequestHook`, `AfterResponseHook`, `BeforeRequestHook` that are strongly typed to appropriate handler response type. - Adds support for lifecycle hooks that are instance methods by overwriting handlers assigned to class variables on `Controller` only if they are originally functions. Closes #284 * Enhancement: Tortoise-ORM Plugin (#283) * added tortoise to dev dependencies * added base plugin implementation * add tests * updated plugin implementation * cleanup dependencies * updated implementation * fixed issues * resolved issues * add openapi support * fix tests * updated tests * add docs * fix linter issues * updated tests * 1.7.0 * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity (#292) * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity * Make `openapi.create_paramter_for_handler`'s helper functions public * Revise misleading `openapi.get_recursive_handler_parameters` docstrings * Adds `exceptions.utils.create_exception_response()`. - makes `starlite.exceptions` a sub-package with same api as module it replaces. - adds `starlite.exceptions.utils` module to house the response generation helper function. * Supress warning generated from Tortoise ORM DTO test case. Warning: `RuntimeWarning: coroutine 'TortoiseORMPlugin.to_dict' was never awaited` The warning is expected for the underlying code logic and test case, so safe to supress. * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] * Fixes `!!! important` block and adds ``. * `orjson` use in `WebSocket.{receive,send}_json()` Implementations are functionally the same as upstream except for orjson usage and we raise our own exceptions. Adds tests for `connection.WebSocket`. Creates `tests/connection` and moved `tests/request` to that location. * Support for SwaggerUI (#302) (#303) * Support for SwaggerUI (#302) * Support for SwaggerUI As per #300 * Use built-in copy method * Add basic sanity check tests for ReDoc and Swagger UI routes (#304) Tests for #303 / #302 These tests check whether the UI handlers: - don't throw an Exception - return 200 OK - return HTML of some form * updated urls, add docs * fix memoization issue Co-authored-by: Tim Wedde <timwedde@icloud.com> * 1.7.1 * Allow Partial to annotate fields of nested classes (#288) * Allow Partial to annotate fields for superclasses * added test to ensure __annotations__ are resolved from parent classes * added test for runtime behaviour of Partial on classes that don't inherit from pydantic.BaseModel * use typing.get_type_hints() instead of __annotations__ for getting class type annotations * raise ImproperlyConfiguredException if class passed to Partial doesn't inherit from BaseModel * added test to ensure Partial raises ImproperlyConfiguredException if an invalid class is given * added Partial section to DTO docs * docs: add Harry-Lees as a contributor for code, doc (#305) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * update docs * Tidy grammar in comment. * `OpenAPIConfig.use_handler_docstrings` Adds ability to configure openapi schema generation to use the route handler docstring for operation description. If `False` docstrings are ignored, this is default behavior for backward compatibility. If `True`, `HTTPRouteHandler.description` takes precedence if set, otherwise the docstring is used. * Adds detail to exception raised during signature model creation. * 1.7.2 * add route map extension * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Correct import * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * fix some issues caused when rebasing Co-authored-by: Zachary Dremann <dremann@gmail.com> Co-authored-by: Cody Fincher <204685+cofin@users.noreply.github.com> Co-authored-by: Na'aman Hirschfeld <nhirschfeld@gmail.com> Co-authored-by: Dane Solberg <danesolberg@gmail.com> Co-authored-by: Peter Schutt <peter@topsport.com.au> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: josepdaniel <36941460+josepdaniel@users.noreply.github.com> Co-authored-by: Joseph Daniel <jdn@logpoint.com> Co-authored-by: cătălin <catalin@roboces.dev> Co-authored-by: Peter Schutt <peter.github@proton.me> Co-authored-by: Tim Wedde <timwedde@icloud.com> Co-authored-by: Harry <harry.lees@gmail.com> Fix issues with Rust route map bindings (#310) * fix poetry.lock error * put auto-initialize behind a feature flag * update poetry.lock * add back missing plain_routes attribute (will be removed) cleanup Misc rust fixes/changes (#312) * Expose RouteMap as a python stub * Remove unused duplicate of rust extension inside starlite dir * Rename module to just `route_map` It's not clear that we need the module to include `_rs` * Remove need for macro for get_attr_and_downcast * Replace macro with a lambda * Use entry.or_insert_with for getting/inserting nodes Should be slightly more efficent: We only have to look up once, rather than twice * Remove unneeded `.into()`/`to_object()` calls * Add back a comment to the top of the route_map type stubs Explain what the file is, and where the implementation is located Update rust setup (#314) * updated folder structure and add pre commit hooks * replace pyi file with py file * update codespell hook * turn off TC006 * update ci Rust Bindings: CI (#317) * updated ci to handle rust testing * update python path * fix coverage * addressed review comments * remove flag preventing install when deps are cached Rust bindings - Some unit tests (#319) * update poetry.lock * add some init tests * add doc comment for gett_attr_and_downcast * derive Default for Node * reformat python scripts for rust tests * First simple routing unit test * Import less of starlite The unit tests for the route_map extension should not need to (transitively) import starlite.route_map * Fix unit tests after rebase * Simplify creation of routes * Avoid stack overflow on drop * Heavily refactor rust code * Convert HandlerGroup to an enum * Include cargo files in sdist * Address comments * Fix pytests added around static handlers * Comment out slotscheck Co-authored-by: Nicholas Ramos <35410160+nramos0@users.noreply.github.com> Issue #177: Add a baseline for Rust path resolution bindings (#270) * add route map extension * change maturin to dev dependency * rust ext: make Node::is_asgi default to false * rust ext: remove unused dependency * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Move rust extension out of starlite folder * Correct import * Include rust source in sdist build * Working extension poetry build * Rename build.py * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * rust ext: remove some uses of `Python::acquire_gil()` * rust ext: don't return `PyResult` for infallible operations * rust ext: hide plain route methods from python interface * rust ext: add route collection parameter to `add_routes` * rust ext: use `IntoPy` trait method for `Node` instead of `as_pydict` * rust ext: refactor parameters for `configure_route_map_node` * rust ext: remove outdated comment * rust_ext: change uses of `cur` to `cur_node` * rust ext: fix typo in route map comments * rust ext: downgrade add_node_to_route_map return value to shared ref * rust_ext: port build_route_middleware_stack into extension util, removing starlite instance dependence * rust ext: add minimal test * Enhancement: Brotli compression middleware (#252) * FEATURE: Added Compression Middleware - Existing Gzip Middleware - Brotli with an optional Gzip fallback. * 1.5.4 * updated pyproject.toml to exclude lines form coverage report * Add tests for `Starlite.construct_route_map` * Address flake8 validation rules * Removes `uuid4()` from within parametrized test cases. Vscode test discovery caches the test case names including parametrized values. This makes having `uuid4()` calls in the parametrized test cases an issue as vscode shows test case failures when it cannot find test cases that it has previously resolved. As the change doesn't affect the utility of the test, it is better to fix the case for vscode users so we don't get the same issue reported in the future. * Addresses cognitive complexity of `DTOFactory.__call__()` by breaking nested logic out into helper methods. Changes no logic, test cov still 100% and existing tests pass. For #203 * updated dependencies * Issue 187 layered parameters (#261) * feat: added parameters to all app layers * feat: refactored handler layer resolution logic * chore: cleanup signature modelling * feat: add layered parameters to kwargs model * fix test coverage * skipped failing test in py 3.7 * update OA params * updated implementation to use ModelField insteam of FieldInfo * add openapi parameter tests * add docs * 1.6.0 * 1.6.1 * Fix route-map path existence test logic (#275) (#277) * added after_response (#279) * added after_response * addressed review comments * Issue 188: resolve exceptions swallowing args (#281) * updated exception init * add tests * 1.6.2 * chore: updated maintainer list (#285) * docs: add cofin as a contributor for maintenance (#286) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Issue #255: allow single element query param in sequence types (#262) * Array handling in query params * Refactor array handling Co-authored-by: Joseph Daniel <jdn@logpoint.com> * docs: add josepdaniel as a contributor for code (#290) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * Updates instructions to install `testing` extra. * LifecycleHook improvements. - Adds `LifecycleHook` for eager evaluation of sync vs async callables and centralisation of handler resolution. Generic on handler response. - Adds aliases `AfterRequestHook`, `AfterResponseHook`, `BeforeRequestHook` that are strongly typed to appropriate handler response type. - Adds support for lifecycle hooks that are instance methods by overwriting handlers assigned to class variables on `Controller` only if they are originally functions. Closes #284 * Enhancement: Tortoise-ORM Plugin (#283) * added tortoise to dev dependencies * added base plugin implementation * add tests * updated plugin implementation * cleanup dependencies * updated implementation * fixed issues * resolved issues * add openapi support * fix tests * updated tests * add docs * fix linter issues * updated tests * 1.7.0 * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity (#292) * Split `openapi.create_paramter_for_handler` into several methods to reduce complexity * Make `openapi.create_paramter_for_handler`'s helper functions public * Revise misleading `openapi.get_recursive_handler_parameters` docstrings * Adds `exceptions.utils.create_exception_response()`. - makes `starlite.exceptions` a sub-package with same api as module it replaces. - adds `starlite.exceptions.utils` module to house the response generation helper function. * Supress warning generated from Tortoise ORM DTO test case. Warning: `RuntimeWarning: coroutine 'TortoiseORMPlugin.to_dict' was never awaited` The warning is expected for the underlying code logic and test case, so safe to supress. * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] * Fixes `!!! important` block and adds ``. * `orjson` use in `WebSocket.{receive,send}_json()` Implementations are functionally the same as upstream except for orjson usage and we raise our own exceptions. Adds tests for `connection.WebSocket`. Creates `tests/connection` and moved `tests/request` to that location. * Support for SwaggerUI (#302) (#303) * Support for SwaggerUI (#302) * Support for SwaggerUI As per #300 * Use built-in copy method * Add basic sanity check tests for ReDoc and Swagger UI routes (#304) Tests for #303 / #302 These tests check whether the UI handlers: - don't throw an Exception - return 200 OK - return HTML of some form * updated urls, add docs * fix memoization issue Co-authored-by: Tim Wedde <timwedde@icloud.com> * 1.7.1 * Allow Partial to annotate fields of nested classes (#288) * Allow Partial to annotate fields for superclasses * added test to ensure __annotations__ are resolved from parent classes * added test for runtime behaviour of Partial on classes that don't inherit from pydantic.BaseModel * use typing.get_type_hints() instead of __annotations__ for getting class type annotations * raise ImproperlyConfiguredException if class passed to Partial doesn't inherit from BaseModel * added test to ensure Partial raises ImproperlyConfiguredException if an invalid class is given * added Partial section to DTO docs * docs: add Harry-Lees as a contributor for code, doc (#305) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> * update docs * Tidy grammar in comment. * `OpenAPIConfig.use_handler_docstrings` Adds ability to configure openapi schema generation to use the route handler docstring for operation description. If `False` docstrings are ignored, this is default behavior for backward compatibility. If `True`, `HTTPRouteHandler.description` takes precedence if set, otherwise the docstring is used. * Adds detail to exception raised during signature model creation. * 1.7.2 * add route map extension * Build rust project with poetry * Move cargo stuff entirely within the extensions/rust dir * Correct import * Ignore build directory * fix .gitignore order * rust ext: refactor and rename route map module; added resolve_asgi_app() * reinstall lock file * fix some issues caused when rebasing Co-authored-by: Zachary Dremann <dremann@gmail.com> Co-authored-by: Cody Fincher <204685+cofin@users.noreply.github.com> Co-authored-by: Na'aman Hirschfeld <nhirschfeld@gmail.com> Co-authored-by: Dane Solberg <danesolberg@gmail.com> Co-authored-by: Peter Schutt <peter@topsport.com.au> Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com> Co-authored-by: josepdaniel <36941460+josepdaniel@users.noreply.github.com> Co-authored-by: Joseph Daniel <jdn@logpoint.com> Co-authored-by: cătălin <catalin@roboces.dev> Co-authored-by: Peter Schutt <peter.github@proton.me> Co-authored-by: Tim Wedde <timwedde@icloud.com> Co-authored-by: Harry <harry.lees@gmail.com> Fix issues with Rust route map bindings (#310) * fix poetry.lock error * put auto-initialize behind a feature flag * update poetry.lock * add back missing plain_routes attribute (will be removed) cleanup Misc rust fixes/changes (#312) * Expose RouteMap as a python stub * Remove unused duplicate of rust extension inside starlite dir * Rename module to just `route_map` It's not clear that we need the module to include `_rs` * Remove need for macro for get_attr_and_downcast * Replace macro with a lambda * Use entry.or_insert_with for getting/inserting nodes Should be slightly more efficent: We only have to look up once, rather than twice * Remove unneeded `.into()`/`to_object()` calls * Add back a comment to the top of the route_map type stubs Explain what the file is, and where the implementation is located Update rust setup (#314) * updated folder structure and add pre commit hooks * replace pyi file with py file * update codespell hook * turn off TC006 * update ci Rust Bindings: CI (#317) * updated ci to handle rust testing * update python path * fix coverage * addressed review comments * remove flag preventing install when deps are cached Rust bindings - Some unit tests (#319) * update poetry.lock * add some init tests * add doc comment for gett_attr_and_downcast * derive Default for Node * reformat python scripts for rust tests

Goldziher suggested changes Jul 5, 2022

View reviewed changes

Goldziher reviewed Jul 6, 2022

View reviewed changes

starlite/app.py Outdated Show resolved Hide resolved

starlite/config.py Outdated Show resolved Hide resolved

starlite/config.py Outdated Show resolved Hide resolved

starlite/config.py Outdated Show resolved Hide resolved

starlite/middleware/__init__.py Outdated Show resolved Hide resolved

peterschutt reviewed Jul 6, 2022

View reviewed changes

starlite/__init__.py Show resolved Hide resolved