Skip to content

📝 Update docs to advise against using from __future__ import annotations #778

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.

Sign up for GitHub

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
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

📝 Update docs to advise against using from __future__ import annotations #778

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
670b87a
Update type-annotation-strings.md
aholten Jan 10, 2024
0103d21
Trim whitespace
aholten Jan 10, 2024
6f688f5
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Jan 10, 2024
6525725
Merge branch 'main' into main
aholten Mar 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/tutorial/relationship-attributes/type-annotation-strings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ What's that about? Can't we just write it normally as `List[Hero]`?

By that point, in that line in the code, the Python interpreter **doesn't know of any class `Hero`**, and if we put it just there, it would try to find it unsuccessfully, and then fail. 😭

Unlike some other Python features, SQLModel does not require the import `from __future__ import annotations` to handle forward referenced type annotations. In fact, when working with SQLModel, this import will disrupt the mapping of forward referenced types.

But by putting it in quotes, in a string, the interpreter sees it as just a string with the text `"Hero"` inside.

But the editor and other tools can see that **the string is actually a type annotation inside**, and provide all the autocompletion, type checks, etc. 🎉
Expand Down