4.7 KiB
models.helpers.relations
register_relation_on_build
register_relation_on_build(field: "ForeignKeyField") -> None
Registers ForeignKey relation in alias_manager to set a table_prefix. Registration include also reverse relation side to be able to join both sides.
Relation is registered by model name and relation field name to allow for multiple relations between two Models that needs to have different aliases for proper sql joins.
Arguments:
field(ForeignKey class): relation field
register_many_to_many_relation_on_build
register_many_to_many_relation_on_build(field: "ManyToManyField") -> None
Registers connection between through model and both sides of the m2m relation. Registration include also reverse relation side to be able to join both sides.
Relation is registered by model name and relation field name to allow for multiple relations between two Models that needs to have different aliases for proper sql joins.
By default relation name is a model.name.lower().
Arguments:
field(ManyToManyField class): relation field
expand_reverse_relationship
expand_reverse_relationship(model_field: "ForeignKeyField") -> None
If the reverse relation has not been set before it's set here.
Arguments:
model_field:
Returns:
None: None
expand_reverse_relationships
expand_reverse_relationships(model: Type["Model"]) -> None
Iterates through model_fields of given model and verifies if all reverse relation have been populated on related models.
If the reverse relation has not been set before it's set here.
Arguments:
model(Model class): model on which relation should be checked and registered
register_reverse_model_fields
register_reverse_model_fields(model_field: "ForeignKeyField") -> None
Registers reverse ForeignKey field on related model. By default it's name.lower()+'s' of the model on which relation is defined.
But if the related_model name is provided it's registered with that name. Autogenerated reverse fields also set related_name to the original field name.
Arguments:
model_field(relation Field): original relation ForeignKey field
register_through_shortcut_fields
register_through_shortcut_fields(model_field: "ManyToManyField") -> None
Registers m2m relation through shortcut on both ends of the relation.
Arguments:
model_field(ManyToManyField): relation field defined in parent model
register_relation_in_alias_manager
register_relation_in_alias_manager(field: "ForeignKeyField") -> None
Registers the relation (and reverse relation) in alias manager. The m2m relations require registration of through model between actual end models of the relation.
Delegates the actual registration to: m2m - register_many_to_many_relation_on_build fk - register_relation_on_build
Arguments:
field(ForeignKey or ManyToManyField class): relation field
verify_related_name_dont_duplicate
verify_related_name_dont_duplicate(related_name: str, model_field: "ForeignKeyField") -> None
Verifies whether the used related_name (regardless of the fact if user defined or auto generated) is already used on related model, but is connected with other model than the one that we connect right now.
Raises:
ModelDefinitionError: if name is already used but lead to different related model
Arguments:
related_name:model_field(relation Field): original relation ForeignKey field
Returns:
None: None
reverse_field_not_already_registered
reverse_field_not_already_registered(model_field: "ForeignKeyField") -> bool
Checks if child is already registered in parents pydantic fields.
Raises:
ModelDefinitionError: if related name is already used but lead to different related model
Arguments:
model_field(relation Field): original relation ForeignKey field
Returns:
bool: result of the check