feat: add cache store parameter on route level basis #3869

dylandoamaral · 2024-11-21T16:20:34Z

Description

Allow the user to define on a route level basis what would be the used namespace by overriding the default one. It allows, as an example, to delete some routes easily solely based on the namespace.

This is my first commit in this repository, I don't know if I did it right. Sorry for the inconvenience ! By the way, after reading the documentation for contributing, I don't know when and if I have to run the all-contributors myself.

I will also have to update the documentation, but first I prefer someone to tell me if this feature should be merged or ignored :).

Closes

Closes #3854

…ect plugin being added in tutorial (litestar-org#3768) Update line emphasis sqlalchemy "Using the init plugin" tutorial

…rom schema_extra are not found (litestar-org#3766) (litestar-org#3767)

…r-org#3779) Co-authored-by: Alc-Alc <alc@localhost>

…#3790)

…rg#3797)

Co-authored-by: Janek Nouvertné <[email protected]>

…ar-org#3796)

…star-org#3802) * docs: change the `ExperimentalFeatures.DTO_CODEGEN` description * docs: change the `ExperimentalFeatures.DTO_CODEGEN` description

…litestar-org#3799)

…ialization.py` (litestar-org#3809)

* docs: fix "DTO Factory and PATCH requests" section * docs: fix "DTO Factory and PATCH requests" section * Adjust highlighted indexes

* docs: fix `DTO Data` section with a new example * Update docs/usage/dto/1-abstract-dto.rst Co-authored-by: Alc-Alc <[email protected]> --------- Co-authored-by: Alc-Alc <[email protected]>

…ata" (litestar-org#3815) Co-authored-by: Janek Nouvertné <[email protected]>

@Alc-Alc

* docs: rewrite "Builtin middleware" usage * Fix CI * Address review by @Alc-Alc

…litestar-org#3784)

) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

* feat: deprecate `litestar.contrib.pydantic`

…itestar-org#3860) * docs: added `debug==True` in Testing to display exception stack trace * docs: ruff-format * docs: add `app.debug = True` to the fixture sample code

* docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

Co-authored-by: Jacob Coffee <[email protected]> Co-authored-by: guacs <[email protected]>

moves `litestar.contrib.prometheus` to `litestar.plugins.prometheus`

…aral/litestar into feat/add-cache-store-parameter

codecov · 2024-11-21T16:31:19Z

Codecov Report

Attention: Patch coverage is 99.25558% with 6 lines in your changes missing coverage. Please review.

Project coverage is 98.41%. Comparing base (b187749) to head (e39b1b4).
Report is 25 commits behind head on v3.0.

Files with missing lines	Patch %	Lines
litestar/connection/request.py	90.32%	1 Missing and 2 partials ⚠️
litestar/_openapi/schema_generation/examples.py	50.00%	1 Missing ⚠️
litestar/plugins/prometheus/middleware.py	98.75%	0 Missing and 1 partial ⚠️
litestar/plugins/pydantic/utils.py	99.44%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             v3.0    #3869      +/-   ##
==========================================
+ Coverage   98.35%   98.41%   +0.05%     
==========================================
  Files         332      343      +11     
  Lines       15460    15457       -3     
  Branches     2460     1702     -758     
==========================================
+ Hits        15206    15212       +6     
- Misses        112      115       +3     
+ Partials      142      130      -12

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚨 Try these New Features:

Flaky Tests Detection - Detect and resolve failed and flaky tests
JS Bundle Analysis - Avoid shipping oversized bundles

github-actions · 2024-11-21T16:32:55Z

Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/3869

provinzkraut

Hey @dylandoamaral, thanks for the PR!

The change is okay in general, but due to the change in the get_store_from_app signature, it would be considered breaking. You could either try to find a way to make this not breaking, or target version 3 by pointing your PR at the v3.0 branch

dylandoamaral · 2024-11-21T17:05:28Z

Thanks for your response. It is still breaking even with an optional defaulted value ?

provinzkraut · 2024-11-21T18:12:50Z

Thanks for your response. It is still breaking even with an optional defaulted value ?

Yes, it would.

For example, if someone has overwritten this method in a subclass, it would break for them, because their subclass does not know of this parameter.

dylandoamaral · 2024-11-22T15:03:38Z

Oh v3.0 is not up to date with develop, my bad I will need to fix it.

dylandoamaral · 2024-11-22T15:21:37Z

Supersed by #3871

eliasfandi and others added 30 commits September 30, 2024 08:32

fix: (typo) changed emphasis from line 12 to 11 to highlight the corr…

4894593

…ect plugin being added in tutorial (litestar-org#3768) Update line emphasis sqlalchemy "Using the init plugin" tutorial

fix: sign bug in rate limit middelware (litestar-org#3776)

63b3b3f

docs: add pogopaule as a contributor for code (litestar-org#3777)

1e55ef3

fix: map JSONSchema spec naming convention to snake_case when names f…

e7dfc7a

…rom schema_extra are not found (litestar-org#3766) (litestar-org#3767)

docs(readme): Remove reference to litestar-pg-redis-docker (litesta…

e18aa3d

…r-org#3779) Co-authored-by: Alc-Alc <alc@localhost>

chore(devcontainer): Fix python version in devcontainer (litestar-org…

600451e

…#3790)

docs: Fix python code highlight in many examples (litestar-org#3788)

bc7a0ce

docs: fix a typo in requests usage docs (litestar-org#3794)

ad592f6

docs: fix typos in sqlalchemy examples (litestar-org#3798)

6493543

docs: fix typos in sqlalchemy/models_and_repository.rst (litestar-o…

39b4ed2

…rg#3797)

docs: fix missing import in cache usage (litestar-org#3795)

1a4f1a3

Co-authored-by: Janek Nouvertné <[email protected]>

docs: make sure that channels use finally in all examples (litest…

173098b

…ar-org#3796)

docs: change the ExperimentalFeatures.DTO_CODEGEN description (lite…

fdb4f3d

…star-org#3802) * docs: change the `ExperimentalFeatures.DTO_CODEGEN` description * docs: change the `ExperimentalFeatures.DTO_CODEGEN` description

docs: change sync-to-thread-info.rst wording about sync_to_thread (…

2305719

…litestar-org#3799)

docs: add missing rename strategy to dto docs (litestar-org#3805)

cf3217f

docs: fix highlighted lines in DTO usage (litestar-org#3808)

45df0bf

fix: typo in a deprecation warning in `contrib/sqlalchemy/plugins/ser…

c5421e5

…ialization.py` (litestar-org#3809)

chore(ci): fix the pr_merged.yml workflow (litestar-org#3811)

236cfa3

chore(mypy): enable more mypy codes (litestar-org#3817)

a7cd193

docs: fix "DTO Factory and PATCH requests" section (litestar-org#3819)

50e1ad2

* docs: fix "DTO Factory and PATCH requests" section * docs: fix "DTO Factory and PATCH requests" section * Adjust highlighted indexes

chore(mypy): enable possibly-undefined error code (litestar-org#3818)

682e4c7

docs: fix DTO Data section with a new example (litestar-org#3813)

45d5ec1

* docs: fix `DTO Data` section with a new example * Update docs/usage/dto/1-abstract-dto.rst Co-authored-by: Alc-Alc <[email protected]> --------- Co-authored-by: Alc-Alc <[email protected]>

docs: fix highlight of code example in "Providing values for nested d…

f534f52

…ata" (litestar-org#3815) Co-authored-by: Janek Nouvertné <[email protected]>

docs: rewrite htmx guide (litestar-org#3825)

d060d41

docs: refactor "Hooks" usage documentation (litestar-org#3826)

6f79fb3

docs: fix API reference for asgi_types scopes (litestar-org#3831)

0e32aae

docs: rewrite "Builtin middleware" usage (litestar-org#3830)

a1b530c

* docs: rewrite "Builtin middleware" usage * Fix CI * Address review by @Alc-Alc

fix(prometheus): fix path template for routes without path parameters (…

fd3ff42

…litestar-org#3784)

docs: add mohammedbabelly20 as a contributor for code (litestar-org#3832

f7b258f

) * docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

docs: refactor "Custom Middleware" guide (litestar-org#3833)

b2adb0d

cofin and others added 8 commits November 15, 2024 19:02

feat: deprecate litestar.contrib.pydantic (litestar-org#3852)

a2b8e48

* feat: deprecate `litestar.contrib.pydantic`

docs: Added debug=True in Testing to display exception stack trace (l…

1b2ef9a

…itestar-org#3860) * docs: added `debug==True` in Testing to display exception stack trace * docs: ruff-format * docs: add `app.debug = True` to the fixture sample code

fix(typing): Fix typing in websocket listener class (litestar-org#3765)

a3631e2

docs: add olzhasar as a contributor for bug, and doc (litestar-org#3865)

7e56814

* docs: update README.md [skip ci] * docs: update .all-contributorsrc [skip ci] --------- Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

Merge commit from fork

53c1473

Co-authored-by: Jacob Coffee <[email protected]> Co-authored-by: guacs <[email protected]>

v2.13.0

1b9d1c8

feat: deprecate litestar.contrib.prometheus (litestar-org#3863)

44d42e6

moves `litestar.contrib.prometheus` to `litestar.plugins.prometheus`

feat: add cache store parameter

c651589

dylandoamaral requested review from a team as code owners November 21, 2024 16:20

github-actions bot added area/middleware This PR involves changes to the middleware size: small type/feat pr/external Triage Required 🏥 This requires triage labels Nov 21, 2024

dylandoamaral and others added 4 commits November 21, 2024 17:21

chore: fix format

28fa61c

Merge branch 'main' into feat/add-cache-store-parameter

15c3893

chore: fix format

0599e3f

Merge branch 'feat/add-cache-store-parameter' of github.com:dylandoam…

e39b1b4

…aral/litestar into feat/add-cache-store-parameter

provinzkraut requested changes Nov 21, 2024

View reviewed changes

dylandoamaral changed the base branch from main to v3.0 November 22, 2024 14:59

dylandoamaral requested a review from JacobCoffee as a code owner November 22, 2024 14:59

dylandoamaral mentioned this pull request Nov 22, 2024

feat: add cache store route parameter #3871

Open

dylandoamaral closed this Nov 22, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add cache store parameter on route level basis #3869

feat: add cache store parameter on route level basis #3869

dylandoamaral commented Nov 21, 2024 •

edited

Loading

codecov bot commented Nov 21, 2024 •

edited

Loading

github-actions bot commented Nov 21, 2024

provinzkraut left a comment

dylandoamaral commented Nov 21, 2024

provinzkraut commented Nov 21, 2024

dylandoamaral commented Nov 22, 2024 •

edited

Loading

dylandoamaral commented Nov 22, 2024

feat: add cache store parameter on route level basis #3869

feat: add cache store parameter on route level basis #3869

Conversation

dylandoamaral commented Nov 21, 2024 • edited Loading

Description

Closes

codecov bot commented Nov 21, 2024 • edited Loading

Codecov Report

github-actions bot commented Nov 21, 2024

provinzkraut left a comment

Choose a reason for hiding this comment

dylandoamaral commented Nov 21, 2024

provinzkraut commented Nov 21, 2024

dylandoamaral commented Nov 22, 2024 • edited Loading

dylandoamaral commented Nov 22, 2024

dylandoamaral commented Nov 21, 2024 •

edited

Loading

codecov bot commented Nov 21, 2024 •

edited

Loading

dylandoamaral commented Nov 22, 2024 •

edited

Loading