How to access a field with reverse name = '+' in Django? - django

How do you define the reverse relation from another object to this one with a '+' as it's related name?
class FeaturedContentPage(Page):
featured_page = models.ForeignKey(
'wagtailcore.Page',
null=True,
blank=True,
on_delete=models.SET_NULL,
related_name='+',
)

The idea of a related_name*ending with a '+' is to disable creating a reverse relation, as is documented:
If youd prefer Django not to create a backwards relation, set related_name to '+' or end it with '+'.
You can of course still query in reverse with:
FeaturedContentPage.objects.filter(featured_page=my_page)
But there is thus no relation constructed in reverse, so my_page.featuredcontentpage_setis not accessible.

the related_name argument is used for reverse relation name . if a model has 2 field referencing the same model
featured_page = models.ForeignKey(
'wagtailcore.Page',
null=True,
blank=True,
on_delete=models.SET_NULL,
related_name='+',
)
regular_page = models.ForeignKey(
'wagtailcore.Page',
null=True,
blank=True,
on_delete=models.SET_NULL,
related_name='+',
)
without related_name='+' django will complain because it use wagtailcore.Page model name for reverse relation. as two attribute in object can not have same name by setting related_name='+' to one or both field will ignore creating reverse relation .

Related

How to make django association reference to itself

I have:
class Direction(models.Model):
left = models.OneToOneField(
'self', on_delete=models.SET_NULL, null=True, related_name='right')
right = models.OneToOneField(
'self', on_delete=models.SET_NULL, null=True, related_name='left')
The error:
ant.Direction.left: (fields.E302) Reverse accessor for 'ant.Direction.left' clashes with field name 'ant.Direction.right'.
HINT: Rename field 'ant.Direction.right', or add/change a related_name argument to the definition for field 'ant.Direction.left'.
How does one make this relationship so that a.left = b and b.right = a?
You can not use as related_name the same as the fields that have been defined. You likely do not want to work with two OneToOneFields anyway, you can define a single OneToOneField, and set the related name to the opposite, so:
class Direction(models.Model):
left = models.OneToOneField(
'self',
on_delete=models.SET_NULL,
null=True,
related_name='right'
)
# no right
So now if a direction a has as .left a direction b, then b has as .right the object a.
If there is no .right, then accessing .right will raise a Direction.DoesNotExist exception, we can however fix this issue by making use of another for the related_name, and work with a property that will wrap it in a try-except:
class Direction(models.Model):
left = models.OneToOneField(
'self',
on_delete=models.SET_NULL,
null=True,
related_name='_right'
)
#property
def right(self):
try:
return self._right
except Direction.DoesNotExist:
return None
#right.setter
def _set_right(self, value):
self._right = value

Django getting error: "Reverse accessor for" in Models

