12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306 |
- from __future__ import unicode_literals
- from operator import attrgetter
- from django.apps import apps
- from django.core import checks
- from django.db import connection, connections, router, transaction
- from django.db.backends import utils
- from django.db.models import signals, Q
- from django.db.models.deletion import SET_NULL, SET_DEFAULT, CASCADE
- from django.db.models.fields import (AutoField, Field, IntegerField,
- PositiveIntegerField, PositiveSmallIntegerField, FieldDoesNotExist)
- from django.db.models.lookups import IsNull
- from django.db.models.related import RelatedObject, PathInfo
- from django.db.models.query import QuerySet
- from django.db.models.sql.datastructures import Col
- from django.utils.encoding import smart_text
- from django.utils import six
- from django.utils.deprecation import RenameMethodsBase, RemovedInDjango18Warning
- from django.utils.translation import ugettext_lazy as _
- from django.utils.functional import curry, cached_property
- from django.core import exceptions
- from django import forms
- RECURSIVE_RELATIONSHIP_CONSTANT = 'self'
- def add_lazy_relation(cls, field, relation, operation):
- """
- Adds a lookup on ``cls`` when a related field is defined using a string,
- i.e.::
- class MyModel(Model):
- fk = ForeignKey("AnotherModel")
- This string can be:
- * RECURSIVE_RELATIONSHIP_CONSTANT (i.e. "self") to indicate a recursive
- relation.
- * The name of a model (i.e "AnotherModel") to indicate another model in
- the same app.
- * An app-label and model name (i.e. "someapp.AnotherModel") to indicate
- another model in a different app.
- If the other model hasn't yet been loaded -- almost a given if you're using
- lazy relationships -- then the relation won't be set up until the
- class_prepared signal fires at the end of model initialization.
- operation is the work that must be performed once the relation can be resolved.
- """
- # Check for recursive relations
- if relation == RECURSIVE_RELATIONSHIP_CONSTANT:
- app_label = cls._meta.app_label
- model_name = cls.__name__
- else:
- # Look for an "app.Model" relation
- if isinstance(relation, six.string_types):
- try:
- app_label, model_name = relation.split(".")
- except ValueError:
- # If we can't split, assume a model in current app
- app_label = cls._meta.app_label
- model_name = relation
- else:
- # it's actually a model class
- app_label = relation._meta.app_label
- model_name = relation._meta.object_name
- # Try to look up the related model, and if it's already loaded resolve the
- # string right away. If get_model returns None, it means that the related
- # model isn't loaded yet, so we need to pend the relation until the class
- # is prepared.
- try:
- model = cls._meta.apps.get_registered_model(app_label, model_name)
- except LookupError:
- key = (app_label, model_name)
- value = (cls, field, operation)
- cls._meta.apps._pending_lookups.setdefault(key, []).append(value)
- else:
- operation(field, model, cls)
- def do_pending_lookups(sender, **kwargs):
- """
- Handle any pending relations to the sending model. Sent from class_prepared.
- """
- key = (sender._meta.app_label, sender.__name__)
- for cls, field, operation in sender._meta.apps._pending_lookups.pop(key, []):
- operation(field, sender, cls)
- signals.class_prepared.connect(do_pending_lookups)
- class RelatedField(Field):
- def check(self, **kwargs):
- errors = super(RelatedField, self).check(**kwargs)
- errors.extend(self._check_relation_model_exists())
- errors.extend(self._check_referencing_to_swapped_model())
- errors.extend(self._check_clashes())
- return errors
- def _check_relation_model_exists(self):
- rel_is_missing = self.rel.to not in apps.get_models()
- rel_is_string = isinstance(self.rel.to, six.string_types)
- model_name = self.rel.to if rel_is_string else self.rel.to._meta.object_name
- if rel_is_missing and (rel_is_string or not self.rel.to._meta.swapped):
- return [
- checks.Error(
- ("Field defines a relation with model '%s', which "
- "is either not installed, or is abstract.") % model_name,
- hint=None,
- obj=self,
- id='fields.E300',
- )
- ]
- return []
- def _check_referencing_to_swapped_model(self):
- if (self.rel.to not in apps.get_models() and
- not isinstance(self.rel.to, six.string_types) and
- self.rel.to._meta.swapped):
- model = "%s.%s" % (
- self.rel.to._meta.app_label,
- self.rel.to._meta.object_name
- )
- return [
- checks.Error(
- ("Field defines a relation with the model '%s', "
- "which has been swapped out.") % model,
- hint="Update the relation to point at 'settings.%s'." % self.rel.to._meta.swappable,
- obj=self,
- id='fields.E301',
- )
- ]
- return []
- def _check_clashes(self):
- """ Check accessor and reverse query name clashes. """
- from django.db.models.base import ModelBase
- errors = []
- opts = self.model._meta
- # `f.rel.to` may be a string instead of a model. Skip if model name is
- # not resolved.
- if not isinstance(self.rel.to, ModelBase):
- return []
- # If the field doesn't install backward relation on the target model (so
- # `is_hidden` returns True), then there are no clashes to check and we
- # can skip these fields.
- if self.rel.is_hidden():
- return []
- try:
- self.related
- except AttributeError:
- return []
- # Consider that we are checking field `Model.foreign` and the models
- # are:
- #
- # class Target(models.Model):
- # model = models.IntegerField()
- # model_set = models.IntegerField()
- #
- # class Model(models.Model):
- # foreign = models.ForeignKey(Target)
- # m2m = models.ManyToManyField(Target)
- rel_opts = self.rel.to._meta
- # rel_opts.object_name == "Target"
- rel_name = self.related.get_accessor_name() # i. e. "model_set"
- rel_query_name = self.related_query_name() # i. e. "model"
- field_name = "%s.%s" % (opts.object_name,
- self.name) # i. e. "Model.field"
- # Check clashes between accessor or reverse query name of `field`
- # and any other field name -- i. e. accessor for Model.foreign is
- # model_set and it clashes with Target.model_set.
- potential_clashes = rel_opts.fields + rel_opts.many_to_many
- for clash_field in potential_clashes:
- clash_name = "%s.%s" % (rel_opts.object_name,
- clash_field.name) # i. e. "Target.model_set"
- if clash_field.name == rel_name:
- errors.append(
- checks.Error(
- "Reverse accessor for '%s' clashes with field name '%s'." % (field_name, clash_name),
- hint=("Rename field '%s', or add/change a related_name "
- "argument to the definition for field '%s'.") % (clash_name, field_name),
- obj=self,
- id='fields.E302',
- )
- )
- if clash_field.name == rel_query_name:
- errors.append(
- checks.Error(
- "Reverse query name for '%s' clashes with field name '%s'." % (field_name, clash_name),
- hint=("Rename field '%s', or add/change a related_name "
- "argument to the definition for field '%s'.") % (clash_name, field_name),
- obj=self,
- id='fields.E303',
- )
- )
- # Check clashes between accessors/reverse query names of `field` and
- # any other field accessor -- i. e. Model.foreign accessor clashes with
- # Model.m2m accessor.
- potential_clashes = rel_opts.get_all_related_many_to_many_objects()
- potential_clashes += rel_opts.get_all_related_objects()
- potential_clashes = (r for r in potential_clashes
- if r.field is not self)
- for clash_field in potential_clashes:
- clash_name = "%s.%s" % ( # i. e. "Model.m2m"
- clash_field.model._meta.object_name,
- clash_field.field.name)
- if clash_field.get_accessor_name() == rel_name:
- errors.append(
- checks.Error(
- "Reverse accessor for '%s' clashes with reverse accessor for '%s'." % (field_name, clash_name),
- hint=("Add or change a related_name argument "
- "to the definition for '%s' or '%s'.") % (field_name, clash_name),
- obj=self,
- id='fields.E304',
- )
- )
- if clash_field.get_accessor_name() == rel_query_name:
- errors.append(
- checks.Error(
- "Reverse query name for '%s' clashes with reverse query name for '%s'." % (field_name, clash_name),
- hint=("Add or change a related_name argument "
- "to the definition for '%s' or '%s'.") % (field_name, clash_name),
- obj=self,
- id='fields.E305',
- )
- )
- return errors
- def db_type(self, connection):
- '''By default related field will not have a column
- as it relates columns to another table'''
- return None
- def contribute_to_class(self, cls, name, virtual_only=False):
- sup = super(RelatedField, self)
- # Store the opts for related_query_name()
- self.opts = cls._meta
- if hasattr(sup, 'contribute_to_class'):
- sup.contribute_to_class(cls, name, virtual_only=virtual_only)
- if not cls._meta.abstract and self.rel.related_name:
- related_name = self.rel.related_name % {
- 'class': cls.__name__.lower(),
- 'app_label': cls._meta.app_label.lower()
- }
- self.rel.related_name = related_name
- other = self.rel.to
- if isinstance(other, six.string_types) or other._meta.pk is None:
- def resolve_related_class(field, model, cls):
- field.rel.to = model
- field.do_related_class(model, cls)
- add_lazy_relation(cls, self, other, resolve_related_class)
- else:
- self.do_related_class(other, cls)
- @property
- def swappable_setting(self):
- """
- Gets the setting that this is powered from for swapping, or None
- if it's not swapped in / marked with swappable=False.
- """
- if self.swappable:
- # Work out string form of "to"
- if isinstance(self.rel.to, six.string_types):
- to_string = self.rel.to
- else:
- to_string = "%s.%s" % (
- self.rel.to._meta.app_label,
- self.rel.to._meta.object_name,
- )
- # See if anything swapped/swappable matches
- for model in apps.get_models(include_swapped=True):
- if model._meta.swapped:
- if model._meta.swapped == to_string:
- return model._meta.swappable
- if ("%s.%s" % (model._meta.app_label, model._meta.object_name)) == to_string and model._meta.swappable:
- return model._meta.swappable
- return None
- def set_attributes_from_rel(self):
- self.name = self.name or (self.rel.to._meta.model_name + '_' + self.rel.to._meta.pk.name)
- if self.verbose_name is None:
- self.verbose_name = self.rel.to._meta.verbose_name
- self.rel.set_field_name()
- def do_related_class(self, other, cls):
- self.set_attributes_from_rel()
- self.related = RelatedObject(other, cls, self)
- if not cls._meta.abstract:
- self.contribute_to_related_class(other, self.related)
- def get_limit_choices_to(self):
- """Returns 'limit_choices_to' for this model field.
- If it is a callable, it will be invoked and the result will be
- returned.
- """
- if callable(self.rel.limit_choices_to):
- return self.rel.limit_choices_to()
- return self.rel.limit_choices_to
- def formfield(self, **kwargs):
- """Passes ``limit_choices_to`` to field being constructed.
- Only passes it if there is a type that supports related fields.
- This is a similar strategy used to pass the ``queryset`` to the field
- being constructed.
- """
- defaults = {}
- if hasattr(self.rel, 'get_related_field'):
- # If this is a callable, do not invoke it here. Just pass
- # it in the defaults for when the form class will later be
- # instantiated.
- limit_choices_to = self.rel.limit_choices_to
- defaults.update({
- 'limit_choices_to': limit_choices_to,
- })
- defaults.update(kwargs)
- return super(RelatedField, self).formfield(**defaults)
- def related_query_name(self):
- # This method defines the name that can be used to identify this
- # related object in a table-spanning query. It uses the lower-cased
- # object_name by default, but this can be overridden with the
- # "related_name" option.
- return self.rel.related_query_name or self.rel.related_name or self.opts.model_name
- class RenameRelatedObjectDescriptorMethods(RenameMethodsBase):
- renamed_methods = (
- ('get_query_set', 'get_queryset', RemovedInDjango18Warning),
- ('get_prefetch_query_set', 'get_prefetch_queryset', RemovedInDjango18Warning),
- )
- class SingleRelatedObjectDescriptor(six.with_metaclass(RenameRelatedObjectDescriptorMethods)):
- # This class provides the functionality that makes the related-object
- # managers available as attributes on a model class, for fields that have
- # a single "remote" value, on the class pointed to by a related field.
- # In the example "place.restaurant", the restaurant attribute is a
- # SingleRelatedObjectDescriptor instance.
- def __init__(self, related):
- self.related = related
- self.cache_name = related.get_cache_name()
- @cached_property
- def RelatedObjectDoesNotExist(self):
- # The exception isn't created at initialization time for the sake of
- # consistency with `ReverseSingleRelatedObjectDescriptor`.
- return type(
- str('RelatedObjectDoesNotExist'),
- (self.related.model.DoesNotExist, AttributeError),
- {}
- )
- def is_cached(self, instance):
- return hasattr(instance, self.cache_name)
- def get_queryset(self, **hints):
- # Gotcha: we return a `Manager` instance (i.e. not a `QuerySet`)!
- return self.related.model._base_manager.db_manager(hints=hints)
- def get_prefetch_queryset(self, instances, queryset=None):
- if queryset is None:
- # Despite its name `get_queryset()` returns an instance of
- # `Manager`, therefore we call `all()` to normalize to `QuerySet`.
- queryset = self.get_queryset().all()
- queryset._add_hints(instance=instances[0])
- rel_obj_attr = attrgetter(self.related.field.attname)
- instance_attr = lambda obj: obj._get_pk_val()
- instances_dict = dict((instance_attr(inst), inst) for inst in instances)
- query = {'%s__in' % self.related.field.name: instances}
- queryset = queryset.filter(**query)
- # Since we're going to assign directly in the cache,
- # we must manage the reverse relation cache manually.
- rel_obj_cache_name = self.related.field.get_cache_name()
- for rel_obj in queryset:
- instance = instances_dict[rel_obj_attr(rel_obj)]
- setattr(rel_obj, rel_obj_cache_name, instance)
- return queryset, rel_obj_attr, instance_attr, True, self.cache_name
- def __get__(self, instance, instance_type=None):
- if instance is None:
- return self
- try:
- rel_obj = getattr(instance, self.cache_name)
- except AttributeError:
- related_pk = instance._get_pk_val()
- if related_pk is None:
- rel_obj = None
- else:
- params = {}
- for lh_field, rh_field in self.related.field.related_fields:
- params['%s__%s' % (self.related.field.name, rh_field.name)] = getattr(instance, rh_field.attname)
- try:
- rel_obj = self.get_queryset(instance=instance).get(**params)
- except self.related.model.DoesNotExist:
- rel_obj = None
- else:
- setattr(rel_obj, self.related.field.get_cache_name(), instance)
- setattr(instance, self.cache_name, rel_obj)
- if rel_obj is None:
- raise self.RelatedObjectDoesNotExist(
- "%s has no %s." % (
- instance.__class__.__name__,
- self.related.get_accessor_name()
- )
- )
- else:
- return rel_obj
- def __set__(self, instance, value):
- # The similarity of the code below to the code in
- # ReverseSingleRelatedObjectDescriptor is annoying, but there's a bunch
- # of small differences that would make a common base class convoluted.
- # If null=True, we can assign null here, but otherwise the value needs
- # to be an instance of the related class.
- if value is None and self.related.field.null is False:
- raise ValueError(
- 'Cannot assign None: "%s.%s" does not allow null values.' % (
- instance._meta.object_name,
- self.related.get_accessor_name(),
- )
- )
- elif value is not None and not isinstance(value, self.related.model):
- raise ValueError(
- 'Cannot assign "%r": "%s.%s" must be a "%s" instance.' % (
- value,
- instance._meta.object_name,
- self.related.get_accessor_name(),
- self.related.opts.object_name,
- )
- )
- elif value is not None:
- if instance._state.db is None:
- instance._state.db = router.db_for_write(instance.__class__, instance=value)
- elif value._state.db is None:
- value._state.db = router.db_for_write(value.__class__, instance=instance)
- elif value._state.db is not None and instance._state.db is not None:
- if not router.allow_relation(value, instance):
- raise ValueError('Cannot assign "%r": the current database router prevents this relation.' % value)
- related_pk = tuple(getattr(instance, field.attname) for field in self.related.field.foreign_related_fields)
- if None in related_pk:
- raise ValueError(
- 'Cannot assign "%r": "%s" instance isn\'t saved in the database.' %
- (value, instance._meta.object_name)
- )
- # Set the value of the related field to the value of the related object's related field
- for index, field in enumerate(self.related.field.local_related_fields):
- setattr(value, field.attname, related_pk[index])
- # Since we already know what the related object is, seed the related
- # object caches now, too. This avoids another db hit if you get the
- # object you just set.
- setattr(instance, self.cache_name, value)
- setattr(value, self.related.field.get_cache_name(), instance)
- class ReverseSingleRelatedObjectDescriptor(six.with_metaclass(RenameRelatedObjectDescriptorMethods)):
- # This class provides the functionality that makes the related-object
- # managers available as attributes on a model class, for fields that have
- # a single "remote" value, on the class that defines the related field.
- # In the example "choice.poll", the poll attribute is a
- # ReverseSingleRelatedObjectDescriptor instance.
- def __init__(self, field_with_rel):
- self.field = field_with_rel
- self.cache_name = self.field.get_cache_name()
- @cached_property
- def RelatedObjectDoesNotExist(self):
- # The exception can't be created at initialization time since the
- # related model might not be resolved yet; `rel.to` might still be
- # a string model reference.
- return type(
- str('RelatedObjectDoesNotExist'),
- (self.field.rel.to.DoesNotExist, AttributeError),
- {}
- )
- def is_cached(self, instance):
- return hasattr(instance, self.cache_name)
- def get_queryset(self, **hints):
- rel_mgr = self.field.rel.to._default_manager.db_manager(hints=hints)
- # If the related manager indicates that it should be used for
- # related fields, respect that.
- if getattr(rel_mgr, 'use_for_related_fields', False):
- # Gotcha: we return a `Manager` instance (i.e. not a `QuerySet`)!
- return rel_mgr
- else:
- return QuerySet(self.field.rel.to, hints=hints)
- def get_prefetch_queryset(self, instances, queryset=None):
- if queryset is None:
- # Despite its name `get_queryset()` may return an instance of
- # `Manager`, therefore we call `all()` to normalize to `QuerySet`.
- queryset = self.get_queryset().all()
- queryset._add_hints(instance=instances[0])
- rel_obj_attr = self.field.get_foreign_related_value
- instance_attr = self.field.get_local_related_value
- instances_dict = dict((instance_attr(inst), inst) for inst in instances)
- related_field = self.field.foreign_related_fields[0]
- # FIXME: This will need to be revisited when we introduce support for
- # composite fields. In the meantime we take this practical approach to
- # solve a regression on 1.6 when the reverse manager in hidden
- # (related_name ends with a '+'). Refs #21410.
- # The check for len(...) == 1 is a special case that allows the query
- # to be join-less and smaller. Refs #21760.
- if self.field.rel.is_hidden() or len(self.field.foreign_related_fields) == 1:
- query = {'%s__in' % related_field.name: set(instance_attr(inst)[0] for inst in instances)}
- else:
- query = {'%s__in' % self.field.related_query_name(): instances}
- queryset = queryset.filter(**query)
- # Since we're going to assign directly in the cache,
- # we must manage the reverse relation cache manually.
- if not self.field.rel.multiple:
- rel_obj_cache_name = self.field.related.get_cache_name()
- for rel_obj in queryset:
- instance = instances_dict[rel_obj_attr(rel_obj)]
- setattr(rel_obj, rel_obj_cache_name, instance)
- return queryset, rel_obj_attr, instance_attr, True, self.cache_name
- def __get__(self, instance, instance_type=None):
- if instance is None:
- return self
- try:
- rel_obj = getattr(instance, self.cache_name)
- except AttributeError:
- val = self.field.get_local_related_value(instance)
- if None in val:
- rel_obj = None
- else:
- params = dict(
- (rh_field.attname, getattr(instance, lh_field.attname))
- for lh_field, rh_field in self.field.related_fields)
- qs = self.get_queryset(instance=instance)
- extra_filter = self.field.get_extra_descriptor_filter(instance)
- if isinstance(extra_filter, dict):
- params.update(extra_filter)
- qs = qs.filter(**params)
- else:
- qs = qs.filter(extra_filter, **params)
- # Assuming the database enforces foreign keys, this won't fail.
- rel_obj = qs.get()
- if not self.field.rel.multiple:
- setattr(rel_obj, self.field.related.get_cache_name(), instance)
- setattr(instance, self.cache_name, rel_obj)
- if rel_obj is None and not self.field.null:
- raise self.RelatedObjectDoesNotExist(
- "%s has no %s." % (self.field.model.__name__, self.field.name)
- )
- else:
- return rel_obj
- def __set__(self, instance, value):
- # If null=True, we can assign null here, but otherwise the value needs
- # to be an instance of the related class.
- if value is None and self.field.null is False:
- raise ValueError(
- 'Cannot assign None: "%s.%s" does not allow null values.' %
- (instance._meta.object_name, self.field.name)
- )
- elif value is not None and not isinstance(value, self.field.rel.to):
- raise ValueError(
- 'Cannot assign "%r": "%s.%s" must be a "%s" instance.' % (
- value,
- instance._meta.object_name,
- self.field.name,
- self.field.rel.to._meta.object_name,
- )
- )
- elif value is not None:
- if instance._state.db is None:
- instance._state.db = router.db_for_write(instance.__class__, instance=value)
- elif value._state.db is None:
- value._state.db = router.db_for_write(value.__class__, instance=instance)
- elif value._state.db is not None and instance._state.db is not None:
- if not router.allow_relation(value, instance):
- raise ValueError('Cannot assign "%r": the current database router prevents this relation.' % value)
- # If we're setting the value of a OneToOneField to None, we need to clear
- # out the cache on any old related object. Otherwise, deleting the
- # previously-related object will also cause this object to be deleted,
- # which is wrong.
- if value is None:
- # Look up the previously-related object, which may still be available
- # since we've not yet cleared out the related field.
- # Use the cache directly, instead of the accessor; if we haven't
- # populated the cache, then we don't care - we're only accessing
- # the object to invalidate the accessor cache, so there's no
- # need to populate the cache just to expire it again.
- related = getattr(instance, self.cache_name, None)
- # If we've got an old related object, we need to clear out its
- # cache. This cache also might not exist if the related object
- # hasn't been accessed yet.
- if related is not None:
- setattr(related, self.field.related.get_cache_name(), None)
- # Set the value of the related field
- for lh_field, rh_field in self.field.related_fields:
- try:
- setattr(instance, lh_field.attname, getattr(value, rh_field.attname))
- except AttributeError:
- setattr(instance, lh_field.attname, None)
- # Since we already know what the related object is, seed the related
- # object caches now, too. This avoids another db hit if you get the
- # object you just set.
- setattr(instance, self.cache_name, value)
- if value is not None and not self.field.rel.multiple:
- setattr(value, self.field.related.get_cache_name(), instance)
- def create_foreign_related_manager(superclass, rel_field, rel_model):
- class RelatedManager(superclass):
- def __init__(self, instance):
- super(RelatedManager, self).__init__()
- self.instance = instance
- self.core_filters = {'%s__exact' % rel_field.name: instance}
- self.model = rel_model
- def __call__(self, **kwargs):
- # We use **kwargs rather than a kwarg argument to enforce the
- # `manager='manager_name'` syntax.
- manager = getattr(self.model, kwargs.pop('manager'))
- manager_class = create_foreign_related_manager(manager.__class__, rel_field, rel_model)
- return manager_class(self.instance)
- do_not_call_in_templates = True
- def get_queryset(self):
- try:
- return self.instance._prefetched_objects_cache[rel_field.related_query_name()]
- except (AttributeError, KeyError):
- db = self._db or router.db_for_read(self.model, instance=self.instance)
- empty_strings_as_null = connections[db].features.interprets_empty_strings_as_nulls
- qs = super(RelatedManager, self).get_queryset()
- qs._add_hints(instance=self.instance)
- if self._db:
- qs = qs.using(self._db)
- qs = qs.filter(**self.core_filters)
- for field in rel_field.foreign_related_fields:
- val = getattr(self.instance, field.attname)
- if val is None or (val == '' and empty_strings_as_null):
- return qs.none()
- qs._known_related_objects = {rel_field: {self.instance.pk: self.instance}}
- return qs
- def get_prefetch_queryset(self, instances, queryset=None):
- if queryset is None:
- queryset = super(RelatedManager, self).get_queryset()
- queryset._add_hints(instance=instances[0])
- queryset = queryset.using(queryset._db or self._db)
- rel_obj_attr = rel_field.get_local_related_value
- instance_attr = rel_field.get_foreign_related_value
- instances_dict = dict((instance_attr(inst), inst) for inst in instances)
- query = {'%s__in' % rel_field.name: instances}
- queryset = queryset.filter(**query)
- # Since we just bypassed this class' get_queryset(), we must manage
- # the reverse relation manually.
- for rel_obj in queryset:
- instance = instances_dict[rel_obj_attr(rel_obj)]
- setattr(rel_obj, rel_field.name, instance)
- cache_name = rel_field.related_query_name()
- return queryset, rel_obj_attr, instance_attr, False, cache_name
- def add(self, *objs):
- objs = list(objs)
- db = router.db_for_write(self.model, instance=self.instance)
- with transaction.commit_on_success_unless_managed(
- using=db, savepoint=False):
- for obj in objs:
- if not isinstance(obj, self.model):
- raise TypeError("'%s' instance expected, got %r" %
- (self.model._meta.object_name, obj))
- setattr(obj, rel_field.name, self.instance)
- obj.save()
- add.alters_data = True
- def create(self, **kwargs):
- kwargs[rel_field.name] = self.instance
- db = router.db_for_write(self.model, instance=self.instance)
- return super(RelatedManager, self.db_manager(db)).create(**kwargs)
- create.alters_data = True
- def get_or_create(self, **kwargs):
- # Update kwargs with the related object that this
- # ForeignRelatedObjectsDescriptor knows about.
- kwargs[rel_field.name] = self.instance
- db = router.db_for_write(self.model, instance=self.instance)
- return super(RelatedManager, self.db_manager(db)).get_or_create(**kwargs)
- get_or_create.alters_data = True
- # remove() and clear() are only provided if the ForeignKey can have a value of null.
- if rel_field.null:
- def remove(self, *objs, **kwargs):
- if not objs:
- return
- bulk = kwargs.pop('bulk', True)
- val = rel_field.get_foreign_related_value(self.instance)
- old_ids = set()
- for obj in objs:
- # Is obj actually part of this descriptor set?
- if rel_field.get_local_related_value(obj) == val:
- old_ids.add(obj.pk)
- else:
- raise rel_field.rel.to.DoesNotExist("%r is not related to %r." % (obj, self.instance))
- self._clear(self.filter(pk__in=old_ids), bulk)
- remove.alters_data = True
- def clear(self, **kwargs):
- bulk = kwargs.pop('bulk', True)
- self._clear(self, bulk)
- clear.alters_data = True
- def _clear(self, queryset, bulk):
- db = router.db_for_write(self.model, instance=self.instance)
- queryset = queryset.using(db)
- if bulk:
- queryset.update(**{rel_field.name: None})
- else:
- with transaction.commit_on_success_unless_managed(using=db, savepoint=False):
- for obj in queryset:
- setattr(obj, rel_field.name, None)
- obj.save(update_fields=[rel_field.name])
- _clear.alters_data = True
- return RelatedManager
- class ForeignRelatedObjectsDescriptor(object):
- # This class provides the functionality that makes the related-object
- # managers available as attributes on a model class, for fields that have
- # multiple "remote" values and have a ForeignKey pointed at them by
- # some other model. In the example "poll.choice_set", the choice_set
- # attribute is a ForeignRelatedObjectsDescriptor instance.
- def __init__(self, related):
- self.related = related # RelatedObject instance
- def __get__(self, instance, instance_type=None):
- if instance is None:
- return self
- return self.related_manager_cls(instance)
- def __set__(self, instance, value):
- manager = self.__get__(instance)
- # If the foreign key can support nulls, then completely clear the related set.
- # Otherwise, just move the named objects into the set.
- if self.related.field.null:
- manager.clear()
- manager.add(*value)
- @cached_property
- def related_manager_cls(self):
- # Dynamically create a class that subclasses the related model's default
- # manager.
- return create_foreign_related_manager(
- self.related.model._default_manager.__class__,
- self.related.field,
- self.related.model,
- )
- def create_many_related_manager(superclass, rel):
- """Creates a manager that subclasses 'superclass' (which is a Manager)
- and adds behavior for many-to-many related objects."""
- class ManyRelatedManager(superclass):
- def __init__(self, model=None, query_field_name=None, instance=None, symmetrical=None,
- source_field_name=None, target_field_name=None, reverse=False,
- through=None, prefetch_cache_name=None):
- super(ManyRelatedManager, self).__init__()
- self.model = model
- self.query_field_name = query_field_name
- source_field = through._meta.get_field(source_field_name)
- source_related_fields = source_field.related_fields
- self.core_filters = {}
- for lh_field, rh_field in source_related_fields:
- self.core_filters['%s__%s' % (query_field_name, rh_field.name)] = getattr(instance, rh_field.attname)
- self.instance = instance
- self.symmetrical = symmetrical
- self.source_field = source_field
- self.target_field = through._meta.get_field(target_field_name)
- self.source_field_name = source_field_name
- self.target_field_name = target_field_name
- self.reverse = reverse
- self.through = through
- self.prefetch_cache_name = prefetch_cache_name
- self.related_val = source_field.get_foreign_related_value(instance)
- if None in self.related_val:
- raise ValueError('"%r" needs to have a value for field "%s" before '
- 'this many-to-many relationship can be used.' %
- (instance, source_field_name))
- # Even if this relation is not to pk, we require still pk value.
- # The wish is that the instance has been already saved to DB,
- # although having a pk value isn't a guarantee of that.
- if instance.pk is None:
- raise ValueError("%r instance needs to have a primary key value before "
- "a many-to-many relationship can be used." %
- instance.__class__.__name__)
- def __call__(self, **kwargs):
- # We use **kwargs rather than a kwarg argument to enforce the
- # `manager='manager_name'` syntax.
- manager = getattr(self.model, kwargs.pop('manager'))
- manager_class = create_many_related_manager(manager.__class__, rel)
- return manager_class(
- model=self.model,
- query_field_name=self.query_field_name,
- instance=self.instance,
- symmetrical=self.symmetrical,
- source_field_name=self.source_field_name,
- target_field_name=self.target_field_name,
- reverse=self.reverse,
- through=self.through,
- prefetch_cache_name=self.prefetch_cache_name,
- )
- do_not_call_in_templates = True
- def _build_remove_filters(self, removed_vals):
- filters = Q(**{self.source_field_name: self.related_val})
- # No need to add a subquery condition if removed_vals is a QuerySet without
- # filters.
- removed_vals_filters = (not isinstance(removed_vals, QuerySet) or
- removed_vals._has_filters())
- if removed_vals_filters:
- filters &= Q(**{'%s__in' % self.target_field_name: removed_vals})
- if self.symmetrical:
- symmetrical_filters = Q(**{self.target_field_name: self.related_val})
- if removed_vals_filters:
- symmetrical_filters &= Q(
- **{'%s__in' % self.source_field_name: removed_vals})
- filters |= symmetrical_filters
- return filters
- def get_queryset(self):
- try:
- return self.instance._prefetched_objects_cache[self.prefetch_cache_name]
- except (AttributeError, KeyError):
- qs = super(ManyRelatedManager, self).get_queryset()
- qs._add_hints(instance=self.instance)
- if self._db:
- qs = qs.using(self._db)
- return qs._next_is_sticky().filter(**self.core_filters)
- def get_prefetch_queryset(self, instances, queryset=None):
- if queryset is None:
- queryset = super(ManyRelatedManager, self).get_queryset()
- queryset._add_hints(instance=instances[0])
- queryset = queryset.using(queryset._db or self._db)
- query = {'%s__in' % self.query_field_name: instances}
- queryset = queryset._next_is_sticky().filter(**query)
- # M2M: need to annotate the query in order to get the primary model
- # that the secondary model was actually related to. We know that
- # there will already be a join on the join table, so we can just add
- # the select.
- # For non-autocreated 'through' models, can't assume we are
- # dealing with PK values.
- fk = self.through._meta.get_field(self.source_field_name)
- join_table = self.through._meta.db_table
- connection = connections[queryset.db]
- qn = connection.ops.quote_name
- queryset = queryset.extra(select=dict(
- ('_prefetch_related_val_%s' % f.attname,
- '%s.%s' % (qn(join_table), qn(f.column))) for f in fk.local_related_fields))
- return (queryset,
- lambda result: tuple(getattr(result, '_prefetch_related_val_%s' % f.attname) for f in fk.local_related_fields),
- lambda inst: tuple(getattr(inst, f.attname) for f in fk.foreign_related_fields),
- False,
- self.prefetch_cache_name)
- def add(self, *objs):
- if not rel.through._meta.auto_created:
- opts = self.through._meta
- raise AttributeError(
- "Cannot use add() on a ManyToManyField which specifies an intermediary model. Use %s.%s's Manager instead." %
- (opts.app_label, opts.object_name)
- )
- self._add_items(self.source_field_name, self.target_field_name, *objs)
- # If this is a symmetrical m2m relation to self, add the mirror entry in the m2m table
- if self.symmetrical:
- self._add_items(self.target_field_name, self.source_field_name, *objs)
- add.alters_data = True
- def remove(self, *objs):
- if not rel.through._meta.auto_created:
- opts = self.through._meta
- raise AttributeError(
- "Cannot use remove() on a ManyToManyField which specifies an intermediary model. Use %s.%s's Manager instead." %
- (opts.app_label, opts.object_name)
- )
- self._remove_items(self.source_field_name, self.target_field_name, *objs)
- remove.alters_data = True
- def clear(self):
- db = router.db_for_write(self.through, instance=self.instance)
- signals.m2m_changed.send(sender=self.through, action="pre_clear",
- instance=self.instance, reverse=self.reverse,
- model=self.model, pk_set=None, using=db)
- filters = self._build_remove_filters(super(ManyRelatedManager, self).get_queryset().using(db))
- self.through._default_manager.using(db).filter(filters).delete()
- signals.m2m_changed.send(sender=self.through, action="post_clear",
- instance=self.instance, reverse=self.reverse,
- model=self.model, pk_set=None, using=db)
- clear.alters_data = True
- def create(self, **kwargs):
- # This check needs to be done here, since we can't later remove this
- # from the method lookup table, as we do with add and remove.
- if not self.through._meta.auto_created:
- opts = self.through._meta
- raise AttributeError(
- "Cannot use create() on a ManyToManyField which specifies an intermediary model. Use %s.%s's Manager instead." %
- (opts.app_label, opts.object_name)
- )
- db = router.db_for_write(self.instance.__class__, instance=self.instance)
- new_obj = super(ManyRelatedManager, self.db_manager(db)).create(**kwargs)
- self.add(new_obj)
- return new_obj
- create.alters_data = True
- def get_or_create(self, **kwargs):
- db = router.db_for_write(self.instance.__class__, instance=self.instance)
- obj, created = \
- super(ManyRelatedManager, self.db_manager(db)).get_or_create(**kwargs)
- # We only need to add() if created because if we got an object back
- # from get() then the relationship already exists.
- if created:
- self.add(obj)
- return obj, created
- get_or_create.alters_data = True
- def _add_items(self, source_field_name, target_field_name, *objs):
- # source_field_name: the PK fieldname in join table for the source object
- # target_field_name: the PK fieldname in join table for the target object
- # *objs - objects to add. Either object instances, or primary keys of object instances.
- # If there aren't any objects, there is nothing to do.
- from django.db.models import Model
- if objs:
- new_ids = set()
- for obj in objs:
- if isinstance(obj, self.model):
- if not router.allow_relation(obj, self.instance):
- raise ValueError(
- 'Cannot add "%r": instance is on database "%s", value is on database "%s"' %
- (obj, self.instance._state.db, obj._state.db)
- )
- fk_val = self.through._meta.get_field(
- target_field_name).get_foreign_related_value(obj)[0]
- if fk_val is None:
- raise ValueError(
- 'Cannot add "%r": the value for field "%s" is None' %
- (obj, target_field_name)
- )
- new_ids.add(fk_val)
- elif isinstance(obj, Model):
- raise TypeError(
- "'%s' instance expected, got %r" %
- (self.model._meta.object_name, obj)
- )
- else:
- new_ids.add(obj)
- db = router.db_for_write(self.through, instance=self.instance)
- vals = self.through._default_manager.using(db).values_list(target_field_name, flat=True)
- vals = vals.filter(**{
- source_field_name: self.related_val[0],
- '%s__in' % target_field_name: new_ids,
- })
- new_ids = new_ids - set(vals)
- if self.reverse or source_field_name == self.source_field_name:
- # Don't send the signal when we are inserting the
- # duplicate data row for symmetrical reverse entries.
- signals.m2m_changed.send(sender=self.through, action='pre_add',
- instance=self.instance, reverse=self.reverse,
- model=self.model, pk_set=new_ids, using=db)
- # Add the ones that aren't there already
- self.through._default_manager.using(db).bulk_create([
- self.through(**{
- '%s_id' % source_field_name: self.related_val[0],
- '%s_id' % target_field_name: obj_id,
- })
- for obj_id in new_ids
- ])
- if self.reverse or source_field_name == self.source_field_name:
- # Don't send the signal when we are inserting the
- # duplicate data row for symmetrical reverse entries.
- signals.m2m_changed.send(sender=self.through, action='post_add',
- instance=self.instance, reverse=self.reverse,
- model=self.model, pk_set=new_ids, using=db)
- def _remove_items(self, source_field_name, target_field_name, *objs):
- # source_field_name: the PK colname in join table for the source object
- # target_field_name: the PK colname in join table for the target object
- # *objs - objects to remove
- if not objs:
- return
- # Check that all the objects are of the right type
- old_ids = set()
- for obj in objs:
- if isinstance(obj, self.model):
- fk_val = self.target_field.get_foreign_related_value(obj)[0]
- old_ids.add(fk_val)
- else:
- old_ids.add(obj)
- db = router.db_for_write(self.through, instance=self.instance)
- # Send a signal to the other end if need be.
- signals.m2m_changed.send(sender=self.through, action="pre_remove",
- instance=self.instance, reverse=self.reverse,
- model=self.model, pk_set=old_ids, using=db)
- target_model_qs = super(ManyRelatedManager, self).get_queryset()
- if target_model_qs._has_filters():
- old_vals = target_model_qs.using(db).filter(**{
- '%s__in' % self.target_field.related_field.attname: old_ids})
- else:
- old_vals = old_ids
- filters = self._build_remove_filters(old_vals)
- self.through._default_manager.using(db).filter(filters).delete()
- signals.m2m_changed.send(sender=self.through, action="post_remove",
- instance=self.instance, reverse=self.reverse,
- model=self.model, pk_set=old_ids, using=db)
- return ManyRelatedManager
- class ManyRelatedObjectsDescriptor(object):
- # This class provides the functionality that makes the related-object
- # managers available as attributes on a model class, for fields that have
- # multiple "remote" values and have a ManyToManyField pointed at them by
- # some other model (rather than having a ManyToManyField themselves).
- # In the example "publication.article_set", the article_set attribute is a
- # ManyRelatedObjectsDescriptor instance.
- def __init__(self, related):
- self.related = related # RelatedObject instance
- @cached_property
- def related_manager_cls(self):
- # Dynamically create a class that subclasses the related
- # model's default manager.
- return create_many_related_manager(
- self.related.model._default_manager.__class__,
- self.related.field.rel
- )
- def __get__(self, instance, instance_type=None):
- if instance is None:
- return self
- rel_model = self.related.model
- manager = self.related_manager_cls(
- model=rel_model,
- query_field_name=self.related.field.name,
- prefetch_cache_name=self.related.field.related_query_name(),
- instance=instance,
- symmetrical=False,
- source_field_name=self.related.field.m2m_reverse_field_name(),
- target_field_name=self.related.field.m2m_field_name(),
- reverse=True,
- through=self.related.field.rel.through,
- )
- return manager
- def __set__(self, instance, value):
- if not self.related.field.rel.through._meta.auto_created:
- opts = self.related.field.rel.through._meta
- raise AttributeError("Cannot set values on a ManyToManyField which specifies an intermediary model. Use %s.%s's Manager instead." % (opts.app_label, opts.object_name))
- manager = self.__get__(instance)
- manager.clear()
- manager.add(*value)
- class ReverseManyRelatedObjectsDescriptor(object):
- # This class provides the functionality that makes the related-object
- # managers available as attributes on a model class, for fields that have
- # multiple "remote" values and have a ManyToManyField defined in their
- # model (rather than having another model pointed *at* them).
- # In the example "article.publications", the publications attribute is a
- # ReverseManyRelatedObjectsDescriptor instance.
- def __init__(self, m2m_field):
- self.field = m2m_field
- @property
- def through(self):
- # through is provided so that you have easy access to the through
- # model (Book.authors.through) for inlines, etc. This is done as
- # a property to ensure that the fully resolved value is returned.
- return self.field.rel.through
- @cached_property
- def related_manager_cls(self):
- # Dynamically create a class that subclasses the related model's
- # default manager.
- return create_many_related_manager(
- self.field.rel.to._default_manager.__class__,
- self.field.rel
- )
- def __get__(self, instance, instance_type=None):
- if instance is None:
- return self
- manager = self.related_manager_cls(
- model=self.field.rel.to,
- query_field_name=self.field.related_query_name(),
- prefetch_cache_name=self.field.name,
- instance=instance,
- symmetrical=self.field.rel.symmetrical,
- source_field_name=self.field.m2m_field_name(),
- target_field_name=self.field.m2m_reverse_field_name(),
- reverse=False,
- through=self.field.rel.through,
- )
- return manager
- def __set__(self, instance, value):
- if not self.field.rel.through._meta.auto_created:
- opts = self.field.rel.through._meta
- raise AttributeError("Cannot set values on a ManyToManyField which specifies an intermediary model. Use %s.%s's Manager instead." % (opts.app_label, opts.object_name))
- manager = self.__get__(instance)
- # clear() can change expected output of 'value' queryset, we force evaluation
- # of queryset before clear; ticket #19816
- value = tuple(value)
- manager.clear()
- manager.add(*value)
- class ForeignObjectRel(object):
- def __init__(self, field, to, related_name=None, limit_choices_to=None,
- parent_link=False, on_delete=None, related_query_name=None):
- try:
- to._meta
- except AttributeError: # to._meta doesn't exist, so it must be RECURSIVE_RELATIONSHIP_CONSTANT
- assert isinstance(to, six.string_types), "'to' must be either a model, a model name or the string %r" % RECURSIVE_RELATIONSHIP_CONSTANT
- self.field = field
- self.to = to
- self.related_name = related_name
- self.related_query_name = related_query_name
- self.limit_choices_to = {} if limit_choices_to is None else limit_choices_to
- self.multiple = True
- self.parent_link = parent_link
- self.on_delete = on_delete
- def is_hidden(self):
- "Should the related object be hidden?"
- return self.related_name and self.related_name[-1] == '+'
- def get_joining_columns(self):
- return self.field.get_reverse_joining_columns()
- def get_extra_restriction(self, where_class, alias, related_alias):
- return self.field.get_extra_restriction(where_class, related_alias, alias)
- def set_field_name(self):
- """
- Sets the related field's name, this is not available until later stages
- of app loading, so set_field_name is called from
- set_attributes_from_rel()
- """
- # By default foreign object doesn't relate to any remote field (for
- # example custom multicolumn joins currently have no remote field).
- self.field_name = None
- def get_lookup_constraint(self, constraint_class, alias, targets, sources, lookup_type,
- raw_value):
- return self.field.get_lookup_constraint(constraint_class, alias, targets, sources,
- lookup_type, raw_value)
- class ManyToOneRel(ForeignObjectRel):
- def __init__(self, field, to, field_name, related_name=None, limit_choices_to=None,
- parent_link=False, on_delete=None, related_query_name=None):
- super(ManyToOneRel, self).__init__(
- field, to, related_name=related_name, limit_choices_to=limit_choices_to,
- parent_link=parent_link, on_delete=on_delete, related_query_name=related_query_name)
- self.field_name = field_name
- def get_related_field(self):
- """
- Returns the Field in the 'to' object to which this relationship is
- tied.
- """
- data = self.to._meta.get_field_by_name(self.field_name)
- if not data[2]:
- raise FieldDoesNotExist("No related field named '%s'" %
- self.field_name)
- return data[0]
- def set_field_name(self):
- self.field_name = self.field_name or self.to._meta.pk.name
- class OneToOneRel(ManyToOneRel):
- def __init__(self, field, to, field_name, related_name=None, limit_choices_to=None,
- parent_link=False, on_delete=None, related_query_name=None):
- super(OneToOneRel, self).__init__(field, to, field_name,
- related_name=related_name, limit_choices_to=limit_choices_to,
- parent_link=parent_link, on_delete=on_delete, related_query_name=related_query_name)
- self.multiple = False
- class ManyToManyRel(object):
- def __init__(self, to, related_name=None, limit_choices_to=None,
- symmetrical=True, through=None, through_fields=None,
- db_constraint=True, related_query_name=None):
- if through and not db_constraint:
- raise ValueError("Can't supply a through model and db_constraint=False")
- if through_fields and not through:
- raise ValueError("Cannot specify through_fields without a through model")
- self.to = to
- self.related_name = related_name
- self.related_query_name = related_query_name
- if limit_choices_to is None:
- limit_choices_to = {}
- self.limit_choices_to = limit_choices_to
- self.symmetrical = symmetrical
- self.multiple = True
- self.through = through
- self.through_fields = through_fields
- self.db_constraint = db_constraint
- def is_hidden(self):
- "Should the related object be hidden?"
- return self.related_name and self.related_name[-1] == '+'
- def get_related_field(self):
- """
- Returns the field in the to' object to which this relationship is tied
- (this is always the primary key on the target model). Provided for
- symmetry with ManyToOneRel.
- """
- return self.to._meta.pk
- class ForeignObject(RelatedField):
- requires_unique_target = True
- generate_reverse_relation = True
- related_accessor_class = ForeignRelatedObjectsDescriptor
- def __init__(self, to, from_fields, to_fields, swappable=True, **kwargs):
- self.from_fields = from_fields
- self.to_fields = to_fields
- self.swappable = swappable
- if 'rel' not in kwargs:
- kwargs['rel'] = ForeignObjectRel(
- self, to,
- related_name=kwargs.pop('related_name', None),
- related_query_name=kwargs.pop('related_query_name', None),
- limit_choices_to=kwargs.pop('limit_choices_to', None),
- parent_link=kwargs.pop('parent_link', False),
- on_delete=kwargs.pop('on_delete', CASCADE),
- )
- kwargs['verbose_name'] = kwargs.get('verbose_name', None)
- super(ForeignObject, self).__init__(**kwargs)
- def check(self, **kwargs):
- errors = super(ForeignObject, self).check(**kwargs)
- errors.extend(self._check_unique_target())
- return errors
- def _check_unique_target(self):
- rel_is_string = isinstance(self.rel.to, six.string_types)
- if rel_is_string or not self.requires_unique_target:
- return []
- # Skip if the
- try:
- self.foreign_related_fields
- except FieldDoesNotExist:
- return []
- try:
- self.related
- except AttributeError:
- return []
- has_unique_field = any(rel_field.unique
- for rel_field in self.foreign_related_fields)
- if not has_unique_field and len(self.foreign_related_fields) > 1:
- field_combination = ', '.join("'%s'" % rel_field.name
- for rel_field in self.foreign_related_fields)
- model_name = self.rel.to.__name__
- return [
- checks.Error(
- "None of the fields %s on model '%s' have a unique=True constraint." % (field_combination, model_name),
- hint=None,
- obj=self,
- id='fields.E310',
- )
- ]
- elif not has_unique_field:
- field_name = self.foreign_related_fields[0].name
- model_name = self.rel.to.__name__
- return [
- checks.Error(
- ("'%s.%s' must set unique=True "
- "because it is referenced by a foreign key.") % (model_name, field_name),
- hint=None,
- obj=self,
- id='fields.E311',
- )
- ]
- else:
- return []
- def deconstruct(self):
- name, path, args, kwargs = super(ForeignObject, self).deconstruct()
- kwargs['from_fields'] = self.from_fields
- kwargs['to_fields'] = self.to_fields
- if self.rel.related_name is not None:
- kwargs['related_name'] = self.rel.related_name
- if self.rel.related_query_name is not None:
- kwargs['related_query_name'] = self.rel.related_query_name
- if self.rel.on_delete != CASCADE:
- kwargs['on_delete'] = self.rel.on_delete
- if self.rel.parent_link:
- kwargs['parent_link'] = self.rel.parent_link
- # Work out string form of "to"
- if isinstance(self.rel.to, six.string_types):
- kwargs['to'] = self.rel.to
- else:
- kwargs['to'] = "%s.%s" % (self.rel.to._meta.app_label, self.rel.to._meta.object_name)
- # If swappable is True, then see if we're actually pointing to the target
- # of a swap.
- swappable_setting = self.swappable_setting
- if swappable_setting is not None:
- # If it's already a settings reference, error
- if hasattr(kwargs['to'], "setting_name"):
- if kwargs['to'].setting_name != swappable_setting:
- raise ValueError("Cannot deconstruct a ForeignKey pointing to a model that is swapped in place of more than one model (%s and %s)" % (kwargs['to'].setting_name, swappable_setting))
- # Set it
- from django.db.migrations.writer import SettingsReference
- kwargs['to'] = SettingsReference(
- kwargs['to'],
- swappable_setting,
- )
- return name, path, args, kwargs
- def resolve_related_fields(self):
- if len(self.from_fields) < 1 or len(self.from_fields) != len(self.to_fields):
- raise ValueError('Foreign Object from and to fields must be the same non-zero length')
- if isinstance(self.rel.to, six.string_types):
- raise ValueError('Related model %r cannot be resolved' % self.rel.to)
- related_fields = []
- for index in range(len(self.from_fields)):
- from_field_name = self.from_fields[index]
- to_field_name = self.to_fields[index]
- from_field = (self if from_field_name == 'self'
- else self.opts.get_field_by_name(from_field_name)[0])
- to_field = (self.rel.to._meta.pk if to_field_name is None
- else self.rel.to._meta.get_field_by_name(to_field_name)[0])
- related_fields.append((from_field, to_field))
- return related_fields
- @property
- def related_fields(self):
- if not hasattr(self, '_related_fields'):
- self._related_fields = self.resolve_related_fields()
- return self._related_fields
- @property
- def reverse_related_fields(self):
- return [(rhs_field, lhs_field) for lhs_field, rhs_field in self.related_fields]
- @property
- def local_related_fields(self):
- return tuple(lhs_field for lhs_field, rhs_field in self.related_fields)
- @property
- def foreign_related_fields(self):
- return tuple(rhs_field for lhs_field, rhs_field in self.related_fields)
- def get_local_related_value(self, instance):
- return self.get_instance_value_for_fields(instance, self.local_related_fields)
- def get_foreign_related_value(self, instance):
- return self.get_instance_value_for_fields(instance, self.foreign_related_fields)
- @staticmethod
- def get_instance_value_for_fields(instance, fields):
- ret = []
- opts = instance._meta
- for field in fields:
- # Gotcha: in some cases (like fixture loading) a model can have
- # different values in parent_ptr_id and parent's id. So, use
- # instance.pk (that is, parent_ptr_id) when asked for instance.id.
- if field.primary_key:
- possible_parent_link = opts.get_ancestor_link(field.model)
- if (not possible_parent_link or
- possible_parent_link.primary_key or
- possible_parent_link.model._meta.abstract):
- ret.append(instance.pk)
- continue
- ret.append(getattr(instance, field.attname))
- return tuple(ret)
- def get_attname_column(self):
- attname, column = super(ForeignObject, self).get_attname_column()
- return attname, None
- def get_joining_columns(self, reverse_join=False):
- source = self.reverse_related_fields if reverse_join else self.related_fields
- return tuple((lhs_field.column, rhs_field.column) for lhs_field, rhs_field in source)
- def get_reverse_joining_columns(self):
- return self.get_joining_columns(reverse_join=True)
- def get_extra_descriptor_filter(self, instance):
- """
- Returns 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.
- 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.
- """
- return {}
- def get_extra_restriction(self, where_class, alias, related_alias):
- """
- Returns a pair condition used for joining and subquery pushdown. The
- condition is something that responds to as_sql(qn, connection) method.
- 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.
- """
- return None
- def get_path_info(self):
- """
- Get path from this field to the related model.
- """
- opts = self.rel.to._meta
- from_opts = self.model._meta
- return [PathInfo(from_opts, opts, self.foreign_related_fields, self, False, True)]
- def get_reverse_path_info(self):
- """
- Get path from the related model to this field's model.
- """
- opts = self.model._meta
- from_opts = self.rel.to._meta
- pathinfos = [PathInfo(from_opts, opts, (opts.pk,), self.rel, not self.unique, False)]
- return pathinfos
- def get_lookup_constraint(self, constraint_class, alias, targets, sources, lookups,
- raw_value):
- from django.db.models.sql.where import SubqueryConstraint, AND, OR
- root_constraint = constraint_class()
- assert len(targets) == len(sources)
- if len(lookups) > 1:
- raise exceptions.FieldError('Relation fields do not support nested lookups')
- lookup_type = lookups[0]
- def get_normalized_value(value):
- from django.db.models import Model
- if isinstance(value, Model):
- value_list = []
- for source in sources:
- # Account for one-to-one relations when sent a different model
- while not isinstance(value, source.model) and source.rel:
- source = source.rel.to._meta.get_field(source.rel.field_name)
- value_list.append(getattr(value, source.attname))
- return tuple(value_list)
- elif not isinstance(value, tuple):
- return (value,)
- return value
- is_multicolumn = len(self.related_fields) > 1
- if (hasattr(raw_value, '_as_sql') or
- hasattr(raw_value, 'get_compiler')):
- root_constraint.add(SubqueryConstraint(alias, [target.column for target in targets],
- [source.name for source in sources], raw_value),
- AND)
- elif lookup_type == 'isnull':
- root_constraint.add(IsNull(Col(alias, targets[0], sources[0]), raw_value), AND)
- elif (lookup_type == 'exact' or (lookup_type in ['gt', 'lt', 'gte', 'lte']
- and not is_multicolumn)):
- value = get_normalized_value(raw_value)
- for target, source, val in zip(targets, sources, value):
- lookup_class = target.get_lookup(lookup_type)
- root_constraint.add(
- lookup_class(Col(alias, target, source), val), AND)
- elif lookup_type in ['range', 'in'] and not is_multicolumn:
- values = [get_normalized_value(value) for value in raw_value]
- value = [val[0] for val in values]
- lookup_class = targets[0].get_lookup(lookup_type)
- root_constraint.add(lookup_class(Col(alias, targets[0], sources[0]), value), AND)
- elif lookup_type == 'in':
- values = [get_normalized_value(value) for value in raw_value]
- for value in values:
- value_constraint = constraint_class()
- for source, target, val in zip(sources, targets, value):
- lookup_class = target.get_lookup('exact')
- lookup = lookup_class(Col(alias, target, source), val)
- value_constraint.add(lookup, AND)
- root_constraint.add(value_constraint, OR)
- else:
- raise TypeError('Related Field got invalid lookup: %s' % lookup_type)
- return root_constraint
- @property
- def attnames(self):
- return tuple(field.attname for field in self.local_related_fields)
- def get_defaults(self):
- return tuple(field.get_default() for field in self.local_related_fields)
- def contribute_to_class(self, cls, name, virtual_only=False):
- super(ForeignObject, self).contribute_to_class(cls, name, virtual_only=virtual_only)
- setattr(cls, self.name, ReverseSingleRelatedObjectDescriptor(self))
- def contribute_to_related_class(self, cls, related):
- # Internal FK's - i.e., those with a related name ending with '+' -
- # and swapped models don't get a related descriptor.
- if not self.rel.is_hidden() and not related.model._meta.swapped:
- setattr(cls, related.get_accessor_name(), self.related_accessor_class(related))
- # While 'limit_choices_to' might be a callable, simply pass
- # it along for later - this is too early because it's still
- # model load time.
- if self.rel.limit_choices_to:
- cls._meta.related_fkey_lookups.append(self.rel.limit_choices_to)
- class ForeignKey(ForeignObject):
- empty_strings_allowed = False
- default_error_messages = {
- 'invalid': _('%(model)s instance with pk %(pk)r does not exist.')
- }
- description = _("Foreign Key (type determined by related field)")
- def __init__(self, to, to_field=None, rel_class=ManyToOneRel,
- db_constraint=True, **kwargs):
- try:
- to._meta.model_name
- except AttributeError: # to._meta doesn't exist, so it must be RECURSIVE_RELATIONSHIP_CONSTANT
- assert isinstance(to, six.string_types), "%s(%r) is invalid. First parameter to ForeignKey must be either a model, a model name, or the string %r" % (self.__class__.__name__, to, RECURSIVE_RELATIONSHIP_CONSTANT)
- else:
- # For backwards compatibility purposes, we need to *try* and set
- # the to_field during FK construction. It won't be guaranteed to
- # be correct until contribute_to_class is called. Refs #12190.
- to_field = to_field or (to._meta.pk and to._meta.pk.name)
- if 'db_index' not in kwargs:
- kwargs['db_index'] = True
- self.db_constraint = db_constraint
- kwargs['rel'] = rel_class(
- self, to, to_field,
- related_name=kwargs.pop('related_name', None),
- related_query_name=kwargs.pop('related_query_name', None),
- limit_choices_to=kwargs.pop('limit_choices_to', None),
- parent_link=kwargs.pop('parent_link', False),
- on_delete=kwargs.pop('on_delete', CASCADE),
- )
- super(ForeignKey, self).__init__(to, ['self'], [to_field], **kwargs)
- def check(self, **kwargs):
- errors = super(ForeignKey, self).check(**kwargs)
- errors.extend(self._check_on_delete())
- return errors
- def _check_on_delete(self):
- on_delete = getattr(self.rel, 'on_delete', None)
- if on_delete == SET_NULL and not self.null:
- return [
- checks.Error(
- 'Field specifies on_delete=SET_NULL, but cannot be null.',
- hint='Set null=True argument on the field, or change the on_delete rule.',
- obj=self,
- id='fields.E320',
- )
- ]
- elif on_delete == SET_DEFAULT and not self.has_default():
- return [
- checks.Error(
- 'Field specifies on_delete=SET_DEFAULT, but has no default value.',
- hint='Set a default value, or change the on_delete rule.',
- obj=self,
- id='fields.E321',
- )
- ]
- else:
- return []
- def deconstruct(self):
- name, path, args, kwargs = super(ForeignKey, self).deconstruct()
- del kwargs['to_fields']
- del kwargs['from_fields']
- # Handle the simpler arguments
- if self.db_index:
- del kwargs['db_index']
- else:
- kwargs['db_index'] = False
- if self.db_constraint is not True:
- kwargs['db_constraint'] = self.db_constraint
- # Rel needs more work.
- to_meta = getattr(self.rel.to, "_meta", None)
- if self.rel.field_name and (not to_meta or (to_meta.pk and self.rel.field_name != to_meta.pk.name)):
- kwargs['to_field'] = self.rel.field_name
- return name, path, args, kwargs
- @property
- def related_field(self):
- return self.foreign_related_fields[0]
- def get_reverse_path_info(self):
- """
- Get path from the related model to this field's model.
- """
- opts = self.model._meta
- from_opts = self.rel.to._meta
- pathinfos = [PathInfo(from_opts, opts, (opts.pk,), self.rel, not self.unique, False)]
- return pathinfos
- def validate(self, value, model_instance):
- if self.rel.parent_link:
- return
- super(ForeignKey, self).validate(value, model_instance)
- if value is None:
- return
- using = router.db_for_read(model_instance.__class__, instance=model_instance)
- qs = self.rel.to._default_manager.using(using).filter(
- **{self.rel.field_name: value}
- )
- qs = qs.complex_filter(self.get_limit_choices_to())
- if not qs.exists():
- raise exceptions.ValidationError(
- self.error_messages['invalid'],
- code='invalid',
- params={'model': self.rel.to._meta.verbose_name, 'pk': value},
- )
- def get_attname(self):
- return '%s_id' % self.name
- def get_attname_column(self):
- attname = self.get_attname()
- column = self.db_column or attname
- return attname, column
- def get_validator_unique_lookup_type(self):
- return '%s__%s__exact' % (self.name, self.related_field.name)
- def get_default(self):
- "Here we check if the default value is an object and return the to_field if so."
- field_default = super(ForeignKey, self).get_default()
- if isinstance(field_default, self.rel.to):
- return getattr(field_default, self.related_field.attname)
- return field_default
- def get_db_prep_save(self, value, connection):
- if value is None or (value == '' and
- (not self.related_field.empty_strings_allowed or
- connection.features.interprets_empty_strings_as_nulls)):
- return None
- else:
- return self.related_field.get_db_prep_save(value, connection=connection)
- def value_to_string(self, obj):
- if not obj:
- # In required many-to-one fields with only one available choice,
- # select that one available choice. Note: For SelectFields
- # we have to check that the length of choices is *2*, not 1,
- # because SelectFields always have an initial "blank" value.
- if not self.blank and self.choices:
- choice_list = self.get_choices_default()
- if len(choice_list) == 2:
- return smart_text(choice_list[1][0])
- return super(ForeignKey, self).value_to_string(obj)
- def contribute_to_related_class(self, cls, related):
- super(ForeignKey, self).contribute_to_related_class(cls, related)
- if self.rel.field_name is None:
- self.rel.field_name = cls._meta.pk.name
- def formfield(self, **kwargs):
- db = kwargs.pop('using', None)
- if isinstance(self.rel.to, six.string_types):
- raise ValueError("Cannot create form field for %r yet, because "
- "its related model %r has not been loaded yet" %
- (self.name, self.rel.to))
- defaults = {
- 'form_class': forms.ModelChoiceField,
- 'queryset': self.rel.to._default_manager.using(db),
- 'to_field_name': self.rel.field_name,
- }
- defaults.update(kwargs)
- return super(ForeignKey, self).formfield(**defaults)
- def db_type(self, connection):
- # The database column type of a ForeignKey is the column type
- # of the field to which it points. An exception is if the ForeignKey
- # points to an AutoField/PositiveIntegerField/PositiveSmallIntegerField,
- # in which case the column type is simply that of an IntegerField.
- # If the database needs similar types for key fields however, the only
- # thing we can do is making AutoField an IntegerField.
- rel_field = self.related_field
- if (isinstance(rel_field, AutoField) or
- (not connection.features.related_fields_match_type and
- isinstance(rel_field, (PositiveIntegerField,
- PositiveSmallIntegerField)))):
- return IntegerField().db_type(connection=connection)
- return rel_field.db_type(connection=connection)
- def db_parameters(self, connection):
- return {"type": self.db_type(connection), "check": []}
- class OneToOneField(ForeignKey):
- """
- A OneToOneField is essentially the same as a ForeignKey, with the exception
- that always carries a "unique" constraint with it and the reverse relation
- always returns the object pointed to (since there will only ever be one),
- rather than returning a list.
- """
- related_accessor_class = SingleRelatedObjectDescriptor
- description = _("One-to-one relationship")
- def __init__(self, to, to_field=None, **kwargs):
- kwargs['unique'] = True
- super(OneToOneField, self).__init__(to, to_field, OneToOneRel, **kwargs)
- def deconstruct(self):
- name, path, args, kwargs = super(OneToOneField, self).deconstruct()
- if "unique" in kwargs:
- del kwargs['unique']
- return name, path, args, kwargs
- def formfield(self, **kwargs):
- if self.rel.parent_link:
- return None
- return super(OneToOneField, self).formfield(**kwargs)
- def save_form_data(self, instance, data):
- if isinstance(data, self.rel.to):
- setattr(instance, self.name, data)
- else:
- setattr(instance, self.attname, data)
- def create_many_to_many_intermediary_model(field, klass):
- from django.db import models
- managed = True
- if isinstance(field.rel.to, six.string_types) and field.rel.to != RECURSIVE_RELATIONSHIP_CONSTANT:
- to_model = field.rel.to
- to = to_model.split('.')[-1]
- def set_managed(field, model, cls):
- field.rel.through._meta.managed = model._meta.managed or cls._meta.managed
- add_lazy_relation(klass, field, to_model, set_managed)
- elif isinstance(field.rel.to, six.string_types):
- to = klass._meta.object_name
- to_model = klass
- managed = klass._meta.managed
- else:
- to = field.rel.to._meta.object_name
- to_model = field.rel.to
- managed = klass._meta.managed or to_model._meta.managed
- name = '%s_%s' % (klass._meta.object_name, field.name)
- if field.rel.to == RECURSIVE_RELATIONSHIP_CONSTANT or to == klass._meta.object_name:
- from_ = 'from_%s' % to.lower()
- to = 'to_%s' % to.lower()
- else:
- from_ = klass._meta.model_name
- to = to.lower()
- meta = type(str('Meta'), (object,), {
- 'db_table': field._get_m2m_db_table(klass._meta),
- 'managed': managed,
- 'auto_created': klass,
- 'app_label': klass._meta.app_label,
- 'db_tablespace': klass._meta.db_tablespace,
- 'unique_together': (from_, to),
- 'verbose_name': '%(from)s-%(to)s relationship' % {'from': from_, 'to': to},
- 'verbose_name_plural': '%(from)s-%(to)s relationships' % {'from': from_, 'to': to},
- 'apps': field.model._meta.apps,
- })
- # Construct and return the new class.
- return type(str(name), (models.Model,), {
- 'Meta': meta,
- '__module__': klass.__module__,
- from_: models.ForeignKey(klass, related_name='%s+' % name, db_tablespace=field.db_tablespace, db_constraint=field.rel.db_constraint),
- to: models.ForeignKey(to_model, related_name='%s+' % name, db_tablespace=field.db_tablespace, db_constraint=field.rel.db_constraint)
- })
- class ManyToManyField(RelatedField):
- description = _("Many-to-many relationship")
- def __init__(self, to, db_constraint=True, swappable=True, **kwargs):
- try:
- to._meta
- except AttributeError: # to._meta doesn't exist, so it must be RECURSIVE_RELATIONSHIP_CONSTANT
- assert isinstance(to, six.string_types), "%s(%r) is invalid. First parameter to ManyToManyField must be either a model, a model name, or the string %r" % (self.__class__.__name__, to, RECURSIVE_RELATIONSHIP_CONSTANT)
- # Class names must be ASCII in Python 2.x, so we forcibly coerce it here to break early if there's a problem.
- to = str(to)
- kwargs['verbose_name'] = kwargs.get('verbose_name', None)
- kwargs['rel'] = ManyToManyRel(to,
- related_name=kwargs.pop('related_name', None),
- related_query_name=kwargs.pop('related_query_name', None),
- limit_choices_to=kwargs.pop('limit_choices_to', None),
- symmetrical=kwargs.pop('symmetrical', to == RECURSIVE_RELATIONSHIP_CONSTANT),
- through=kwargs.pop('through', None),
- through_fields=kwargs.pop('through_fields', None),
- db_constraint=db_constraint,
- )
- self.swappable = swappable
- self.db_table = kwargs.pop('db_table', None)
- if kwargs['rel'].through is not None:
- assert self.db_table is None, "Cannot specify a db_table if an intermediary model is used."
- super(ManyToManyField, self).__init__(**kwargs)
- def check(self, **kwargs):
- errors = super(ManyToManyField, self).check(**kwargs)
- errors.extend(self._check_unique(**kwargs))
- errors.extend(self._check_relationship_model(**kwargs))
- return errors
- def _check_unique(self, **kwargs):
- if self.unique:
- return [
- checks.Error(
- 'ManyToManyFields cannot be unique.',
- hint=None,
- obj=self,
- id='fields.E330',
- )
- ]
- return []
- def _check_relationship_model(self, from_model=None, **kwargs):
- if hasattr(self.rel.through, '_meta'):
- qualified_model_name = "%s.%s" % (
- self.rel.through._meta.app_label, self.rel.through.__name__)
- else:
- qualified_model_name = self.rel.through
- errors = []
- if self.rel.through not in apps.get_models(include_auto_created=True):
- # The relationship model is not installed.
- errors.append(
- checks.Error(
- ("Field specifies a many-to-many relation through model "
- "'%s', which has not been installed.") %
- qualified_model_name,
- hint=None,
- obj=self,
- id='fields.E331',
- )
- )
- else:
- assert from_model is not None, \
- "ManyToManyField with intermediate " \
- "tables cannot be checked if you don't pass the model " \
- "where the field is attached to."
- # Set some useful local variables
- to_model = self.rel.to
- from_model_name = from_model._meta.object_name
- if isinstance(to_model, six.string_types):
- to_model_name = to_model
- else:
- to_model_name = to_model._meta.object_name
- relationship_model_name = self.rel.through._meta.object_name
- self_referential = from_model == to_model
- # Check symmetrical attribute.
- if (self_referential and self.rel.symmetrical and
- not self.rel.through._meta.auto_created):
- errors.append(
- checks.Error(
- 'Many-to-many fields with intermediate tables must not be symmetrical.',
- hint=None,
- obj=self,
- id='fields.E332',
- )
- )
- # Count foreign keys in intermediate model
- if self_referential:
- seen_self = sum(from_model == getattr(field.rel, 'to', None)
- for field in self.rel.through._meta.fields)
- if seen_self > 2 and not self.rel.through_fields:
- errors.append(
- checks.Error(
- ("The model is used as an intermediate model by "
- "'%s', but it has more than two foreign keys "
- "to '%s', which is ambiguous. You must specify "
- "which two foreign keys Django should use via the "
- "through_fields keyword argument.") % (self, from_model_name),
- hint=("Use through_fields to specify which two "
- "foreign keys Django should use."),
- obj=self.rel.through,
- id='fields.E333',
- )
- )
- else:
- # Count foreign keys in relationship model
- seen_from = sum(from_model == getattr(field.rel, 'to', None)
- for field in self.rel.through._meta.fields)
- seen_to = sum(to_model == getattr(field.rel, 'to', None)
- for field in self.rel.through._meta.fields)
- if seen_from > 1 and not self.rel.through_fields:
- errors.append(
- checks.Error(
- ("The model is used as an intermediate model by "
- "'%s', but it has more than one foreign key "
- "from '%s', which is ambiguous. You must specify "
- "which foreign key Django should use via the "
- "through_fields keyword argument.") % (self, from_model_name),
- hint=('If you want to create a recursive relationship, '
- 'use ForeignKey("self", symmetrical=False, '
- 'through="%s").') % relationship_model_name,
- obj=self,
- id='fields.E334',
- )
- )
- if seen_to > 1 and not self.rel.through_fields:
- errors.append(
- checks.Error(
- ("The model is used as an intermediate model by "
- "'%s', but it has more than one foreign key "
- "to '%s', which is ambiguous. You must specify "
- "which foreign key Django should use via the "
- "through_fields keyword argument.") % (self, to_model_name),
- hint=('If you want to create a recursive '
- 'relationship, use ForeignKey("self", '
- 'symmetrical=False, through="%s").') % relationship_model_name,
- obj=self,
- id='fields.E335',
- )
- )
- if seen_from == 0 or seen_to == 0:
- errors.append(
- checks.Error(
- ("The model is used as an intermediate model by "
- "'%s', but it does not have a foreign key to '%s' or '%s'.") % (
- self, from_model_name, to_model_name
- ),
- hint=None,
- obj=self.rel.through,
- id='fields.E336',
- )
- )
- # Validate `through_fields`
- if self.rel.through_fields is not None:
- # Validate that we're given an iterable of at least two items
- # and that none of them is "falsy"
- if not (len(self.rel.through_fields) >= 2 and
- self.rel.through_fields[0] and self.rel.through_fields[1]):
- errors.append(
- checks.Error(
- ("Field specifies 'through_fields' but does not "
- "provide the names of the two link fields that should be "
- "used for the relation through model "
- "'%s'.") % qualified_model_name,
- hint=("Make sure you specify 'through_fields' as "
- "through_fields=('field1', 'field2')"),
- obj=self,
- id='fields.E337',
- )
- )
- # Validate the given through fields -- they should be actual
- # fields on the through model, and also be foreign keys to the
- # expected models
- else:
- assert from_model is not None, \
- "ManyToManyField with intermediate " \
- "tables cannot be checked if you don't pass the model " \
- "where the field is attached to."
- source, through, target = from_model, self.rel.through, self.rel.to
- source_field_name, target_field_name = self.rel.through_fields[:2]
- for field_name, related_model in ((source_field_name, source),
- (target_field_name, target)):
- possible_field_names = []
- for f in through._meta.fields:
- if hasattr(f, 'rel') and getattr(f.rel, 'to', None) == related_model:
- possible_field_names.append(f.name)
- if possible_field_names:
- hint = ("Did you mean one of the following foreign "
- "keys to '%s': %s?") % (related_model._meta.object_name,
- ', '.join(possible_field_names))
- else:
- hint = None
- try:
- field = through._meta.get_field(field_name)
- except FieldDoesNotExist:
- errors.append(
- checks.Error(
- ("The intermediary model '%s' has no field '%s'.") % (
- qualified_model_name, field_name),
- hint=hint,
- obj=self,
- id='fields.E338',
- )
- )
- else:
- if not (hasattr(field, 'rel') and
- getattr(field.rel, 'to', None) == related_model):
- errors.append(
- checks.Error(
- "'%s.%s' is not a foreign key to '%s'." % (
- through._meta.object_name, field_name,
- related_model._meta.object_name),
- hint=hint,
- obj=self,
- id='fields.E339',
- )
- )
- return errors
- def deconstruct(self):
- name, path, args, kwargs = super(ManyToManyField, self).deconstruct()
- # Handle the simpler arguments
- if self.db_table is not None:
- kwargs['db_table'] = self.db_table
- if self.rel.db_constraint is not True:
- kwargs['db_constraint'] = self.rel.db_constraint
- if self.rel.related_name is not None:
- kwargs['related_name'] = self.rel.related_name
- if self.rel.related_query_name is not None:
- kwargs['related_query_name'] = self.rel.related_query_name
- # Rel needs more work.
- if isinstance(self.rel.to, six.string_types):
- kwargs['to'] = self.rel.to
- else:
- kwargs['to'] = "%s.%s" % (self.rel.to._meta.app_label, self.rel.to._meta.object_name)
- if getattr(self.rel, 'through', None) is not None:
- if isinstance(self.rel.through, six.string_types):
- kwargs['through'] = self.rel.through
- elif not self.rel.through._meta.auto_created:
- kwargs['through'] = "%s.%s" % (self.rel.through._meta.app_label, self.rel.through._meta.object_name)
- # If swappable is True, then see if we're actually pointing to the target
- # of a swap.
- swappable_setting = self.swappable_setting
- if swappable_setting is not None:
- # If it's already a settings reference, error
- if hasattr(kwargs['to'], "setting_name"):
- if kwargs['to'].setting_name != swappable_setting:
- raise ValueError("Cannot deconstruct a ManyToManyField pointing to a model that is swapped in place of more than one model (%s and %s)" % (kwargs['to'].setting_name, swappable_setting))
- # Set it
- from django.db.migrations.writer import SettingsReference
- kwargs['to'] = SettingsReference(
- kwargs['to'],
- swappable_setting,
- )
- return name, path, args, kwargs
- def _get_path_info(self, direct=False):
- """
- Called by both direct and indirect m2m traversal.
- """
- pathinfos = []
- int_model = self.rel.through
- linkfield1 = int_model._meta.get_field_by_name(self.m2m_field_name())[0]
- linkfield2 = int_model._meta.get_field_by_name(self.m2m_reverse_field_name())[0]
- if direct:
- join1infos = linkfield1.get_reverse_path_info()
- join2infos = linkfield2.get_path_info()
- else:
- join1infos = linkfield2.get_reverse_path_info()
- join2infos = linkfield1.get_path_info()
- pathinfos.extend(join1infos)
- pathinfos.extend(join2infos)
- return pathinfos
- def get_path_info(self):
- return self._get_path_info(direct=True)
- def get_reverse_path_info(self):
- return self._get_path_info(direct=False)
- def get_choices_default(self):
- return Field.get_choices(self, include_blank=False)
- def _get_m2m_db_table(self, opts):
- "Function that can be curried to provide the m2m table name for this relation"
- if self.rel.through is not None:
- return self.rel.through._meta.db_table
- elif self.db_table:
- return self.db_table
- else:
- return utils.truncate_name('%s_%s' % (opts.db_table, self.name),
- connection.ops.max_name_length())
- def _get_m2m_attr(self, related, attr):
- "Function that can be curried to provide the source accessor or DB column name for the m2m table"
- cache_attr = '_m2m_%s_cache' % attr
- if hasattr(self, cache_attr):
- return getattr(self, cache_attr)
- if self.rel.through_fields is not None:
- link_field_name = self.rel.through_fields[0]
- else:
- link_field_name = None
- for f in self.rel.through._meta.fields:
- if hasattr(f, 'rel') and f.rel and f.rel.to == related.model and \
- (link_field_name is None or link_field_name == f.name):
- setattr(self, cache_attr, getattr(f, attr))
- return getattr(self, cache_attr)
- def _get_m2m_reverse_attr(self, related, attr):
- "Function that can be curried to provide the related accessor or DB column name for the m2m table"
- cache_attr = '_m2m_reverse_%s_cache' % attr
- if hasattr(self, cache_attr):
- return getattr(self, cache_attr)
- found = False
- if self.rel.through_fields is not None:
- link_field_name = self.rel.through_fields[1]
- else:
- link_field_name = None
- for f in self.rel.through._meta.fields:
- if hasattr(f, 'rel') and f.rel and f.rel.to == related.parent_model:
- if link_field_name is None and related.model == related.parent_model:
- # If this is an m2m-intermediate to self,
- # the first foreign key you find will be
- # the source column. Keep searching for
- # the second foreign key.
- if found:
- setattr(self, cache_attr, getattr(f, attr))
- break
- else:
- found = True
- elif link_field_name is None or link_field_name == f.name:
- setattr(self, cache_attr, getattr(f, attr))
- break
- return getattr(self, cache_attr)
- def value_to_string(self, obj):
- data = ''
- if obj:
- qs = getattr(obj, self.name).all()
- data = [instance._get_pk_val() for instance in qs]
- else:
- # In required many-to-many fields with only one available choice,
- # select that one available choice.
- if not self.blank:
- choices_list = self.get_choices_default()
- if len(choices_list) == 1:
- data = [choices_list[0][0]]
- return smart_text(data)
- def contribute_to_class(self, cls, name):
- # To support multiple relations to self, it's useful to have a non-None
- # related name on symmetrical relations for internal reasons. The
- # concept doesn't make a lot of sense externally ("you want me to
- # specify *what* on my non-reversible relation?!"), so we set it up
- # automatically. The funky name reduces the chance of an accidental
- # clash.
- if self.rel.symmetrical and (self.rel.to == "self" or self.rel.to == cls._meta.object_name):
- self.rel.related_name = "%s_rel_+" % name
- super(ManyToManyField, self).contribute_to_class(cls, name)
- # The intermediate m2m model is not auto created if:
- # 1) There is a manually specified intermediate, or
- # 2) The class owning the m2m field is abstract.
- # 3) The class owning the m2m field has been swapped out.
- if not self.rel.through and not cls._meta.abstract and not cls._meta.swapped:
- self.rel.through = create_many_to_many_intermediary_model(self, cls)
- # Add the descriptor for the m2m relation
- setattr(cls, self.name, ReverseManyRelatedObjectsDescriptor(self))
- # Set up the accessor for the m2m table name for the relation
- self.m2m_db_table = curry(self._get_m2m_db_table, cls._meta)
- # Populate some necessary rel arguments so that cross-app relations
- # work correctly.
- if isinstance(self.rel.through, six.string_types):
- def resolve_through_model(field, model, cls):
- field.rel.through = model
- add_lazy_relation(cls, self, self.rel.through, resolve_through_model)
- def contribute_to_related_class(self, cls, related):
- # Internal M2Ms (i.e., those with a related name ending with '+')
- # and swapped models don't get a related descriptor.
- if not self.rel.is_hidden() and not related.model._meta.swapped:
- setattr(cls, related.get_accessor_name(), ManyRelatedObjectsDescriptor(related))
- # Set up the accessors for the column names on the m2m table
- self.m2m_column_name = curry(self._get_m2m_attr, related, 'column')
- self.m2m_reverse_name = curry(self._get_m2m_reverse_attr, related, 'column')
- self.m2m_field_name = curry(self._get_m2m_attr, related, 'name')
- self.m2m_reverse_field_name = curry(self._get_m2m_reverse_attr, related, 'name')
- get_m2m_rel = curry(self._get_m2m_attr, related, 'rel')
- self.m2m_target_field_name = lambda: get_m2m_rel().field_name
- get_m2m_reverse_rel = curry(self._get_m2m_reverse_attr, related, 'rel')
- self.m2m_reverse_target_field_name = lambda: get_m2m_reverse_rel().field_name
- def set_attributes_from_rel(self):
- pass
- def value_from_object(self, obj):
- "Returns the value of this field in the given model instance."
- return getattr(obj, self.attname).all()
- def save_form_data(self, instance, data):
- setattr(instance, self.attname, data)
- def formfield(self, **kwargs):
- db = kwargs.pop('using', None)
- defaults = {
- 'form_class': forms.ModelMultipleChoiceField,
- 'queryset': self.rel.to._default_manager.using(db),
- }
- defaults.update(kwargs)
- # If initial is passed in, it's a list of related objects, but the
- # MultipleChoiceField takes a list of IDs.
- if defaults.get('initial') is not None:
- initial = defaults['initial']
- if callable(initial):
- initial = initial()
- defaults['initial'] = [i._get_pk_val() for i in initial]
- return super(ManyToManyField, self).formfield(**defaults)
- def db_type(self, connection):
- # A ManyToManyField is not represented by a single column,
- # so return None.
- return None
- def db_parameters(self, connection):
- return {"type": None, "check": None}
|