|
| 1 | +from __future__ import annotations |
| 2 | + |
| 3 | +from typing_extensions import assert_type |
| 4 | + |
| 5 | +from peewee import BigBitField, BigBitFieldData, CharField, ForeignKeyField, IntegerField, Model |
| 6 | + |
| 7 | + |
| 8 | +class User(Model): |
| 9 | + username = CharField() |
| 10 | + age = IntegerField() |
| 11 | + nickname = CharField(null=True) |
| 12 | + |
| 13 | + |
| 14 | +class Tweet(Model): |
| 15 | + user = ForeignKeyField(User) |
| 16 | + author = ForeignKeyField(User, null=True) |
| 17 | + |
| 18 | + |
| 19 | +class Event(Model): |
| 20 | + flags = BigBitField() |
| 21 | + |
| 22 | + |
| 23 | +# A field is a descriptor that resolves differently depending on whether it is |
| 24 | +# accessed on the model class or on an instance. `Model.field` is the Field |
| 25 | +# object itself (used to build queries), while `instance.field` is the stored |
| 26 | +# Python value. |
| 27 | +assert_type(User.username, CharField[str]) |
| 28 | +assert_type(User().username, str) |
| 29 | + |
| 30 | +assert_type(User.age, IntegerField[int]) |
| 31 | +assert_type(User().age, int) |
| 32 | + |
| 33 | +# `null=True` allows the value to include None, both in the field's own |
| 34 | +# parameterization and in the value produced on attribute access. |
| 35 | +assert_type(User.nickname, CharField[str | None]) |
| 36 | +assert_type(User().nickname, str | None) |
| 37 | + |
| 38 | +# Foreign keys resolve to the related model instance, or None when nullable. |
| 39 | +assert_type(Tweet.user, ForeignKeyField[User]) |
| 40 | +assert_type(Tweet().user, User) |
| 41 | +assert_type(Tweet().author, User | None) |
| 42 | + |
| 43 | +# BigBitField is a special case: the instance descriptor yields a |
| 44 | +# BigBitFieldData wrapper rather than the underlying bytes. |
| 45 | +assert_type(Event.flags, BigBitField) |
| 46 | +assert_type(Event().flags, BigBitFieldData) |
| 47 | + |
| 48 | +# __set__ accepts the field's value type... |
| 49 | +user = User() |
| 50 | +user.username = "guido" |
| 51 | +user.age = 42 |
| 52 | +user.nickname = None # nullable field accepts None |
| 53 | + |
| 54 | +# ...and rejects incompatible values. |
| 55 | +user.age = "not an int" # type: ignore |
| 56 | +user.username = None # type: ignore # non-null field rejects None |
0 commit comments