I am trying to create a db model using django inspect db and it is generating all the models but I am getting error.
I am using this command to generate db models for existing database:
python manage.py inspectdb > models.py
It is generating models accurately but in fileds such as this:
create_uid = models.ForeignKey('self', models.DO_NOTHING,db_column='create_uid', blank=True, null=True)
write_uid = models.ForeignKey('self',models.DO_NOTHING, db_column='write_uid', blank=True, null=True)
I am getting error:
polls.ResUsers.create_uid: (fields.E304) Reverse accessor for 'ResUsers.create_uid' clashes with reverse accessor for 'ResUsers.write_uid'.
HINT: Add or change a related_name argument to the definition for 'ResUsers.create_uid' or 'ResUsers.write_uid'.
polls.ResUsers.write_uid: (fields.E304) Reverse accessor for 'ResUsers.write_uid' clashes with reverse accessor for 'ResUsers.create_uid'.
HINT: Add or change a related_name argument to the definition for 'ResUsers.write_uid' or 'ResUsers.create_uid'.
I am adding related names like this:
create_uid = models.ForeignKey('self', models.DO_NOTHING,related_name='create_uid',db_column='create_uid', blank=True, null=True)
What should I do in order to use generated models. I am using postgres.
I am updating my question one of the answer worked for me when I am using it like this:
create_uid = models.ForeignKey(
'self',
models.DO_NOTHING,
db_column='create_uid',
related_name='created_items',
blank=True,
null=True
)
In one other model class when I am using this code like this:
create_uid = models.ForeignKey(
'ResUsers',
models.DO_NOTHING,
db_column='create_uid',
related_name='created_items',
blank=True,
null=True
)
I am getting the error:
polls.ResUsers.create_uid: (fields.E304) Reverse accessor for 'ResUsers.create_uid' clashes with reverse accessor for 'SurveyUserInput.create_uid'.
HINT: Add or change a related_name argument to the definition for 'ResUsers.create_uid' or 'SurveyUserInput.create_uid'.
The related_name=… [Django-doc] is the name of the relation in reverse. So it is meant to access all model objects with as create_uid/write_uid the object. This can result in a QuerySet of zero, one or more elements.
Therefore the related_names of two ForeignKeys to the same model, can not be the same, since that would make the model ambiguous. Since your ForeignKeys refer to the 'self' model, you can not even given these the name of a field that already exists.
You thus might want to give the relations a name like:
class MyModel(models.Model):
create_uid = models.ForeignKey(
'self',
models.DO_NOTHING,
db_column='create_uid',
related_name='created_items',
blank=True,
null=True
)
write_uid = models.ForeignKey(
'self',
models.DO_NOTHING,
db_column='write_uid',
related_name='written_items',
blank=True,
null=True
)

related_name argument required

I've recieved the following error and I'm not sure how to handle this in my model.
HINT: Add or change a related_name argument to the definition for 'UserCart.state_tax' or 'UserCart.fed_tax'.
userorders.UserCart.state_tax: (fields.E304) Reverse accessor for 'UserCart.state_tax' clashes with reverse accessor for 'UserCart.other_tax'.
models.py
class UserCart(models.Model):
user = models.ForeignKey(User, on_delete=models.CASCADE, default=None)
state_tax = models.ForeignKey(Tax, on_delete=models.SET_NULL, null=True)
fed_tax = models.ForeignKey(Tax, on_delete=models.SET_NULL, null=True)
This is here necessary, since you have two references from UserCart to the Tax model. This thus means that the relation in reverse (from Tax to UserCart) can not be usercart_set, since then it is not clear which relation we use in reverse.
We thus should at least give a related name to one of the relations (that is different from usercart_set). For example:
from django.contrib.auth import get_user_model
class UserCart(models.Model):
user = models.ForeignKey(get_user_model(), on_delete=models.CASCADE, default=None)
state_tax = models.ForeignKey(
Tax,
related_name='state_usercarts',
on_delete=models.SET_NULL,
null=True
)
fed_tax = models.ForeignKey(
Tax,
related_name='fed_usercarts',
on_delete=models.SET_NULL,
null=True
)
Note: you might want to make use of get_user_model [Django-doc] over a reference to User itself. If you later change your user model, then the ForeignKey will automatically refer to the new user model.

django prefetch_related not working

I am trying to export all my database with a prefetch_related but I only get data from the main model.
My models:
class GvtCompoModel(models.Model):
gvtCompo= models.CharField(max_length=1000, blank=False, null=False)
...
class ActsIdsModel(models.Model):
year = models.IntegerField(max_length=4, blank=False, null=False)
...
class RespProposModel(models.Model):
respPropos=models.CharField(max_length=50, unique=True)
nationResp = models.ForeignKey('NationRespModel', blank=True, null=True, default=None)
nationalPartyResp = models.ForeignKey('NationalPartyRespModel', blank=True, null=True, default=None)
euGroupResp = models.ForeignKey('EUGroupRespModel', blank=True, null=True, default=None)
class ActsInfoModel(models.Model):
#id of the act
actId = models.OneToOneField(ActsIdsModel, primary_key=True)
respProposId1=models.ForeignKey('RespProposModel', related_name='respProposId1', blank=True, null=True, default=None)
respProposId2=models.ForeignKey('RespProposModel', related_name='respProposId2', blank=True, null=True, default=None)
respProposId3=models.ForeignKey('RespProposModel', related_name='respProposId3', blank=True, null=True, default=None)
gvtCompo= models.ManyToManyField(GvtCompoModel)
My view:
dumpDB=ActsInfoModel.objects.all().prefetch_related("actId", "respProposId1", "respProposId2", "respProposId3", "gvtCompo")
for act in dumpDB.values():
for field in act:
print "dumpDB field", field
When I display "field", I see the fields from ActsInfoModel ONLY, the starting model. Is it normal?
You haven't understood the arguments to prefetch_related. It's not a list of fields, but a list of models.
(Note that your field naming convention is also very misleading - respProposId1 and actId are not IDs, but actual instances of the models. Django has created an underlying field in each case by appending _id, so the db columns are respProposId1_id and actId_id. You should just call the fields resp_propos1 and resp_propos2 - also note that normal style is lower_case_with_underscore, not capWords.)
It is normal, that you are seeing fields from ActsInfoModel only. You can access related models via dot notation, like:
acts = ActsInfoModel.objects.all().prefetch_related("actId", "respProposId1", "respProposId2", "respProposId3", "gvtCompo")
for act in acts:
print act.respProposId1.respPropos
Related models are already prefetched, so it won't produce any additional queries. FYI, quote from docs:
Returns a QuerySet that will automatically retrieve, in a single
batch, related objects for each of the specified lookups.

Django models: Why the name clash?

Firstly, I know how to fix the problem, I'm just trying to understand why it's occuring. The error message:
users.profile: Reverse query name for field 'address' clashes with related field 'Address.profile'. Add a related_name a
rgument to the definition for 'address'.
And the code:
class Address(models.Model):
country = fields.CountryField(default='CA')
province = fields.CAProvinceField()
city = models.CharField(max_length=80)
postal_code = models.CharField(max_length=6)
street1 = models.CharField(max_length=80)
street2 = models.CharField(max_length=80, blank=True, null=True)
street3 = models.CharField(max_length=80, blank=True, null=True)
class Profile(Address):
user = models.ForeignKey(User, unique=True, related_name='profile')
primary_phone = models.CharField(max_length=20)
address = models.ForeignKey(Address, unique=True)
If I understand correctly, this line:
address = models.ForeignKey(Address, unique=True)
Will cause an attribute to be added to the Address class with the name profile. What's creating the other "profile" name?
What if I don't need a reverse name? Is there a way to disable it? Addresses are used for a dozen things, so most of the reverse relationships will be blank anyway.
Is there a way to copy the address fields into the model rather than having a separate table for addresses? Without Python inheritance (this doesn't make sense, and if an Model has 2 addresses, it doesn't work).
in the django docs it says:
If you'd prefer Django didn't create a backwards relation, set related_name to '+'. For example, this will ensure that the User model won't get a backwards relation to this model:
user = models.ForeignKey(User, related_name='+')
but I never tried it myself....
I'm not sure where the errant profile field is coming from… But one way to find out would be: temporary remove address = models.ForeignKey(…) from Profile, ./manage.py shell, from ... import Address then see what Address.profile will tell you.
I don't think there is any official way to inherit only the fields from some other Model without using inheritance… But you could fake it like this (where SourceModel is, eg, Address and TargetModel is, eg, Profile):
for field in SourceModel._meta.fields:
TargetModel.add_to_class(field.name, copy.deepcopy(field))
(this is coming from Django's ModelBase __new__ implementation)
I don't think it's possible to disable the reverse name.
I've just done a quick grep over the code and it doesn't look like there is any logic which will bypass setting up the related_name field on the related model.
For Example: Add just '+'
class GeneralConfiguration(models.Model):
created_at = models.DateTimeField(editable=False, default=settings.DEFAULT_DATE)
updated_at = models.DateTimeField(editable=False, default=settings.DEFAULT_DATE)
created_by = models.ForeignKey(settings.AUTH_USER_MODEL, blank=True, null=True, on_delete=models.PROTECT, related_name='+')
updated_by = models.ForeignKey(settings.AUTH_USER_MODEL, blank=True, null=True, on_delete=models.PROTECT, related_name='+')