Skip to content
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

Jump to bottom

✏️ Fix broken link to @dataclass_transform (now PEP 681) in docs/features.md #753

Merged
merged 4 commits into from
Jun 3, 2024
Merged

✏️ Fix broken link to @dataclass_transform (now PEP 681) in docs/features.md #753

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a6431dd
✏️ Fix broken link to @dataclass_transform (now PEP-681)
soof-golan Dec 17, 2023
c2b4e58
✏️ Update docs/features.md
tiangolo Jun 3, 2024
79d6386
✏️ Tweak docs
tiangolo Jun 3, 2024
7edd288
Merge branch 'main' into patch-1
tiangolo Jun 3, 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
12 changes: 1 addition & 11 deletions docs/features.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,20 +36,10 @@ You will get completion for everything while writing the **minimum** amount of c

You won't need to keep guessing the types of different attributes in your models, if they could be `None`, etc. Your editor will be able to help you with everything because **SQLModel** is based on **standard Python type annotations**.

**SQLModel** even adopts currently <a href="https://github.com/microsoft/pyright/blob/main/specs/dataclass_transforms.md" class="external-link" target="_blank">in development standards</a> for Python type annotations to ensure the **best developer experience**, so you will get inline errors and autocompletion even while creating new model instances.
**SQLModel** adopts <a href="https://peps.python.org/pep-0681/" class="external-link" target="_blank">PEP 681</a> for Python type annotations to ensure the **best developer experience**, so you will get inline errors and autocompletion even while creating new model instances.

<img class="shadow" src="/img/index/autocompletion01.png">

/// info

Don't worry, adopting this in-development standard only affects/improves editor support.

It doesn't affect performance or correctness. And if the in-progress standard was deprecated your code won't be affected.

Meanwhile, you will get inline errors (like type checks) and autocompletion on places you wouldn't get with any other library. 🎉

///

## Short

**SQLModel** has **sensible defaults** for everything, with **optional configurations** everywhere.
Expand Down
Loading