Merge branch 'sevdog-master'

Author: sect2k

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 *.pyc
 .vscode
+.python-version
 /dist
 /*.egg-info
 /build

README.md

@@ -80,6 +80,14 @@ admin.site.register(MailingList, MailingListAdmin)
 
 With just a few lines of code you get a fully functional `ModelAdmin`, that will automatically pull in just the relevant related objects, based on `ForeignKey` relation between the two models, it will also auto set `ForeignKey` fields for nested relations and exclude them from change form when adding and editing objects on subadmin.
 
+
+### Caveats
+
+In order to properly support unique field validation (see #7), `SubAdmin` will inject a small mixin into the form. This is done in the `get_form` method and if you override this method in your own classes, make sure to call `super()` or `perp_subadmin_form()` directly. See `subadmin` source code for more details.
+
+Also, the injected mixin `SubAdminFormMixin` overrides `validate_unique` on the form. If your custom form overrides this method as well, have a look at `subadmin` source code for ways in which it differs from stock `ModelForm` implementation.
+
+
 ### Screenshots
 
 ![alt text](https://github.com/inueni/django-subadmin-example/raw/master/screenshots/subadmin_screenshot_1.png?raw=true)
@@ -100,7 +108,6 @@ When adding or editing objects with `SubAdmin`, `ForeignKey` fields to parent in
 
 > If you want to see it in action, or get a more in-depth look at how to set everything up, check out <https://github.com/inueni/django-subadmin-example>.
 
-
 ## Stability
 
 `django-subadmin` has evolved from code that has been running on production servers since early 2014 without any issues. The code is provided **as-is** and the developers bear no responsibility for any issues stemming from it's use.

subadmin/__init__.py

@@ -4,6 +4,7 @@
 from urllib.parse import parse_qsl, urlparse, urlunparse
 
 from django.urls import path, re_path, include
+from django.core.exceptions import ValidationError
 from django.contrib.admin.options import IS_POPUP_VAR, TO_FIELD_VAR
 from django.contrib.admin.utils import unquote, quote
 from django.contrib import admin
@@ -14,7 +15,7 @@
 from django.forms.models import _get_foreign_key
 from django.http import HttpResponseRedirect
 from django.shortcuts import get_object_or_404
-from django.template.response import SimpleTemplateResponse
+from django.template.response import TemplateResponse
 from django.utils.decorators import method_decorator
 from django.utils.functional import cached_property
 from django.utils.html import format_html
@@ -25,7 +26,7 @@
 
 csrf_protect_m = method_decorator(csrf_protect)
 
-__all__ = ('SubAdmin', 'RootSubAdmin', 'SubAdminMixin', 'RootSubAdminMixin', 'SubAdminChangeList', 'SubAdminHelper')
+__all__ = ('SubAdmin', 'RootSubAdmin', 'SubAdminMixin', 'RootSubAdminMixin', 'SubAdminChangeList', 'SubAdminHelper', 'SubAdminFormMixin')
 
 
 class SubAdminHelper(object):
@@ -37,15 +38,14 @@ def __init__(self, sub_admin, view_args, object_id=None):
         self.view_args = view_args
         self.base_viewname = sub_admin.get_base_viewname()
         self.load_tree(sub_admin)
-        
-        
+
     def load_tree(self, sub_admin):
         parent_admin = sub_admin.parent_admin
         fk_lookup = sub_admin.fk_name
 
         i = 2 if self.object_id else 1
         while parent_admin:
-            obj = sub_admin.get_parent_instance(self.view_args[i * -1])
+            obj = sub_admin.get_parent_instance(self.view_args[-i])
             self.parents.append({
                 'admin': parent_admin,
                 'object': obj,
@@ -57,13 +57,13 @@ def load_tree(self, sub_admin):
             parent_admin = getattr(sub_admin, 'parent_admin', None)
             if parent_admin:
                 fk_lookup = '%s__%s' % (fk_lookup, sub_admin.fk_name)
-            
+
             i += 1
-    
+
     @cached_property
     def parent(self):
         return self.parents[0]
-    
+
     @cached_property
     def root(self):
         return self.parents[-1]
@@ -87,6 +87,38 @@ def url_for_result(self, result):
         return self.model_admin.reverse_url('change', *self.model_admin.get_base_url_args(self.request) + [pk])
 
 
+class SubAdminFormMixin(object):
+    def _post_clean(self):
+        validate_unique = self._validate_unique
+        self._validate_unique = False
+        super()._post_clean()
+
+        for fk_field, fk_instance in self._related_instances_fields.items():
+            setattr(self.instance, fk_field, fk_instance)
+
+        self._validate_unique = validate_unique
+        if self._validate_unique:
+            self.validate_unique()
+
+        
+    def validate_unique(self):
+        exclude = self._get_subadmin_validation_exclusions()
+
+        try:
+            self.instance.validate_unique(exclude=exclude)
+        except ValidationError as e:
+            self._update_errors(e)
+
+    def _get_subadmin_validation_exclusions(self):
+        return [f for f in self._get_validation_exclusions() if f not in self._related_instances_fields.keys()]
+
+    @cached_property
+    def _related_instances_fields(self):
+        return {
+            key: self._related_instances[key] for key in self._related_instances.keys() if key in self._meta.model._meta._forward_fields_map.keys()
+        }
+
+
 class SubAdminBase(object):
     subadmins = None
 
@@ -104,7 +136,7 @@ def get_subadmin_urls(self):
             ]
 
             urlpatterns += urls
-        
+
         return urlpatterns
 
     def render_change_form(self, request, context, add=False, change=False, form_url='', obj=None):
@@ -117,7 +149,7 @@ def render_change_form(self, request, context, add=False, change=False, form_url
                         'name': modeladmin.model._meta.verbose_name_plural,
                         'url': modeladmin.reverse_url('changelist', *url_args),
                     })
-        
+
         context.update({'subadmin_links': subadmin_links})
         return super().render_change_form(request, context, add=add, change=change,
                                                                       form_url=form_url, obj=obj)
@@ -142,7 +174,7 @@ def __init__(self, parent_model, parent_admin):
             self.fk_name = _get_foreign_key(parent_model, self.model).name
 
         super().__init__(self.model, parent_admin.admin_site)
-        
+
         self.subadmin_instances = self.get_subadmin_instances()
 
     def get_subadmin_helper(self, view_args, object_id=None):
@@ -198,11 +230,17 @@ def get_exclude(self, request, obj=None):
         exclude.extend(request.subadmin.related_instances.keys())
         return list(set(exclude))
 
-    def save_model(self, request, obj, form, change):
-        for fk_field, instance in request.subadmin.related_instances.items():
-            if fk_field in self.model._meta._forward_fields_map.keys():
-                setattr(obj, fk_field, instance)
-        super().save_model(request, obj, form, change)
+    def prep_subadmin_form(self, request, form):
+        attrs = {'_related_instances': request.subadmin.related_instances}
+        return type(form)(form.__name__, (SubAdminFormMixin, form), attrs)
+
+    def get_form(self, request, obj=None, **kwargs):
+        form = super().get_form(request, obj, **kwargs)
+        return self.prep_subadmin_form(request, form)
+
+    def get_changelist_form(self, request, **kwargs):
+        form = super().get_changelist_form(request, **kwargs)
+        return self.prep_subadmin_form(request, form)
 
     def get_base_viewname(self):
         if hasattr(self.parent_admin, 'get_base_viewname'):
@@ -220,7 +258,7 @@ def get_base_url_args(self, request):
         if hasattr(request, 'subadmin'):
             return request.subadmin.base_url_args
         return []
-        
+
     def context_add_parent_data(self, request, context=None):
         context = context or {}
         parent_instance = request.subadmin.parent_instance
@@ -229,7 +267,7 @@ def context_add_parent_data(self, request, context=None):
             'parent_opts': parent_instance._meta,
         })
         return context
-    
+
     def get_parent_instance(self, parent_id):
         return get_object_or_404(self.parent_model, pk=unquote(parent_id))
 
@@ -327,16 +365,16 @@ def response_add(self, request, obj, post_url_continue=None):
 
         if "_saveasnew" in request.POST:
             url_args = url_args[:-1]
-        
+
         obj_url = self.reverse_url('change', *url_args + [quote(pk_value)])
-        
+
         if self.has_change_permission(request, obj):
             obj_repr = format_html('<a href="{}">{}</a>', urlquote(obj_url), obj)
         else:
             obj_repr = str(obj)
-        
+
         msg_dict = {
-            'name': str(opts.verbose_name),
+            'name': opts.verbose_name,
             'obj': obj_repr,
         }
 
@@ -351,7 +389,11 @@ def response_add(self, request, obj, post_url_continue=None):
                 'value': str(value),
                 'obj': str(obj),
             })
-            return SimpleTemplateResponse('admin/popup_response.html', {
+            return TemplateResponse(request, self.popup_response_template or [
+                'admin/%s/%s/popup_response.html' % (opts.app_label, opts.model_name),
+                'admin/%s/popup_response.html' % opts.app_label,
+                'admin/popup_response.html',
+            ], {
                 'popup_response_data': popup_response_data,
             })
 
@@ -389,7 +431,7 @@ def response_add(self, request, obj, post_url_continue=None):
             )
             self.message_user(request, msg, messages.SUCCESS)
             return self.response_post_save_add(request, obj)
-    
+
     def response_change(self, request, obj):
         if IS_POPUP_VAR in request.POST:
             to_field = request.POST.get(TO_FIELD_VAR)
@@ -402,7 +444,11 @@ def response_change(self, request, obj):
                 'obj': str(obj),
                 'new_value': str(new_value),
             })
-            return SimpleTemplateResponse('admin/popup_response.html', {
+            return TemplateResponse(request, self.popup_response_template or [
+                'admin/%s/%s/popup_response.html' % (opts.app_label, opts.model_name),
+                'admin/%s/popup_response.html' % opts.app_label,
+                'admin/popup_response.html',
+            ], {
                 'popup_response_data': popup_response_data,
             })
 
@@ -472,7 +518,7 @@ def response_post_save_change(self, request, obj):
         else:
             post_url = reverse('admin:index', current_app=self.admin_site.name)
         return HttpResponseRedirect(post_url)
-    
+
     def response_delete(self, request, obj_display, obj_id):
         opts = self.model._meta
 
@@ -481,7 +527,11 @@ def response_delete(self, request, obj_display, obj_id):
                 'action': 'delete',
                 'value': str(obj_id),
             })
-            return SimpleTemplateResponse('admin/popup_response.html', {
+            return TemplateResponse(request, self.popup_response_template or [
+                'admin/%s/%s/popup_response.html' % (opts.app_label, opts.model_name),
+                'admin/%s/popup_response.html' % opts.app_label,
+                'admin/popup_response.html',
+            ], {
                 'popup_response_data': popup_response_data,
             })
 
@@ -510,7 +560,7 @@ class RootSubAdminMixin(SubAdminBase):
 
     def __init__(self, *args, **kwargs):
         super().__init__(*args, **kwargs)
-        self.subadmin_instances = self.get_subadmin_instances()     
+        self.subadmin_instances = self.get_subadmin_instances()
 
     def get_urls(self):
         return self.get_subadmin_urls() + super().get_urls()