Function
composite
lib/sqlalchemy/orm/_orm_constructors.py:635–656
· lib/sqlalchemy/orm/_orm_constructors.py::composite
(
_class_or_attr: _CompositeAttrType[Any],
/,
*attrs: _CompositeAttrType[Any],
group: Optional[str] = None,
deferred: bool = False,
raiseload: bool = False,
return_none_on: Union[_NoArg, None, Callable[..., bool]] = _NoArg.NO_ARG,
comparator_factory: Optional[Type[Composite.Comparator[_T]]] = None,
active_history: bool = False,
init: Union[_NoArg, bool] = _NoArg.NO_ARG,
repr: Union[_NoArg, bool] = _NoArg.NO_ARG, # noqa: A002
default: Optional[Any] = _NoArg.NO_ARG,
default_factory: Union[_NoArg, Callable[[], _T]] = _NoArg.NO_ARG,
compare: Union[_NoArg, bool] = _NoArg.NO_ARG,
kw_only: Union[_NoArg, bool] = _NoArg.NO_ARG,
hash: Union[_NoArg, bool, None] = _NoArg.NO_ARG, # noqa: A002
info: Optional[_InfoType] = None,
doc: Optional[str] = None,
dataclass_metadata: Union[_NoArg, Mapping[Any, Any], None] = _NoArg.NO_ARG,
**__kw: Any,
)
Source from the content-addressed store, hash-verified
| 633 | |
| 634 | @overload |
| 635 | def composite( |
| 636 | _class_or_attr: _CompositeAttrType[Any], |
| 637 | /, |
| 638 | *attrs: _CompositeAttrType[Any], |
| 639 | group: Optional[str] = None, |
| 640 | deferred: bool = False, |
| 641 | raiseload: bool = False, |
| 642 | return_none_on: Union[_NoArg, None, Callable[..., bool]] = _NoArg.NO_ARG, |
| 643 | comparator_factory: Optional[Type[Composite.Comparator[_T]]] = None, |
| 644 | active_history: bool = False, |
| 645 | init: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 646 | repr: Union[_NoArg, bool] = _NoArg.NO_ARG, class="cm"># noqa: A002 |
| 647 | default: Optional[Any] = _NoArg.NO_ARG, |
| 648 | default_factory: Union[_NoArg, Callable[[], _T]] = _NoArg.NO_ARG, |
| 649 | compare: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 650 | kw_only: Union[_NoArg, bool] = _NoArg.NO_ARG, |
| 651 | hash: Union[_NoArg, bool, None] = _NoArg.NO_ARG, class="cm"># noqa: A002 |
| 652 | info: Optional[_InfoType] = None, |
| 653 | doc: Optional[str] = None, |
| 654 | dataclass_metadata: Union[_NoArg, Mapping[Any, Any], None] = _NoArg.NO_ARG, |
| 655 | **__kw: Any, |
| 656 | ) -> Composite[Any]: ... |
| 657 | |
| 658 | |
| 659 | @overload |