class BaseDeleteView
from django.views.generic.edit import BaseDeleteView
Base view for deleting an object. Using this base class requires subclassing to provide a response mixin.
Ancestors (MRO)
- BaseDeleteView
 - DeletionMixin
 - BaseDetailView
 - SingleObjectMixin
 - ContextMixin
 - View
 
Descendants
Attributes
| Defined in | |
|---|---|
                                    
                                        context_object_name = None
                                    
                                 | 
                                SingleObjectMixin | 
                                    
                                        http_method_names = [u'get', u'post', u'put', u'patch', u'delete', u'head', u'options', u'trace']
                                    
                                 | 
                                View | 
                                    
                                        model = None
                                    
                                 | 
                                SingleObjectMixin | 
                                    
                                        pk_url_kwarg = 'pk'
                                    
                                 | 
                                SingleObjectMixin | 
                                    
                                        queryset = None
                                    
                                 | 
                                SingleObjectMixin | 
                                    
                                        slug_field = 'slug'
                                    
                                 | 
                                SingleObjectMixin | 
                                    
                                        slug_url_kwarg = 'slug'
                                    
                                 | 
                                SingleObjectMixin | 
                                    
                                        success_url = None
                                    
                                 | 
                                DeletionMixin | 
Methods
                            
                                
                                    def
                                    __init__(self, **kwargs):
                                
                                
                                    View
                                
                                ¶
                            
                        
                        
                                    def
                                    __init__(self, **kwargs):
                                
                                
                                    View
                                
                                ¶
                            Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things.
36 37 38 39 40 41 42 43 44  | def __init__(self, **kwargs): """ Constructor. Called in the URLconf; can contain helpful extra keyword arguments, and other things. """ # Go through keyword arguments, and either save their values to our # instance, or raise an error. for key, value in six.iteritems(kwargs): setattr(self, key, value)  | 
                            
                                
                                    def
                                    _allowed_methods(self):
                                
                                
                                    View
                                
                                ¶
                            
                        
                        
                                    def
                                    _allowed_methods(self):
                                
                                
                                    View
                                
                                ¶
                            107 108  | def _allowed_methods(self): return [m.upper() for m in self.http_method_names if hasattr(self, m)]  | 
                            
                                
                                    def
                                    as_view(cls, **initkwargs):
                                
                                
                                    View
                                
                                ¶
                            
                        
                        
                                    def
                                    as_view(cls, **initkwargs):
                                
                                
                                    View
                                
                                ¶
                            Main entry point for a request-response process.
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74  | @classonlymethod def as_view(cls, **initkwargs): """ Main entry point for a request-response process. """ # sanitize keyword arguments for key in initkwargs: if key in cls.http_method_names: raise TypeError("You tried to pass in the %s method name as a " "keyword argument to %s(). Don't do that." % (key, cls.__name__)) if not hasattr(cls, key): raise TypeError("%s() received an invalid keyword %r. as_view " "only accepts arguments that are already " "attributes of the class." % (cls.__name__, key)) def view(request, *args, **kwargs): self = cls(**initkwargs) if hasattr(self, 'get') and not hasattr(self, 'head'): self.head = self.get self.request = request self.args = args self.kwargs = kwargs return self.dispatch(request, *args, **kwargs) # take name and docstring from class update_wrapper(view, cls, updated=()) # and possible attributes set by decorators # like csrf_exempt from dispatch update_wrapper(view, cls.dispatch, assigned=()) return view  | 
                            
                                
                                    def
                                    delete(self, request, *args, **kwargs):
                                
                                
                                    DeletionMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    delete(self, request, *args, **kwargs):
                                
                                
                                    DeletionMixin
                                
                                ¶
                            Calls the delete() method on the fetched object and then redirects to the success URL.
245 246 247 248 249 250 251 252 253  | def delete(self, request, *args, **kwargs): """ Calls the delete() method on the fetched object and then redirects to the success URL. """ self.object = self.get_object() success_url = self.get_success_url() self.object.delete() return HttpResponseRedirect(success_url)  | 
                            
                                
                                    def
                                    dispatch(self, request, *args, **kwargs):
                                
                                
                                    View
                                
                                ¶
                            
                        
                        
                                    def
                                    dispatch(self, request, *args, **kwargs):
                                
                                
                                    View
                                
                                ¶
                            79 80 81 82 83 84 85 86 87  | def dispatch(self, request, *args, **kwargs): # Try to dispatch to the right method; if a method doesn't exist, # defer to the error handler. Also defer to the error handler if the # request method isn't on the approved list. if request.method.lower() in self.http_method_names: handler = getattr(self, request.method.lower(), self.http_method_not_allowed) else: handler = self.http_method_not_allowed return handler(request, *args, **kwargs)  | 
                            
                                
                                    def
                                    get(self, request, *args, **kwargs):
                                
                                
                                    BaseDetailView
                                
                                ¶
                            
                        
                        
                                    def
                                    get(self, request, *args, **kwargs):
                                
                                
                                    BaseDetailView
                                
                                ¶
                            109 110 111 112  | def get(self, request, *args, **kwargs): self.object = self.get_object() context = self.get_context_data(object=self.object) return self.render_to_response(context)  | 
                            
                                
                                    def
                                    get_context_data(self, **kwargs):
                                
                                
                                ¶
                            
                        
                        
                                    def
                                    get_context_data(self, **kwargs):
                                
                                
                                ¶
                            
                                            SingleObjectMixin
                                        
                                        Insert the single object into the context dict.
