OpenQuizz
Une application de gestion des contenus pédagogiques
View Class Reference
Inheritance diagram for View:
Collaboration diagram for View:

Public Member Functions

def dispatch_request (self)
 
def as_view (cls, name, *class_args, **class_kwargs)
 

Static Public Attributes

 methods
 
 provide_automatic_options
 
 decorators
 

Detailed Description

Alternative way to use view functions.  A subclass has to implement
:meth:`dispatch_request` which is called with the view arguments from
the URL routing system.  If :attr:`methods` is provided the methods
do not have to be passed to the :meth:`~flask.Flask.add_url_rule`
method explicitly::

    class MyView(View):
        methods = ['GET']

        def dispatch_request(self, name):
            return 'Hello %s!' % name

    app.add_url_rule('/hello/<name>', view_func=MyView.as_view('myview'))

When you want to decorate a pluggable view you will have to either do that
when the view function is created (by wrapping the return value of
:meth:`as_view`) or you can use the :attr:`decorators` attribute::

    class SecretView(View):
        methods = ['GET']
        decorators = [superuser_required]

        def dispatch_request(self):
            ...

The decorators stored in the decorators list are applied one after another
when the view function is created.  Note that you can *not* use the class
based decorators since those would decorate the view class and not the
generated view function!

Member Function Documentation

◆ as_view()

def as_view (   cls,
  name,
class_args,
**  class_kwargs 
)
Converts the class into an actual view function that can be used
with the routing system.  Internally this generates a function on the
fly which will instantiate the :class:`View` on each request and call
the :meth:`dispatch_request` method on it.

The arguments passed to :meth:`as_view` are forwarded to the
constructor of the class.

◆ dispatch_request()

def dispatch_request (   self)
Subclasses have to override this method to implement the
actual view function code.  This method is called with all
the arguments from the URL rule.

Field Documentation

◆ decorators

decorators
static

◆ methods

methods
static

◆ provide_automatic_options

provide_automatic_options
static

The documentation for this class was generated from the following file: