Fields
Defining fields on models.
Field ¶
Field(
default: Any = PydanticUndefined,
*,
default_factory: Callable[[], Any] | None = _Unset,
alias: str | None = _Unset,
alias_priority: int | None = _Unset,
validation_alias: (
str | AliasPath | AliasChoices | None
) = _Unset,
serialization_alias: str | None = _Unset,
title: str | None = _Unset,
field_title_generator: (
Callable[[str, FieldInfo], str] | None
) = _Unset,
description: str | None = _Unset,
examples: list[Any] | None = _Unset,
exclude: bool | None = _Unset,
discriminator: str | Discriminator | None = _Unset,
deprecated: Deprecated | str | bool | None = _Unset,
json_schema_extra: (
JsonDict | Callable[[JsonDict], None] | None
) = _Unset,
frozen: bool | None = _Unset,
validate_default: bool | None = _Unset,
repr: bool = _Unset,
init: bool | None = _Unset,
init_var: bool | None = _Unset,
kw_only: bool | None = _Unset,
pattern: str | Pattern[str] | None = _Unset,
strict: bool | None = _Unset,
coerce_numbers_to_str: bool | None = _Unset,
gt: SupportsGt | None = _Unset,
ge: SupportsGe | None = _Unset,
lt: SupportsLt | None = _Unset,
le: SupportsLe | None = _Unset,
multiple_of: float | None = _Unset,
allow_inf_nan: bool | None = _Unset,
max_digits: int | None = _Unset,
decimal_places: int | None = _Unset,
min_length: int | None = _Unset,
max_length: int | None = _Unset,
union_mode: Literal["smart", "left_to_right"] = _Unset,
fail_fast: bool | None = _Unset,
**extra: Unpack[_EmptyKwargs]
) -> Any
Usage Documentation
設定可能なオブジェクトのフィールドを作成します。
モデルスキーマまたは複雑な検証のために、フィールドに関する追加情報を提供するために使用されます。引数の中には、数値フィールド(int
、float
、Decimal
)にのみ適用されるものと、str
にのみ適用されるものがあります。
Note
_Unset
オブジェクトは、_DefaultValues
辞書で定義された対応する値に置き換えられます。_Unset
オブジェクトのキーが_DefaultValues
辞書で見つからない場合は、デフォルトでNone
になります。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
default |
Any
|
フィールドが設定されていない場合のデフォルト値。 |
PydanticUndefined
|
default_factory |
Callable[[], Any] | None
|
:func: |
_Unset
|
alias |
str | None
|
エイリアスによる検証またはシリアライズ時にアトリビュートに使用する名前。スネークとキャメルケース間の変換などによく使用されます。 |
_Unset
|
alias_priority |
int | None
|
別名の優先度。別名ジェネレータを使用するかどうかに影響します。 |
_Unset
|
validation_alias |
str | AliasPath | AliasChoices | None
|
|
_Unset
|
serialization_alias |
str | None
|
|
_Unset
|
title |
str | None
|
人間が読めるタイトル。 |
_Unset
|
field_title_generator |
Callable[[str, FieldInfo], str] | None
|
フィールド名を受け取り、そのタイトルを返す呼び出し可能オブジェクト。 |
_Unset
|
description |
str | None
|
人間が読める形式の説明。 |
_Unset
|
examples |
list[Any] | None
|
このフィールドの値の例。 |
_Unset
|
exclude |
bool | None
|
モデルのシリアライゼーションからフィールドを除外するかどうか。 |
_Unset
|
discriminator |
str | Discriminator | None
|
タグ付き共用体の型を識別するためのフィールド名または識別子。 |
_Unset
|
deprecated |
Deprecated | str | bool | None
|
非推奨メッセージ、 |
_Unset
|
json_schema_extra |
JsonDict | Callable[[JsonDict], None] | None
|
追加のJSONスキーマ・プロパティーを提供するためのdictまたはcallable。 |
_Unset
|
frozen |
bool | None
|
フィールドが凍結されているかどうか。TRUEの場合、インスタンスの値を変更しようとするとエラーが発生します。 |
_Unset
|
validate_default |
bool | None
|
|
_Unset
|
repr |
bool
|
フィールドを |
_Unset
|
init |
bool | None
|
フィールドをデータクラスのコンストラクタに含めるかどうかを指定します(データクラスにのみ適用されます)。 |
_Unset
|
init_var |
bool | None
|
データ・クラスのコンストラクタにフィールドを含めるかどうか(データ・クラスにのみ適用)。 |
_Unset
|
kw_only |
bool | None
|
データクラスのコンストラクタで、フィールドをキーワードのみの引数にするかどうかを指定します(データクラスにのみ適用されます)。 |
_Unset
|
coerce_numbers_to_str |
bool | None
|
|
_Unset
|
strict |
bool | None
|
|
_Unset
|
gt |
SupportsGt | None
|
より大きい。設定する場合、値はこれより大きい必要があります。数値にのみ適用できます。 |
_Unset
|
ge |
SupportsGe | None
|
以上。設定する場合、値はこれ以上である必要があります。数値にのみ適用できます。 |
_Unset
|
lt |
SupportsLt | None
|
より小さい。設定する場合、値はこれより小さくする必要があります。数値にのみ適用できます。 |
_Unset
|
le |
SupportsLe | None
|
以下です。設定する場合、値はこれ以下である必要があります。数値にのみ適用できます。 |
_Unset
|
multiple_of |
float | None
|
値はこのの倍数である必要があります。数値にのみ適用できます。 |
_Unset
|
min_length |
int | None
|
iterableの最小長。 |
_Unset
|
max_length |
int | None
|
iterableの最大長。 |
_Unset
|
pattern |
str | Pattern[str] | None
|
文字列のパターン(正規表現)。 |
_Unset
|
allow_inf_nan |
bool | None
|
|
_Unset
|
max_digits |
int | None
|
文字列の最大許容桁数。 |
_Unset
|
decimal_places |
int | None
|
数値の小数点以下の最大桁数。 |
_Unset
|
union_mode |
Literal['smart', 'left_to_right']
|
共用体を検証するときに適用される方式。 |
_Unset
|
fail_fast |
bool | None
|
|
_Unset
|
extra |
Unpack[_EmptyKwargs]
|
(非推奨)JSONスキーマに含まれる追加フィールド。 Warning
|
{}
|
Returns:
Type | Description |
---|---|
Any
|
新しい |
Source code in pydantic/fields.py
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 |
|
FieldInfo ¶
FieldInfo(**kwargs: Unpack[_FieldInfoInputs])
Bases: Representation
このクラスはフィールドに関する情報を保持します。
FieldInfo
は、Field()
関数が明示的に使用されているかどうかにかかわらず、すべてのフィールド定義に使用されます。
Warning
一般的にはFieldInfo
を直接作成すべきではありません。BaseModel
.model_fields
内部にアクセスするときにのみ使用する必要があります。
Attributes:
Name | Type | Description |
---|---|---|
annotation |
type[Any] | None
|
フィールドの型注釈。 |
default |
Any
|
フィールドのデフォルト値。 |
default_factory |
Callable[[], Any] | None
|
フィールドのデフォルトを構成するために使用されるファクトリ関数。 |
alias |
str | None
|
フィールドのエイリアス名。 |
alias_priority |
int | None
|
フィールドのエイリアスの優先度。 |
validation_alias |
str | AliasPath | AliasChoices | None
|
フィールドの検証エイリアス。 |
serialization_alias |
str | None
|
フィールドのシリアル化エイリアス。 |
title |
str | None
|
フィールドのタイトル。 |
field_title_generator |
Callable[[str, FieldInfo], str] | None
|
フィールド名を受け取り、そのタイトルを返す呼び出し可能オブジェクト。 |
description |
str | None
|
フィールドの説明。 |
examples |
list[Any] | None
|
フィールドの例のリスト。 |
exclude |
bool | None
|
モデルのシリアライゼーションからフィールドを除外するかどうか。 |
discriminator |
str | Discriminator | None
|
タグ付き共用体の型を識別するためのフィールド名または識別子。 |
deprecated |
Deprecated | str | bool | None
|
非推奨メッセージ、 |
json_schema_extra |
JsonDict | Callable[[JsonDict], None] | None
|
追加のJSONスキーマ・プロパティーを提供するためのdictまたはcallable。 |
frozen |
bool | None
|
フィールドが凍結されているかどうか。 |
validate_default |
bool | None
|
フィールドのデフォルト値を検証するかどうか。 |
repr |
bool
|
モデルの表現にフィールドを含めるかどうか。 |
init |
bool | None
|
フィールドをデータクラスのコンストラクタに含めるかどうか。 |
init_var |
bool | None
|
フィールドがデータ・クラスのコンストラクターに含まれ、保管されないようにするかどうか。 |
kw_only |
bool | None
|
データクラスのコンストラクタで、フィールドをキーワードのみの引数にするかどうか。 |
metadata |
list[Any]
|
メタデータ制約のリスト。 |
期待される引数の詳細については、pydantic.fields.Field
のシグネチャを参照してください。
Source code in pydantic/fields.py
195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 |
|
from_field
staticmethod
¶
Field
関数を使用して新しいFieldInfo
オブジェクトを作成します。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
default |
Any
|
フィールドのデフォルト値。デフォルトは"未定義"です。 |
PydanticUndefined
|
**kwargs |
Unpack[_FromFieldInfoInputs]
|
追加引数の辞書。 |
{}
|
Raises:
Type | Description |
---|---|
TypeError
|
'annotation'がキーワード引数として渡された場合。 |
Returns:
Type | Description |
---|---|
FieldInfo
|
指定されたパラメータを持つ新しいFieldInfoオブジェクト。 |
Example
次のようにして、デフォルト値を持つフィールドを作成できます。
import pydantic
class MyModel(pydantic.BaseModel):
foo: int = pydantic.Field(4)
Source code in pydantic/fields.py
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 |
|
from_annotation
staticmethod
¶
生の注釈からFieldInfo
インスタンスを作成します。
この関数は、次のような生の注釈からFieldInfo
を作成するために内部的に使用されます。
import pydantic
class MyModel(pydantic.BaseModel):
foo: int # <-- like this
また、注釈がAnnotated
のインスタンスである可能性があり、Annotated
の(最初ではない)引数の1つがFieldInfo
のインスタンスである場合についても説明します。次に例を示します。
import annotated_types
from typing_extensions import Annotated
import pydantic
class MyModel(pydantic.BaseModel):
foo: Annotated[int, annotated_types.Gt(42)]
bar: Annotated[int, pydantic.Field(gt=42)]
Parameters:
Name | Type | Description | Default |
---|---|---|---|
annotation |
type[Any]
|
注釈オブジェクト。 |
required |
Returns:
Type | Description |
---|---|
FieldInfo
|
フィールドメタデータのインスタンス。 |
Source code in pydantic/fields.py
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 |
|
from_annotated_attribute
staticmethod
¶
デフォルト値を持つ注釈からFieldInfo
を作成します。
これは、次のような場合に使用されます。
import annotated_types
from typing_extensions import Annotated
import pydantic
class MyModel(pydantic.BaseModel):
foo: int = 4 # <-- like this
bar: Annotated[int, annotated_types.Gt(4)] = 4 # <-- or this
spam: Annotated[int, pydantic.Field(gt=4)] = 4 # <-- or this
Parameters:
Name | Type | Description | Default |
---|---|---|---|
annotation |
type[Any]
|
フィールドの型注釈。 |
required |
default |
Any
|
フィールドのデフォルト値。 |
required |
Returns:
Type | Description |
---|---|
FieldInfo
|
渡された値を持つフィールド・オブジェクト。 |
Source code in pydantic/fields.py
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 |
|
merge_field_infos
staticmethod
¶
明示的に設定された属性のみを保持してFieldInfo
インスタンスをマージします。
後のFieldInfo
インスタンスは前のインスタンスを上書きします。
Returns:
Name | Type | Description |
---|---|---|
FieldInfo |
FieldInfo
|
マージされたFieldInfoインスタンス。 |
Source code in pydantic/fields.py
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 |
|
get_default ¶
デフォルト値を取得します。
default_factoryを呼び出すと、回避したい副作用が発生する可能性があるため、default_factory(存在する場合)を呼び出すかどうかのオプションを公開します。ただし、実際に呼び出す必要がある場合もあります(つまり、model_construct
を使用してモデルをインスタンス化する場合)。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
call_default_factory |
bool
|
default_factoryを呼び出すかどうか。デフォルトは |
False
|
Returns:
Type | Description |
---|---|
Any
|
デフォルト値。要求された場合はデフォルトのファクトリを呼び出し、設定されていない場合は |
Source code in pydantic/fields.py
550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 |
|
is_required ¶
is_required() -> bool
フィールドが必要かどうかをチェックしてください(デフォルト値またはファクトリがないなど)。
Returns:
Type | Description |
---|---|
bool
|
フィールドが必要な場合は |
Source code in pydantic/fields.py
568 569 570 571 572 573 574 |
|
rebuild_annotation ¶
rebuild_annotation() -> Any
関数シグネチャで使用するために元の注釈を再構築しようとします。
メタデータが存在する場合は、Annotated
を使用して元の注釈に追加します。存在しない場合は、元の注釈をそのまま返します。
メタデータがフラット化されているため、元の型に認識されないアノテーションがあったり、pydantic.Field
を呼び出してアノテーションが付けられたりした場合など、元のアノテーションが元のまま正確に再構築されない可能性があることに注意してください。
Returns:
Type | Description |
---|---|
Any
|
再構築された注釈。 |
Source code in pydantic/fields.py
576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 |
|
apply_typevars_map ¶
apply_typevars_map(
typevars_map: dict[Any, Any] | None,
types_namespace: dict[str, Any] | None,
) -> None
注釈にtypevars_map
を適用してください。
このメソッドは、パラメータ化されたジェネリック型を分析して、型変数を具体的な型に置き換えるときに使用されます。
このメソッドは、typevars_map
をアノテーションにインプレイスで適用します。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
typevars_map |
dict[Any, Any] | None
|
型変数をその具象型にマップする辞書。 |
required |
types_namespace |
dict[str, Any] | None
|
アノテーションが付けられた型に関連する型を含む辞書。 |
required |
See Also
pydantic._internal._generics.replace_typesは、typevarを具象型に置き換えるために使用されます。
Source code in pydantic/fields.py
592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 |
|
PrivateAttr ¶
PrivateAttr(
default: Any = PydanticUndefined,
*,
default_factory: Callable[[], Any] | None = None,
init: Literal[False] = False
) -> Any
Usage Documentation
属性がプライベートに使用され、通常の検証/シリアライゼーションでは処理されないことを示します。
private属性はPydanticによって検証されないため、タイプセーフな方法で使用するかどうかはユーザー次第です。
プライベート属性は、モデルの__private_attributes__
に保存されます。
Parameters:
Name | Type | Description | Default |
---|---|---|---|
default |
Any
|
属性のデフォルト値。デフォルトは"未定義"です。 |
PydanticUndefined
|
default_factory |
Callable[[], Any] | None
|
この属性にデフォルト値が必要な場合に呼び出される呼び出し可能オブジェクト。 |
None
|
init |
Literal[False]
|
属性をデータクラスのコンストラクタに含めるかどうか。常に |
False
|
Returns:
Type | Description |
---|---|
Any
|
|
Raises:
Type | Description |
---|---|
ValueError
|
|
Source code in pydantic/fields.py
935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 |
|
ModelPrivateAttr ¶
ModelPrivateAttr(
default: Any = PydanticUndefined,
*,
default_factory: Callable[[], Any] | None = None
)
Bases: Representation
クラスモデル内のプライベート属性の記述子。
Warning
一般的に、ModelPrivateAttr
インスタンスを直接作成すべきではなく、代わりにpydantic.fields.PrivateAttr
を使用してください(これはFieldInfo
とField
に似ています)。
Attributes:
Name | Type | Description |
---|---|---|
default |
属性のデフォルト値(指定されていない場合)。 |
|
default_factory |
指定されていない場合に属性のデフォルト値を生成する、呼び出し可能な関数。 |
Source code in pydantic/fields.py
889 890 891 892 893 |
|
get_default ¶
get_default() -> Any
オブジェクトのデフォルト値を取得します。
self.default_factory
がNone
の場合、このメソッドはself.default
オブジェクトのディープコピーを返します。
self.default_factory
がNone
でない場合、self.default_factory
を呼び出し、返された値を返します。
Returns:
Type | Description |
---|---|
Any
|
オブジェクトのデフォルト値。 |
Source code in pydantic/fields.py
916 917 918 919 920 921 922 923 924 925 926 |
|
computed_field ¶
computed_field(
func: PropertyT | None = None,
/,
*,
alias: str | None = None,
alias_priority: int | None = None,
title: str | None = None,
field_title_generator: (
Callable[[str, ComputedFieldInfo], str] | None
) = None,
description: str | None = None,
deprecated: Deprecated | str | bool | None = None,
examples: list[Any] | None = None,
json_schema_extra: (
JsonDict | Callable[[JsonDict], None] | None
) = None,
repr: bool | None = None,
return_type: Any = PydanticUndefined,
) -> PropertyT | Callable[[PropertyT], PropertyT]
Usage Documentation
モデルまたはデータクラスをシリアライズするときにproperty
とcached_property
を含めるデコレータ。
これは、他のフィールドから計算されるフィールドや、計算にコストがかかり、キャッシュする必要があるフィールドに便利です。
from pydantic import BaseModel, computed_field
class Rectangle(BaseModel):
width: int
length: int
@computed_field
@property
def area(self) -> int:
return self.width * self.length
print(Rectangle(width=3, length=2).model_dump())
#> {'width': 3, 'length': 2, 'area': 6}
@property
または@cached_property
でデコレートされていない関数に適用すると、その関数は自動的にproperty
でラップされます。
これはより簡潔ですが、IDE内のIntelliSenseが失われ、静的型チェッカーが混乱するため、@property
を明示的に使用することをお勧めします。
Mypy Warning
@computed_field
の前に@property
または@cached_property
を関数に適用しても、mypyはDecorated property not supported
エラーをスローすることがあります。
詳細については、mypy issue #1362を参照してください。
このエラーメッセージを回避するには、@computed_field
行に#type:ignore[misc]
を追加してください。
pyrightはエラーなしで@computed_field
をサポートしています。
import random
from pydantic import BaseModel, computed_field
class Square(BaseModel):
width: float
@computed_field
def area(self) -> float: # converted to a `property` by `computed_field`
return round(self.width**2, 2)
@area.setter
def area(self, new_area: float) -> None:
self.width = new_area**0.5
@computed_field(alias='the magic number', repr=False)
def random_number(self) -> int:
return random.randint(0, 1_000)
square = Square(width=1.3)
# `random_number` does not appear in representation
print(repr(square))
#> Square(width=1.3, area=1.69)
print(square.random_number)
#> 3
square.area = 4
print(square.model_dump_json(by_alias=True))
#> {"width":2.0,"area":4.0,"the magic number":3}
Overriding with computed_field
親クラスのフィールドを子クラスのcomputed_field
で上書きすることはできません。
mypy
は許可されていればこのふるまいは許しませんし、dataclasses
もこのパターンを許可していません。
次の例を参照してください。
from pydantic import BaseModel, computed_field
class Parent(BaseModel):
a: str
try:
class Child(Parent):
@computed_field
@property
def a(self) -> str:
return 'new a'
except ValueError as e:
print(repr(e))
#> ValueError("you can't override a field with a computed field")
@computed_field
でデコレートされたプライベートプロパティは、デフォルトでrepr=False
です。
from functools import cached_property
from pydantic import BaseModel, computed_field
class Model(BaseModel):
foo: int
@computed_field
@cached_property
def _private_cached_property(self) -> int:
return -self.foo
@computed_field
@property
def _private_property(self) -> int:
return -self.foo
m = Model(foo=1)
print(repr(m))
#> M(foo=1)
Parameters:
Name | Type | Description | Default |
---|---|---|---|
func |
PropertyT | None
|
ラップする関数。 |
None
|
alias |
str | None
|
この計算フィールドをシリアライズするときに使用するエイリアス。 |
None
|
alias_priority |
int | None
|
別名の優先度。これは、別名ジェネレータを使用するかどうかに影響します。 |
None
|
title |
str | None
|
この計算フィールドをJSONスキーマに含めるときに使用するタイトル |
None
|
field_title_generator |
Callable[[str, ComputedFieldInfo], str] | None
|
フィールド名を受け取り、そのタイトルを返す呼び出し可能オブジェクト。 |
None
|
description |
str | None
|
この計算フィールドをJSONスキーマに含めるときに使用する説明。デフォルトは関数のdocstringです。 |
None
|
deprecated |
Deprecated | str | bool | None
|
非推奨メッセージ(または |
None
|
examples |
list[Any] | None
|
この計算フィールドをJSONスキーマに含める場合に使用する値の例 |
None
|
json_schema_extra |
JsonDict | Callable[[JsonDict], None] | None
|
追加のJSONスキーマ・プロパティーを提供するためのdictまたはcallable。 |
None
|
repr |
bool | None
|
この計算済みフィールドをモデルreprに含めるかどうか。デフォルトは、プライベートプロパティの場合は |
None
|
return_type |
Any
|
JSONへのシリアライズ時に期待されるシリアライズロジックのオプションの戻り値。これが含まれている場合は正しくなければなりません。含まれていない場合は |
PydanticUndefined
|
Returns:
Type | Description |
---|---|
PropertyT | Callable[[PropertyT], PropertyT]
|
プロパティのプロキシラッパー。 |
Source code in pydantic/fields.py
1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 |
|
ComputedFieldInfo
dataclass
¶
ComputedFieldInfo(
wrapped_property: property,
return_type: Any,
alias: str | None,
alias_priority: int | None,
title: str | None,
field_title_generator: (
Callable[[str, ComputedFieldInfo], str] | None
),
description: str | None,
deprecated: Deprecated | str | bool | None,
examples: list[Any] | None,
json_schema_extra: (
JsonDict | Callable[[JsonDict], None] | None
),
repr: bool,
)
pydantic-coreスキーマを構築する際にアクセスできるように、@computed_field
からのデータのコンテナ。
Attributes:
Name | Type | Description |
---|---|---|
decorator_repr |
str
|
デコレータ文字列'@computed_field'を表すクラス変数。 |
wrapped_property |
property
|
ラップされた計算結果フィールド・プロパティ。 |
return_type |
Any
|
計算フィールド・プロパティの戻り値の型。 |
alias |
str | None
|
シリアライズ中に使用されるプロパティのエイリアス。 |
alias_priority |
int | None
|
別名の優先度。これは、別名ジェネレータを使用するかどうかに影響します。 |
title |
str | None
|
シリアライゼーションJSONスキーマに含める計算フィールドのタイトル。 |
field_title_generator |
Callable[[str, ComputedFieldInfo], str] | None
|
フィールド名を受け取り、そのタイトルを返す呼び出し可能オブジェクト。 |
description |
str | None
|
シリアライゼーションJSONスキーマに含める計算フィールドの説明。 |
deprecated |
Deprecated | str | bool | None
|
非推奨メッセージ、 |
examples |
list[Any] | None
|
シリアライズJSONスキーマに含める計算結果フィールドの値の例。 |
json_schema_extra |
JsonDict | Callable[[JsonDict], None] | None
|
追加のJSONスキーマ・プロパティーを提供するためのdictまたはcallable。 |
repr |
bool
|
__repr__出力にフィールドを含めるかどうかを示すブール値。 |