fix: instructions in deprecation warning #4121
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Clarify the instructions in the deprecation warning to specify importing the module and accessing attributes explicitly.
Introduce a test to ensure proper deprecation warnings are raised when importing from `litestar.contrib.sqlalchemy`. This validates the module's behavior and provides guidance on correct import paths for affected components.
github-actions
bot
added
size: small
pr/external
Triage Required 🏥
YuanhengZ
changed the title
So that ruff test can pass.
So that ruff test can pass.
This appears to be handled separately in __getattr__
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #4121 +/- ##
=======================================
Coverage 98.37% 98.37%
=======================================
Files 348 348
Lines 15845 15847 +2
Branches 1749 1749
=======================================
+ Hits 15587 15589 +2
Misses 123 123
Partials 135 135 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Documentation preview will be available shortly at https://litestar-org.github.io/litestar-docs-preview/4121 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The instruction from deprecation warning from
litestar/contrib/sqlalchemy/__init__.pyis a little bit confusion.Try to restructured it so that ppl reading this warning can fix it without looking for more documentation.
Also added test that checking this behavior.
Though I have some doubt about this test as it dose not run(test) against any logic.
Added it here to comply with contribution guide.
Closes
Fix #4117