Class ForeignObject

Declaration

Documentation

Methods

• ▶ def __init__(self, to, on_delete, from_fields, to_fields, rel=None, related_name=None, ...) override

  def __init__(

  self,

  to,

  on_delete,

  from_fields,

  to_fields,

  rel=None,

  related_name=None,

  related_query_name=None,

  limit_choices_to=None,

  parent_link=False,

  swappable=True,

  **kwargs,

  )

  source link

  This method overrides django.db.models.fields.Field.__init__.

  Overrides

  This method is overriden in:

  • django.contrib.contenttypes.fields.GenericRelation
  • django.db.models.fields.related.ForeignKey
• ▶ def check(self, **kwargs) override

  source link

  This method overrides django.db.models.fields.related.RelatedField.check.

  Overrides

  This method is overriden in:

  • django.contrib.contenttypes.fields.GenericRelation
  • django.db.models.fields.related.ForeignKey
• ▶ def contribute_to_class(self, cls, name, private_only=False, **kwargs) override

  inherited doc Register the field with the model class it belongs to.

  source link

  This method overrides django.db.models.fields.related.RelatedField.contribute_to_class.

  If private_only is True, create a separate instance of this field
  for every subclass of cls, even if cls is not an abstract model.

  Overrides

  This method is overriden in:

  • django.contrib.contenttypes.fields.GenericRelation
• ▶ def contribute_to_related_class(self, cls, related)

  source link

  Overrides

  This method is overriden in:

  • django.db.models.fields.related.ForeignKey
• ▶ def deconstruct(self) override

  inherited doc Return enough information to recreate the field as a 4-tuple:

  source link

  This method overrides django.db.models.fields.related.RelatedField.deconstruct.

  * The name of the field on the model, if contribute_to_class() has
     been run.
   * The import path of the field, including the class:e.g.
     django.db.models.IntegerField This should be the most portable
     version, so less specific may be better.
   * A list of positional arguments.
   * A dict of keyword arguments.
  
  Note that the positional or keyword arguments must contain values of
  the following types (including inner values of collection types):
  
   * None, bool, str, int, float, complex, set, frozenset, list, tuple,
     dict
   * UUID
   * datetime.datetime (naive), datetime.date
   * top-level classes, top-level functions - will be referenced by their
     full import path
   * Storage instances - these have their own deconstruct() method
  
  This is because the values here must be serialized into a text format
  (possibly new Python code, possibly JSON) and these are the only types
  with encoding handlers defined.
  
  There's no need to return the exact way the field was instantiated this
  time, just ensure that the resulting field is the same - prefer keyword
  arguments over positional ones, and omit parameters with their default
  values.

  Overrides

  This method is overriden in:

  • django.db.models.fields.related.ForeignKey
• ▷ def foreign_related_fields(self) @cached_property

  @cached_property
  def foreign_related_fields(self)

  source link
• ▶ def get_attname_column(self) override

  source link

  This method overrides django.db.models.fields.Field.get_attname_column.

  Overrides

  This method is overriden in:

  • django.db.models.fields.related.ForeignKey
• ▶ def get_extra_descriptor_filter(self, instance)

  Return an extra filter condition for related object fetching when user does 'instance.fieldname', that is the extra filter is used in the descriptor of the field.

  source link

  The filter should be either a dict usable in .filter(**kwargs) call or
  a Q-object. The condition will be ANDed together with the relation's
  joining columns.
  
  A parallel method is get_extra_restriction() which is used in
  JOIN and subquery conditions.

• ▶ def get_extra_restriction(self, where_class, alias, related_alias)

  Return a pair condition used for joining and subquery pushdown. The condition is something that responds to as_sql(compiler, connection) method.

  source link

  Note that currently referring both the 'alias' and 'related_alias'
  will not work in some conditions, like subquery pushdown.
  
  A parallel method is get_extra_descriptor_filter() which is used in
  instance.fieldname related object fetching.

  Overrides

  This method is overriden in:

  • django.contrib.contenttypes.fields.GenericRelation
• ▷ def get_foreign_related_value(self, instance)

  source link
• ▷ def get_joining_columns(self, reverse_join=False)

  source link
• ▷ def get_local_related_value(self, instance)

  source link
• ▶ def get_path_info(self, filtered_relation=None)

  Get path from this field to the related model.

  source link

  Overrides

  This method is overriden in:

  • django.contrib.contenttypes.fields.GenericRelation
• ▷ def get_reverse_joining_columns(self)

  source link
• ▶ def get_reverse_path_info(self, filtered_relation=None)

  Get path from the related model to this field's model.

  source link

  Overrides

  This method is overriden in:

  • django.contrib.contenttypes.fields.GenericRelation
  • django.db.models.fields.related.ForeignKey
• ▷ def local_related_fields(self) @cached_property

  @cached_property
  def local_related_fields(self)

  source link
• ▷ def related_fields(self) @cached_property

  @cached_property
  def related_fields(self)

  source link
• ▶ def resolve_related_fields(self)

  source link

  Overrides

  This method is overriden in:

  • django.contrib.contenttypes.fields.GenericRelation
  • django.db.models.fields.related.ForeignKey
• ▷ def reverse_related_fields(self) @cached_property

  @cached_property
  def reverse_related_fields(self)

  source link

Class methods

• ▷ def get_instance_value_for_fields(instance, fields) @staticmethod

  @staticmethod
  def get_instance_value_for_fields(

  instance,

  fields,

  )

  source link
• ▶ def get_lookups(cls) override @classmethod @functools.lru_cache(maxsize=None)

  @classmethod
  @functools.lru_cache(maxsize=None)
  def get_lookups(cls)

  source link

  This method overrides django.db.models.query_utils.RegisterLookupMixin.get_lookups.

Inherited methods

• Methods inherited from django.db.models.fields.related.RelatedField:
  db_type, do_related_class, formfield, get_cache_name, get_forward_related_filter, get_limit_choices_to, get_reverse_related_filter, related_model, related_query_name, set_attributes_from_rel, swappable_setting, target_field
• Methods inherited from django.db.models.fields.mixins.FieldCacheMixin:
  delete_cached_value, get_cached_value, is_cached, set_cached_value
• Methods inherited from django.db.models.fields.Field:
  __copy__, __deepcopy__, __eq__, __hash__, __lt__, __reduce__, __repr__, __str__, cached_col, cast_db_type, clean, clone, db_check, db_parameters, db_returning, db_tablespace, db_type_parameters, db_type_suffix, get_attname, get_choices, get_col, get_db_converters, get_db_prep_save, get_db_prep_value, get_default, get_filter_kwargs_for_object, get_internal_type, get_pk_value_on_save, get_prep_value, has_default, pre_save, rel_db_type, run_validators, save_form_data, select_format, set_attributes_from_name, to_python, unique, validate, validators, value_from_object, value_to_string
• Methods inherited from django.db.models.query_utils.RegisterLookupMixin:
  get_lookup, get_transform, merge_dicts, register_lookup

Subclasses

• django.contrib.contenttypes.fields.GenericRelation
• django.db.models.fields.related.ForeignKey

Reexports

• Imported in django.contrib.contenttypes.fields.
• Imported in django.db.models.

Generated by nedoc v0.9 at 2020-12-29 14:04