class BaseListView
from django.views.generic.list import BaseListView
A base view for displaying a list of objects.
Ancestors (MRO)
- BaseListView
 - MultipleObjectMixin
 - ContextMixin
 - View
 
Descendants
Attributes
| Defined in | |
|---|---|
                                    
                                        allow_empty = True
                                    
                                 | 
                                MultipleObjectMixin | 
                                    
                                        context_object_name = None
                                    
                                 | 
                                MultipleObjectMixin | 
                                    
                                        http_method_names = [u'get', u'post', u'put', u'patch', u'delete', u'head', u'options', u'trace']
                                    
                                 | 
                                View | 
                                    
                                        model = None
                                    
                                 | 
                                MultipleObjectMixin | 
                                    
                                        page_kwarg = 'page'
                                    
                                 | 
                                MultipleObjectMixin | 
                                    
                                        paginate_by = None
                                    
                                 | 
                                MultipleObjectMixin | 
                                    
                                        paginate_orphans = 0
                                    
                                 | 
                                MultipleObjectMixin | 
                                    
                                        paginator_class = <class 'django.core.paginator.Paginator'>
                                    
                                 | 
                                MultipleObjectMixin | 
                                    
                                        queryset = None
                                    
                                 | 
                                MultipleObjectMixin | 
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
                                    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):
                                
                                
                                    BaseListView
                                
                                ¶
                            
                        
                        
                                    def
                                    get(self, request, *args, **kwargs):
                                
                                
                                    BaseListView
                                
                                ¶
                            136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152  | def get(self, request, *args, **kwargs): self.object_list = self.get_queryset() allow_empty = self.get_allow_empty() if not allow_empty: # When pagination is enabled and object_list is a queryset, # it's better to do a cheap query than to load the unpaginated # queryset in memory. if (self.get_paginate_by(self.object_list) is not None and hasattr(self.object_list, 'exists')): is_empty = not self.object_list.exists() else: is_empty = len(self.object_list) == 0 if is_empty: raise Http404(_("Empty list and '%(class_name)s.allow_empty' is False.") % {'class_name': self.__class__.__name__}) context = self.get_context_data() return self.render_to_response(context)  | 
                            
                                
                                    def
                                    get_allow_empty(self):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_allow_empty(self):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            Returns ``True`` if the view should display empty lists, and ``False`` if a 404 should be raised instead.
86 87 88 89 90 91  | def get_allow_empty(self): """ Returns ``True`` if the view should display empty lists, and ``False`` if a 404 should be raised instead. """ return self.allow_empty  | 
                            
                                
                                    def
                                    get_context_data(self, **kwargs):
                                
                                
                                ¶
                            
                        
                        
                                    def
                                    get_context_data(self, **kwargs):
                                
                                
                                ¶
                            
                                            MultipleObjectMixin
                                        
                                        Get the context for this view.
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129  | def get_context_data(self, **kwargs): """ Get the context for this view. """ queryset = kwargs.pop('object_list', self.object_list) page_size = self.get_paginate_by(queryset) context_object_name = self.get_context_object_name(queryset) if page_size: paginator, page, queryset, is_paginated = self.paginate_queryset(queryset, page_size) context = { 'paginator': paginator, 'page_obj': page, 'is_paginated': is_paginated, 'object_list': queryset } else: context = { 'paginator': None, 'page_obj': None, 'is_paginated': False, 'object_list': queryset } if context_object_name is not None: context[context_object_name] = queryset context.update(kwargs) return super(MultipleObjectMixin, 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, object_list):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_context_object_name(self, object_list):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            Get the name of the item to be used in the context.
93 94 95 96 97 98 99 100 101 102  | def get_context_object_name(self, object_list): """ Get the name of the item to be used in the context. """ if self.context_object_name: return self.context_object_name elif hasattr(object_list, 'model'): return '%s_list' % object_list.model._meta.model_name else: return None  | 
                            
                                
                                    def
                                    get_paginate_by(self, queryset):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_paginate_by(self, queryset):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            Get the number of items to paginate by, or ``None`` for no pagination.
64 65 66 67 68  | def get_paginate_by(self, queryset): """ Get the number of items to paginate by, or ``None`` for no pagination. """ return self.paginate_by  | 
                            
                                
                                    def
                                    get_paginate_orphans(self):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_paginate_orphans(self):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            Returns the maximum number of orphans extend the last page by when paginating.
79 80 81 82 83 84  | def get_paginate_orphans(self): """ Returns the maximum number of orphans extend the last page by when paginating. """ return self.paginate_orphans  | 
                            
                                
                                    def
                                    get_paginator(self, queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_paginator(self, queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            Return an instance of the paginator for this view.
70 71 72 73 74 75 76 77  | def get_paginator(self, queryset, per_page, orphans=0, allow_empty_first_page=True, **kwargs): """ Return an instance of the paginator for this view. """ return self.paginator_class( queryset, per_page, orphans=orphans, allow_empty_first_page=allow_empty_first_page, **kwargs)  | 
                            
                                
                                    def
                                    get_queryset(self):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    get_queryset(self):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            Get the list of items for this view. This must be an iterable, and may be a queryset (in which qs-specific behavior will be enabled).
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37  | def get_queryset(self): """ Get the list of items for this view. This must be an iterable, and may be a queryset (in which qs-specific behavior will be enabled). """ if self.queryset is not None: queryset = self.queryset if hasattr(queryset, '_clone'): queryset = queryset._clone() elif self.model is not None: queryset = self.model._default_manager.all() else: raise ImproperlyConfigured("'%s' must define 'queryset' or 'model'" % self.__class__.__name__) return queryset  | 
                            
                                
                                    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
                                    paginate_queryset(self, queryset, page_size):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            
                        
                        
                                    def
                                    paginate_queryset(self, queryset, page_size):
                                
                                
                                    MultipleObjectMixin
                                
                                ¶
                            Paginate the queryset, if needed.
39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62  | def paginate_queryset(self, queryset, page_size): """ Paginate the queryset, if needed. """ paginator = self.get_paginator( queryset, page_size, orphans=self.get_paginate_orphans(), allow_empty_first_page=self.get_allow_empty()) page_kwarg = self.page_kwarg page = self.kwargs.get(page_kwarg) or self.request.GET.get(page_kwarg) or 1 try: page_number = int(page) except ValueError: if page == 'last': page_number = paginator.num_pages else: raise Http404(_("Page is not 'last', nor can it be converted to an int.")) try: page = paginator.page(page_number) return (paginator, page, page.object_list, page.has_other_pages()) except InvalidPage as e: raise Http404(_('Invalid page (%(page_number)s): %(message)s') % { 'page_number': page_number, 'message': str(e) })  |