docs/_build/html/autoapi/app/views/error_pages/index.html


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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

<!DOCTYPE html>

<html>
  <head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />

    <title>app.views.error_pages &#8212; SaaS in a Flask 0.1.0 documentation</title>
    <link rel="stylesheet" type="text/css" href="../../../../_static/pygments.css" />
    <link rel="stylesheet" type="text/css" href="../../../../_static/alabaster.css" />
    <link rel="stylesheet" type="text/css" href="../../../../_static/graphviz.css" />
    <script data-url_root="../../../../" id="documentation_options" src="../../../../_static/documentation_options.js"></script>
    <script src="../../../../_static/jquery.js"></script>
    <script src="../../../../_static/underscore.js"></script>
    <script src="../../../../_static/doctools.js"></script>
    <link rel="index" title="Index" href="../../../../genindex.html" />
    <link rel="search" title="Search" href="../../../../search.html" />
   
  <link rel="stylesheet" href="../../../../_static/custom.css" type="text/css" />
  
  
  <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

  </head><body>
  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          

          <div class="body" role="main">
            
  <section id="module-app.views.error_pages">
<span id="app-views-error-pages"></span><h1><a class="reference internal" href="#module-app.views.error_pages" title="app.views.error_pages"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.views.error_pages</span></code></a><a class="headerlink" href="#module-app.views.error_pages" title="Permalink to this headline">¶</a></h1>
<p>This file describes the errors and the message the user should see.</p>
<section id="module-contents">
<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2>
<section id="functions">
<h3>Functions<a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3>
<table class="longtable docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.error_pages.simulate_500" title="app.views.error_pages.simulate_500"><code class="xref py py-obj docutils literal notranslate"><span class="pre">simulate_500</span></code></a>()</p></td>
<td><p>Used to simulate a error 500 for test coverage of 500 handling</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.views.error_pages.page_forbidden" title="app.views.error_pages.page_forbidden"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_forbidden</span></code></a>(e)</p></td>
<td><p>Thrown when a user accesses a page with &#64;flask_login.login_required</p></td>
</tr>
<tr class="row-odd"><td><p><a class="reference internal" href="#app.views.error_pages.page_not_found" title="app.views.error_pages.page_not_found"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_not_found</span></code></a>(e)</p></td>
<td><p>Page for resource or file nout found</p></td>
</tr>
<tr class="row-even"><td><p><a class="reference internal" href="#app.views.error_pages.page_server_error" title="app.views.error_pages.page_server_error"><code class="xref py py-obj docutils literal notranslate"><span class="pre">page_server_error</span></code></a>(e)</p></td>
<td><p>Page for internal server error</p></td>
</tr>
</tbody>
</table>
<dl class="py function">
<dt class="sig sig-object py" id="app.views.error_pages.simulate_500">
<span class="sig-prename descclassname"><span class="pre">app.views.error_pages.</span></span><span class="sig-name descname"><span class="pre">simulate_500</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#app.views.error_pages.simulate_500" title="Permalink to this definition">¶</a></dt>
<dd><p>Used to simulate a error 500 for test coverage of 500 handling</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="app.views.error_pages.page_forbidden">
<span class="sig-prename descclassname"><span class="pre">app.views.error_pages.</span></span><span class="sig-name descname"><span class="pre">page_forbidden</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">e</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.views.error_pages.page_forbidden" title="Permalink to this definition">¶</a></dt>
<dd><p>Thrown when a user accesses a page with &#64;flask_login.login_required</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="app.views.error_pages.page_not_found">
<span class="sig-prename descclassname"><span class="pre">app.views.error_pages.</span></span><span class="sig-name descname"><span class="pre">page_not_found</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">e</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.views.error_pages.page_not_found" title="Permalink to this definition">¶</a></dt>
<dd><p>Page for resource or file nout found</p>
</dd></dl>

<dl class="py function">
<dt class="sig sig-object py" id="app.views.error_pages.page_server_error">
<span class="sig-prename descclassname"><span class="pre">app.views.error_pages.</span></span><span class="sig-name descname"><span class="pre">page_server_error</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">e</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.views.error_pages.page_server_error" title="Permalink to this definition">¶</a></dt>
<dd><p>Page for internal server error</p>
</dd></dl>

</section>
</section>
</section>


          </div>
          
        </div>
      </div>
      <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
        <div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../../../index.html">SaaS in a Flask</a></h1>


<h3>Navigation</h3>
<p class="caption"><span class="caption-text">Contents:</span></p>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../index.html">API Reference</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
<ul>
  <li><a href="../../../../index.html">Documentation overview</a><ul>
  </ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
  <h3 id="searchlabel">Quick search</h3>
    <div class="searchformwrapper">
    <form class="search" action="../../../../search.html" method="get">
      <input type="text" name="q" aria-labelledby="searchlabel" />
      <input type="submit" value="Go" />
    </form>
    </div>
</div>
<script>$('#searchbox').show(0);</script>


        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="footer">
      &copy;2021, Navan Chauhan.
      
      |
      Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a>
      &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a>
      
      |
      <a href="../../../../_sources/autoapi/app/views/error_pages/index.rst.txt"
          rel="nofollow">Page source</a>
    </div>

    
  </body>
</html>