91 92 93 94 95 96 97 98 99 100 101 102  | def get_context_data(self, **kwargs): """ Insert the single object into the context dict. """ context = {} if self.object: context['object'] = self.object context_object_name = self.get_context_object_name(self.object) if context_object_name: context[context_object_name] = self.object context.update(kwargs) return super(SingleObjectMixin, self).get_context_data(**context)  | 
                                            ContextMixin
                                        
                                        22 23 24 25  | def get_context_data(self, **kwargs): if 'view' not in kwargs: kwargs['view'] = self return kwargs  | 
                            
                                
                                    def
                                    get_context_object_name(self, obj):
                                
                                
                                    SingleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_context_object_name(self, obj):
                                
                                
                                    SingleObjectMixin
                                
                                ¶
                            Get the name to use for the object.
80 81 82 83 84 85 86 87 88 89  | def get_context_object_name(self, obj): """ Get the name to use for the object. """ if self.context_object_name: return self.context_object_name elif isinstance(obj, models.Model): return obj._meta.model_name else: return None  | 
                            
                                
                                    def
                                    get_object(self, queryset=None):
                                
                                
                                    SingleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_object(self, queryset=None):
                                
                                
                                    SingleObjectMixin
                                
                                ¶
                            Returns the object the view is displaying. By default this requires `self.queryset` and a `pk` or `slug` argument in the URLconf, but subclasses can override this to return any object.
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51  | def get_object(self, queryset=None): """ Returns the object the view is displaying. By default this requires `self.queryset` and a `pk` or `slug` argument in the URLconf, but subclasses can override this to return any object. """ # Use a custom queryset if provided; this is required for subclasses # like DateDetailView if queryset is None: queryset = self.get_queryset() # Next, try looking up by primary key. pk = self.kwargs.get(self.pk_url_kwarg, None) slug = self.kwargs.get(self.slug_url_kwarg, None) if pk is not None: queryset = queryset.filter(pk=pk) # Next, try looking up by slug. elif slug is not None: slug_field = self.get_slug_field() queryset = queryset.filter(**{slug_field: slug}) # If none of those are defined, it's an error. else: raise AttributeError("Generic detail view %s must be called with " "either an object pk or a slug." % self.__class__.__name__) try: # Get the single item from the filtered queryset obj = queryset.get() except ObjectDoesNotExist: raise Http404(_("No %(verbose_name)s found matching the query") % {'verbose_name': queryset.model._meta.verbose_name}) return obj  | 
                            
                                
                                    def
                                    get_queryset(self):
                                
                                
                                    SingleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_queryset(self):
                                
                                
                                    SingleObjectMixin
                                
                                ¶
                            Get the queryset to look an object up against. May not be called if `get_object` is overridden.
58 59 60 61 62 63 64 65 66 67 68 69 70 71 72  | def get_queryset(self): """ Get the queryset to look an object up against. May not be called if `get_object` is overridden. """ if self.queryset is None: if self.model: return self.model._default_manager.all() else: raise ImproperlyConfigured("%(cls)s is missing a queryset. Define " "%(cls)s.model, %(cls)s.queryset, or override " "%(cls)s.get_queryset()." % { 'cls': self.__class__.__name__ }) return self.queryset._clone()  | 
                            
                                
                                    def
                                    get_slug_field(self):
                                
                                
                                    SingleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_slug_field(self):
                                
                                
                                    SingleObjectMixin
                                
                                ¶
                            Get the name of a slug field to be used to look up by slug.
74 75 76 77 78  | def get_slug_field(self): """ Get the name of a slug field to be used to look up by slug. """ return self.slug_field  | 
                            
                                
                                    def
                                    get_success_url(self):
                                
                                
                                    DeletionMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_success_url(self):
                                
                                
                                    DeletionMixin
                                
                                ¶
                            259 260 261 262 263 264  | def get_success_url(self): if self.success_url: return self.success_url % self.object.__dict__ else: raise ImproperlyConfigured( "No URL to redirect to. Provide a success_url.")  | 
                            
                                
                                    def
                                    http_method_not_allowed(self, request, *args, **kwargs):
                                
                                
                                    View
                                
                                ¶
                            
                        
                        
                                    def
                                    http_method_not_allowed(self, request, *args, **kwargs):
                                
                                
                                    View
                                
                                ¶
                            89 90 91 92 93 94 95 96  | def http_method_not_allowed(self, request, *args, **kwargs): logger.warning('Method Not Allowed (%s): %s', request.method, request.path, extra={ 'status_code': 405, 'request': self.request } ) return http.HttpResponseNotAllowed(self._allowed_methods())  | 
                            
                                
                                    def
                                    options(self, request, *args, **kwargs):
                                
                                
                                    View
                                
                                ¶
                            
                        
                        
                                    def
                                    options(self, request, *args, **kwargs):
                                
                                
                                    View
                                
                                ¶
                            Handles responding to requests for the OPTIONS HTTP verb.
98 99 100 101 102 103 104 105  | def options(self, request, *args, **kwargs): """ Handles responding to requests for the OPTIONS HTTP verb. """ response = http.HttpResponse() response['Allow'] = ', '.join(self._allowed_methods()) response['Content-Length'] = '0' return response  | 
                            
                                
                                    def
                                    post(self, request, *args, **kwargs):
                                
                                
                                    DeletionMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    post(self, request, *args, **kwargs):
                                
                                
                                    DeletionMixin
                                
                                ¶
                            256 257  | def post(self, request, *args, **kwargs): return self.delete(request, *args, **kwargs)  |