File: views.rst

package info (click to toggle)
python-django-waffle 4.2.0-1
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 684 kB
  • sloc: python: 3,266; makefile: 139; sh: 39; javascript: 34
file content (53 lines) | stat: -rw-r--r-- 991 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
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
52
53
.. _usage-views:

=====================
Using Waffle in views
=====================

Waffle provides simple methods to test :ref:`flags <types-flag>`,
:ref:`switches <types-switch>`, or :ref:`samples <types-sample>` in
views (or, for switches and samples, anywhere else you're writing
Python).


Flags
=====

::

    waffle.flag_is_active(request, 'flag_name')

Returns ``True`` if the flag is active for this request, else ``False``.
For example::

    import waffle

    def my_view(request):
        if waffle.flag_is_active(request, 'flag_name'):
            """Behavior if flag is active."""
        else:
            """Behavior if flag is inactive."""


Switches
========

::

    waffle.switch_is_active('switch_name')

Returns ``True`` if the switch is active, else ``False``.


Samples
=======

::

    waffle.sample_is_active('sample_name')

Returns ``True`` if the sample is active, else ``False``.

.. warning::

    See the warning in the :ref:`Sample chapter <types-sample>`.