Как мне отфильтровать выбор ForeignKey в Django ModelForm?

227

Скажем, у меня есть следующее в моем models.py:

class Company(models.Model):
   name = ...

class Rate(models.Model):
   company = models.ForeignKey(Company)
   name = ...

class Client(models.Model):
   name = ...
   company = models.ForeignKey(Company)
   base_rate = models.ForeignKey(Rate)

Т.е. есть несколько Companies, каждый из которых имеет диапазон Ratesи Clients. У каждого Clientдолжна быть база Rate, выбранная из родительского Company's Rates, а не другого Company's Rates.

При создании формы для добавления Clientя хотел бы удалить Companyварианты (которые уже были выбраны с помощью кнопки «Добавить клиента» на Companyстранице) и также ограничить Rateварианты выбора Company.

Как мне сделать это в Django 1.0?

Мой текущий forms.pyфайл просто шаблонный на данный момент:

from models import *
from django.forms import ModelForm

class ClientForm(ModelForm):
    class Meta:
        model = Client

И views.pyэто также является основным:

from django.shortcuts import render_to_response, get_object_or_404
from models import *
from forms import *

def addclient(request, company_id):
    the_company = get_object_or_404(Company, id=company_id)

    if request.POST:
        form = ClientForm(request.POST)
        if form.is_valid():
            form.save()
            return HttpResponseRedirect(the_company.get_clients_url())
    else:
        form = ClientForm()

    return render_to_response('addclient.html', {'form': form, 'the_company':the_company})

В Django 0.96 я смог взломать это, выполнив что-то вроде следующего перед рендерингом шаблона:

manipulator.fields[0].choices = [(r.id,r.name) for r in Rate.objects.filter(company_id=the_company.id)]

ForeignKey.limit_choices_toкажется многообещающим, но я не знаю, как пройти, the_company.idи я не уверен , будет ли это работать вне интерфейса администратора в любом случае.

Спасибо. (Это похоже на довольно простой запрос, но если мне нужно что-то изменить, я открыт для предложений.)

Том
источник
Спасибо за подсказку к "limit_choices_to". Это не решает ваш вопрос, но мой :-) Документы: docs.djangoproject.com/en/dev/ref/models/fields/…
guettli

Ответы:

243

ForeignKey представлен django.forms.ModelChoiceField, который является ChoiceField, чьи выборы являются моделью QuerySet. Смотрите ссылку для ModelChoiceField .

Итак, предоставьте QuerySet для querysetатрибута поля . Зависит от того, как строится ваша форма. Если вы создадите явную форму, у вас будут поля с именами напрямую.

form.rate.queryset = Rate.objects.filter(company_id=the_company.id)

Если вы берете объект ModelForm по умолчанию, form.fields["rate"].queryset = ...

Это сделано явно в представлении. Нет взлома вокруг.

С. Лотт
источник
Хорошо, это звучит многообещающе. Как получить доступ к соответствующему объекту поля? form.company.QuerySet = Rate.objects.filter (company_id = the_company.id)? или через словарь?
Том
1
Хорошо, спасибо за расширение примера, но я, кажется, должен использовать form.fields ["rate"]. Queryset, чтобы избежать "У объекта ClientForm нет атрибута" rate "", я что-то упустил? (и ваш пример должен быть form.rate.queryset, чтобы быть также согласованным.)
Том
8
Не лучше ли установить набор запросов полей в __init__методе формы ?
Лакшман Прасад
1
@ Последний комментарий неправильный (или мой сайт не должен работать :). Вы можете заполнить данные проверки, сделав вызов super (...) .__ init__ в переопределенном методе. Если вы делаете несколько из этих изменений набора запросов, гораздо более элегантно упаковать их, переопределив метод init .
Майкл
3
@ Слотт ура, я добавил ответ, потому что для объяснения потребуется более 600 символов. Даже если этот вопрос старый, он получает высокий балл Google.
Майкл
135

В дополнение к ответу С. Лотта и упоминанию в комментариях Гуру, можно добавить фильтры набора запросов, переопределив ModelForm.__init__функцию. (Это может быть легко применимо к обычным формам), это может помочь с повторным использованием и поддерживает функцию представления в чистоте.

class ClientForm(forms.ModelForm):
    def __init__(self,company,*args,**kwargs):
        super (ClientForm,self ).__init__(*args,**kwargs) # populates the post
        self.fields['rate'].queryset = Rate.objects.filter(company=company)
        self.fields['client'].queryset = Client.objects.filter(company=company)

    class Meta:
        model = Client

def addclient(request, company_id):
        the_company = get_object_or_404(Company, id=company_id)

        if request.POST:
            form = ClientForm(the_company,request.POST)  #<-- Note the extra arg
            if form.is_valid():
                form.save()
                return HttpResponseRedirect(the_company.get_clients_url())
        else:
            form = ClientForm(the_company)

        return render_to_response('addclient.html', 
                                  {'form': form, 'the_company':the_company})

