-
Notifications
You must be signed in to change notification settings - Fork 13
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
🚸 Cleaner API #1723
Merged
Merged
🚸 Cleaner API #1723
Conversation
This file contains 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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1723 +/- ##
==========================================
+ Coverage 92.12% 92.14% +0.02%
==========================================
Files 50 50
Lines 5496 5476 -20
==========================================
- Hits 5063 5046 -17
+ Misses 433 430 -3 ☔ View full report in Codecov by Sentry. |
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.
VSCode builds their auto-complete completely statically. The only way to arrive at a clean API while still directly leveraging subclasses of Django Model is by making the internal Django API private.
This is now achieved when running:
Also, we define Registry class methods via a meta class. Thanks, @Koncopd!
Here is an extensive conversation with Claude 3.5 Sonnet on why this seems to best compromise. Other routes we investigated were, e.g., building the
Registry
class via composition rather than inheritance.Below are screenshots for the auto-complete experience in JupyterLab and VSCode.
What still doesn't work are backwards fields that are dynamically generated by Django. These are going to be added through type annotations in another PR.
See: