-
Notifications
You must be signed in to change notification settings - Fork 4
docs: create Common Pitfalls Guide #58
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
enoshdev
wants to merge
1
commit into
AllDotPy:master
Choose a base branch
from
enoshdev:docs-common-pitfalls
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+47
−0
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| # Common Pitfalls | ||
|
|
||
| This guide covers common mistakes new Ryx users make and how to fix them. | ||
|
|
||
| ## 1. Using `select_related` when you need `prefetch_related` | ||
|
|
||
| **Problem:** Using `select_related` for many-to-many or reverse foreign key relationships causes errors. | ||
|
|
||
| **Solution:** Use `prefetch_related` for many-to-many and reverse foreign key relationships. Use `select_related` only for forward foreign key and one-to-one relationships. | ||
|
|
||
| ```python | ||
| # Wrong | ||
| users = await User.objects.select_related("posts").all() | ||
|
|
||
| # Correct | ||
| users = await User.objects.prefetch_related("posts").all() | ||
| ``` | ||
|
|
||
| ## 2. Forgetting to use async context managers | ||
|
|
||
| **Problem:** Opening database connections without async context managers causes connection leaks. | ||
|
|
||
| **Solution:** Always use `async with` when working with database connections. | ||
|
|
||
| ```python | ||
| # Wrong | ||
| db = Database() | ||
| await db.connect() | ||
|
|
||
| # Correct | ||
| async with Database() as db: | ||
| await db.query(...) | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please read the docs... |
||
| ``` | ||
|
|
||
| ## 3. Not awaiting async queries | ||
|
|
||
| **Problem:** Forgetting `await` on async queries returns a coroutine object instead of results. | ||
|
|
||
| **Solution:** Always use `await` with Ryx query methods. | ||
|
|
||
| ```python | ||
| # Wrong | ||
| users = User.objects.all() | ||
|
|
||
| # Correct | ||
| users = await User.objects.all() | ||
| ``` | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ryx doesn't have
Databaseclass...At least make sure you read the docs or your AI has the right context before generating contents for contributions to avoid hallucination ...