Это может быть полезно для повторного использования, например, если у вас есть общие фильтры, необходимые для многих моделей (обычно я объявляю абстрактный класс Form). Например

class UberClientForm(ClientForm):
    class Meta:
        model = UberClient

def view(request):
    ...
    form = UberClientForm(company)
    ...

#or even extend the existing custom init
class PITAClient(ClientForm):
    def __init__(company, *args, **args):
        super (PITAClient,self ).__init__(company,*args,**kwargs)
        self.fields['support_staff'].queryset = User.objects.exclude(user='michael')

Кроме этого, я просто перевожу материал блога Django, из которого есть много хороших.

Майкл
источник
В вашем первом фрагменте кода есть опечатка, вы определяете аргументы дважды в __init __ () вместо args и kwargs.
TPK
6
Мне нравится этот ответ лучше, я думаю, что более чистым является инкапсуляция логики инициализации формы в классе формы, а не в методе представления. Ура!
Симметричный
44

Это просто и работает с Django 1.4:

class ClientAdminForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super(ClientAdminForm, self).__init__(*args, **kwargs)
        # access object through self.instance...
        self.fields['base_rate'].queryset = Rate.objects.filter(company=self.instance.company)

class ClientAdmin(admin.ModelAdmin):
    form = ClientAdminForm
    ....

Вам не нужно указывать это в классе формы, но вы можете сделать это непосредственно в ModelAdmin, так как Django уже включает этот встроенный метод в ModelAdmin (из документации):

ModelAdmin.formfield_for_foreignkey(self, db_field, request, **kwargs
'''The formfield_for_foreignkey method on a ModelAdmin allows you to 
   override the default formfield for a foreign keys field. For example, 
   to return a subset of objects for this foreign key field based on the
   user:'''

class MyModelAdmin(admin.ModelAdmin):
    def formfield_for_foreignkey(self, db_field, request, **kwargs):
        if db_field.name == "car":
            kwargs["queryset"] = Car.objects.filter(owner=request.user)
        return super(MyModelAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs)

Еще более изящный способ сделать это (например, создать интерфейсный интерфейс администратора, к которому могут обращаться пользователи) - создать подкласс ModelAdmin и затем изменить методы, указанные ниже. Конечным результатом является пользовательский интерфейс, который показывает ТОЛЬКО контент, связанный с ними, позволяя вам (суперпользователю) видеть все.

Я переопределил четыре метода, первые два не позволяют пользователю что-либо удалить, а также удаляют кнопки удаления с сайта администратора.

Третье переопределение фильтрует любой запрос, который содержит ссылку (в примере «пользователь» или «дикобраз» (просто в качестве иллюстрации).

Последнее переопределение фильтрует любое поле внешнего ключа в модели, чтобы отфильтровать доступные варианты, такие же, как и базовый набор запросов.

Таким образом, вы можете представить простой в управлении фронтальный сайт администратора, который позволяет пользователям связываться с их собственными объектами, и вам не нужно вводить конкретные фильтры ModelAdmin, о которых мы говорили выше.

class FrontEndAdmin(models.ModelAdmin):
    def __init__(self, model, admin_site):
        self.model = model
        self.opts = model._meta
        self.admin_site = admin_site
        super(FrontEndAdmin, self).__init__(model, admin_site)

удалить кнопки «удалить»:

    def get_actions(self, request):
        actions = super(FrontEndAdmin, self).get_actions(request)
        if 'delete_selected' in actions:
            del actions['delete_selected']
        return actions

предотвращает удаление разрешения

    def has_delete_permission(self, request, obj=None):
        return False

Фильтрует объекты, которые можно просмотреть на сайте администратора:

    def get_queryset(self, request):
        if request.user.is_superuser:
            try:
                qs = self.model.objects.all()
            except AttributeError:
                qs = self.model._default_manager.get_queryset()
            return qs

        else:
            try:
                qs = self.model.objects.all()
            except AttributeError:
                qs = self.model._default_manager.get_queryset()

            if hasattr(self.model, user’):
                return qs.filter(user=request.user)
            if hasattr(self.model, porcupine’):
                return qs.filter(porcupine=request.user.porcupine)
            else:
                return qs

Фильтрует выбор для всех полей Foreignkey на сайте администратора:

    def formfield_for_foreignkey(self, db_field, request, **kwargs):
        if request.employee.is_superuser:
            return super(FrontEndAdmin, self).formfield_for_foreignkey(db_field, request, **kwargs)

        else:
            if hasattr(db_field.rel.to, 'user'):
                kwargs["queryset"] = db_field.rel.to.objects.filter(user=request.user)
            if hasattr(db_field.rel.to, 'porcupine'):
                kwargs["queryset"] = db_field.rel.to.objects.filter(porcupine=request.user.porcupine)
            return super(ModelAdminFront, self).formfield_for_foreignkey(db_field, request, **kwargs)
neil.millikin
источник
1
И я должен добавить, что это хорошо работает как универсальная настраиваемая форма для нескольких моделадминов с похожими интересующими областями ссылок.
nemesisfixx
Это лучший ответ, если вы используете Django 1.4+
Рик Вестера
16

Для этого используется общий вид, например CreateView ...

class AddPhotoToProject(CreateView):
    """
    a view where a user can associate a photo with a project
    """
    model = Connection
    form_class = CreateConnectionForm


    def get_context_data(self, **kwargs):
        context = super(AddPhotoToProject, self).get_context_data(**kwargs)
        context['photo'] = self.kwargs['pk']
        context['form'].fields['project'].queryset = Project.objects.for_user(self.request.user)
        return context
    def form_valid(self, form):
        pobj = Photo.objects.get(pk=self.kwargs['pk'])
        obj = form.save(commit=False)
        obj.photo = pobj
        obj.save()

        return_json = {'success': True}

        if self.request.is_ajax():

            final_response = json.dumps(return_json)
            return HttpResponse(final_response)

        else:

            messages.success(self.request, 'photo was added to project!')
            return HttpResponseRedirect(reverse('MyPhotos'))

самая важная часть этого ...

    context['form'].fields['project'].queryset = Project.objects.for_user(self.request.user)

, Прочитать мой пост здесь

teewuane
источник
4

Если вы еще не создали форму и хотите изменить набор запросов, вы можете сделать следующее:

formmodel.base_fields['myfield'].queryset = MyModel.objects.filter(...)

Это очень полезно, когда вы используете общие представления!

Hassek
источник
2

Итак, я действительно пытался понять это, но кажется, что Джанго все еще не делает это очень простым. Я не настолько глуп, но просто не вижу ни одного (несколько) простого решения.

Я нахожу довольно уродливым переопределение представлений Admin для такого рода вещей, и каждый найденный мной пример никогда полностью не применим к представлениям Admin.

Это настолько распространенное обстоятельство, с моделями, которые я делаю, что я нахожу ужасным, что нет очевидного решения этого ...

У меня есть эти классы:

# models.py
class Company(models.Model):
    # ...
class Contract(models.Model):
    company = models.ForeignKey(Company)
    locations = models.ManyToManyField('Location')
class Location(models.Model):
    company = models.ForeignKey(Company)

Это создает проблему при настройке Администратора для Компании, поскольку в нем есть встроенные строки для Контракта и Местоположения, а параметры Контейнера в м2м для Местоположения не фильтруются должным образом в соответствии с Компанией, которую вы в настоящее время редактируете.

Короче говоря, мне понадобится опция администратора, чтобы сделать что-то вроде этого:

# admin.py
class LocationInline(admin.TabularInline):
    model = Location
class ContractInline(admin.TabularInline):
    model = Contract
class CompanyAdmin(admin.ModelAdmin):
    inlines = (ContractInline, LocationInline)
    inline_filter = dict(Location__company='self')

В конечном счете, мне было бы все равно, был ли процесс фильтрации размещен в базе CompanyAdmin или в ContractInline. (Размещение его в строке имеет больше смысла, но затрудняет ссылаться на базовый контракт как на «себя».)

Есть ли кто-нибудь, кто знает что-то столь же простое, как этот крайне необходимый ярлык? Когда я делал PHP администраторов для такого рода вещей, это считалось основной функциональностью! На самом деле, он всегда был автоматическим и должен был быть отключен, если вы действительно этого не хотели!

Тим
источник
0

Более публичным способом является вызов get_form в классах Admin. Это также работает для полей без базы данных. Например, здесь у меня есть поле с именем «_terminal_list» в форме, которое можно использовать в особых случаях для выбора нескольких конечных элементов из get_list (запрос), а затем фильтрации на основе request.user:

class ChangeKeyValueForm(forms.ModelForm):  
    _terminal_list = forms.ModelMultipleChoiceField( 
queryset=Terminal.objects.all() )

    class Meta:
        model = ChangeKeyValue
        fields = ['_terminal_list', 'param_path', 'param_value', 'scheduled_time',  ] 

class ChangeKeyValueAdmin(admin.ModelAdmin):
    form = ChangeKeyValueForm
    list_display = ('terminal','task_list', 'plugin','last_update_time')
    list_per_page =16

    def get_form(self, request, obj = None, **kwargs):
        form = super(ChangeKeyValueAdmin, self).get_form(request, **kwargs)
        qs, filterargs = Terminal.get_list(request)
        form.base_fields['_terminal_list'].queryset = qs
        return form
F.Tamy
источник