blueprints.html 60 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml" lang="en">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>flask.blueprints &#8212; proxypool documentation</title>
  7. <link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
  8. <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../../',
  12. VERSION: '',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../../_static/jquery.js"></script>
  19. <script type="text/javascript" src="../../_static/underscore.js"></script>
  20. <script type="text/javascript" src="../../_static/doctools.js"></script>
  21. <link rel="index" title="Index" href="../../genindex.html" />
  22. <link rel="search" title="Search" href="../../search.html" />
  23. <link rel="top" title="proxypool documentation" href="../../index.html" />
  24. <link rel="up" title="Module code" href="../index.html" />
  25. <link rel="stylesheet" href="../../_static/custom.css" type="text/css" />
  26. <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
  27. </head>
  28. <body role="document">
  29. <div class="document">
  30. <div class="documentwrapper">
  31. <div class="bodywrapper">
  32. <div class="body" role="main">
  33. <h1>Source code for flask.blueprints</h1><div class="highlight"><pre>
  34. <span></span><span class="c1"># -*- coding: utf-8 -*-</span>
  35. <span class="sd">&quot;&quot;&quot;</span>
  36. <span class="sd"> flask.blueprints</span>
  37. <span class="sd"> ~~~~~~~~~~~~~~~~</span>
  38. <span class="sd"> Blueprints are the recommended way to implement larger or more</span>
  39. <span class="sd"> pluggable applications in Flask 0.7 and later.</span>
  40. <span class="sd"> :copyright: (c) 2015 by Armin Ronacher.</span>
  41. <span class="sd"> :license: BSD, see LICENSE for more details.</span>
  42. <span class="sd">&quot;&quot;&quot;</span>
  43. <span class="kn">from</span> <span class="nn">functools</span> <span class="k">import</span> <span class="n">update_wrapper</span>
  44. <span class="kn">from</span> <span class="nn">.helpers</span> <span class="k">import</span> <span class="n">_PackageBoundObject</span><span class="p">,</span> <span class="n">_endpoint_from_view_func</span>
  45. <div class="viewcode-block" id="BlueprintSetupState"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.BlueprintSetupState">[docs]</a><span class="k">class</span> <span class="nc">BlueprintSetupState</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
  46. <span class="sd">&quot;&quot;&quot;Temporary holder object for registering a blueprint with the</span>
  47. <span class="sd"> application. An instance of this class is created by the</span>
  48. <span class="sd"> :meth:`~flask.Blueprint.make_setup_state` method and later passed</span>
  49. <span class="sd"> to all register callback functions.</span>
  50. <span class="sd"> &quot;&quot;&quot;</span>
  51. <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">blueprint</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">first_registration</span><span class="p">):</span>
  52. <span class="c1">#: a reference to the current application</span>
  53. <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">app</span>
  54. <span class="c1">#: a reference to the blueprint that created this setup state.</span>
  55. <span class="bp">self</span><span class="o">.</span><span class="n">blueprint</span> <span class="o">=</span> <span class="n">blueprint</span>
  56. <span class="c1">#: a dictionary with all options that were passed to the</span>
  57. <span class="c1">#: :meth:`~flask.Flask.register_blueprint` method.</span>
  58. <span class="bp">self</span><span class="o">.</span><span class="n">options</span> <span class="o">=</span> <span class="n">options</span>
  59. <span class="c1">#: as blueprints can be registered multiple times with the</span>
  60. <span class="c1">#: application and not everything wants to be registered</span>
  61. <span class="c1">#: multiple times on it, this attribute can be used to figure</span>
  62. <span class="c1">#: out if the blueprint was registered in the past already.</span>
  63. <span class="bp">self</span><span class="o">.</span><span class="n">first_registration</span> <span class="o">=</span> <span class="n">first_registration</span>
  64. <span class="n">subdomain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;subdomain&#39;</span><span class="p">)</span>
  65. <span class="k">if</span> <span class="n">subdomain</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  66. <span class="n">subdomain</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">blueprint</span><span class="o">.</span><span class="n">subdomain</span>
  67. <span class="c1">#: The subdomain that the blueprint should be active for, ``None``</span>
  68. <span class="c1">#: otherwise.</span>
  69. <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="o">=</span> <span class="n">subdomain</span>
  70. <span class="n">url_prefix</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;url_prefix&#39;</span><span class="p">)</span>
  71. <span class="k">if</span> <span class="n">url_prefix</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  72. <span class="n">url_prefix</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">blueprint</span><span class="o">.</span><span class="n">url_prefix</span>
  73. <span class="c1">#: The prefix that should be used for all URLs defined on the</span>
  74. <span class="c1">#: blueprint.</span>
  75. <span class="bp">self</span><span class="o">.</span><span class="n">url_prefix</span> <span class="o">=</span> <span class="n">url_prefix</span>
  76. <span class="c1">#: A dictionary with URL defaults that is added to each and every</span>
  77. <span class="c1">#: URL that was defined with the blueprint.</span>
  78. <span class="bp">self</span><span class="o">.</span><span class="n">url_defaults</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">blueprint</span><span class="o">.</span><span class="n">url_values_defaults</span><span class="p">)</span>
  79. <span class="bp">self</span><span class="o">.</span><span class="n">url_defaults</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">options</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;url_defaults&#39;</span><span class="p">,</span> <span class="p">()))</span>
  80. <div class="viewcode-block" id="BlueprintSetupState.add_url_rule"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.BlueprintSetupState.add_url_rule">[docs]</a> <span class="k">def</span> <span class="nf">add_url_rule</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rule</span><span class="p">,</span> <span class="n">endpoint</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">view_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">):</span>
  81. <span class="sd">&quot;&quot;&quot;A helper method to register a rule (and optionally a view function)</span>
  82. <span class="sd"> to the application. The endpoint is automatically prefixed with the</span>
  83. <span class="sd"> blueprint&#39;s name.</span>
  84. <span class="sd"> &quot;&quot;&quot;</span>
  85. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_prefix</span><span class="p">:</span>
  86. <span class="n">rule</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_prefix</span> <span class="o">+</span> <span class="n">rule</span>
  87. <span class="n">options</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="s1">&#39;subdomain&#39;</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span><span class="p">)</span>
  88. <span class="k">if</span> <span class="n">endpoint</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  89. <span class="n">endpoint</span> <span class="o">=</span> <span class="n">_endpoint_from_view_func</span><span class="p">(</span><span class="n">view_func</span><span class="p">)</span>
  90. <span class="n">defaults</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">url_defaults</span>
  91. <span class="k">if</span> <span class="s1">&#39;defaults&#39;</span> <span class="ow">in</span> <span class="n">options</span><span class="p">:</span>
  92. <span class="n">defaults</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">defaults</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s1">&#39;defaults&#39;</span><span class="p">))</span>
  93. <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">add_url_rule</span><span class="p">(</span><span class="n">rule</span><span class="p">,</span> <span class="s1">&#39;</span><span class="si">%s</span><span class="s1">.</span><span class="si">%s</span><span class="s1">&#39;</span> <span class="o">%</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">blueprint</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">),</span>
  94. <span class="n">view_func</span><span class="p">,</span> <span class="n">defaults</span><span class="o">=</span><span class="n">defaults</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">)</span></div></div>
  95. <div class="viewcode-block" id="Blueprint"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint">[docs]</a><span class="k">class</span> <span class="nc">Blueprint</span><span class="p">(</span><span class="n">_PackageBoundObject</span><span class="p">):</span>
  96. <span class="sd">&quot;&quot;&quot;Represents a blueprint. A blueprint is an object that records</span>
  97. <span class="sd"> functions that will be called with the</span>
  98. <span class="sd"> :class:`~flask.blueprints.BlueprintSetupState` later to register functions</span>
  99. <span class="sd"> or other things on the main application. See :ref:`blueprints` for more</span>
  100. <span class="sd"> information.</span>
  101. <span class="sd"> .. versionadded:: 0.7</span>
  102. <span class="sd"> &quot;&quot;&quot;</span>
  103. <span class="n">warn_on_modifications</span> <span class="o">=</span> <span class="kc">False</span>
  104. <span class="n">_got_registered_once</span> <span class="o">=</span> <span class="kc">False</span>
  105. <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">import_name</span><span class="p">,</span> <span class="n">static_folder</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
  106. <span class="n">static_url_path</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">template_folder</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
  107. <span class="n">url_prefix</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">subdomain</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">url_defaults</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
  108. <span class="n">root_path</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  109. <span class="n">_PackageBoundObject</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">import_name</span><span class="p">,</span> <span class="n">template_folder</span><span class="p">,</span>
  110. <span class="n">root_path</span><span class="o">=</span><span class="n">root_path</span><span class="p">)</span>
  111. <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
  112. <span class="bp">self</span><span class="o">.</span><span class="n">url_prefix</span> <span class="o">=</span> <span class="n">url_prefix</span>
  113. <span class="bp">self</span><span class="o">.</span><span class="n">subdomain</span> <span class="o">=</span> <span class="n">subdomain</span>
  114. <span class="bp">self</span><span class="o">.</span><span class="n">static_folder</span> <span class="o">=</span> <span class="n">static_folder</span>
  115. <span class="bp">self</span><span class="o">.</span><span class="n">static_url_path</span> <span class="o">=</span> <span class="n">static_url_path</span>
  116. <span class="bp">self</span><span class="o">.</span><span class="n">deferred_functions</span> <span class="o">=</span> <span class="p">[]</span>
  117. <span class="k">if</span> <span class="n">url_defaults</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
  118. <span class="n">url_defaults</span> <span class="o">=</span> <span class="p">{}</span>
  119. <span class="bp">self</span><span class="o">.</span><span class="n">url_values_defaults</span> <span class="o">=</span> <span class="n">url_defaults</span>
  120. <div class="viewcode-block" id="Blueprint.record"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.record">[docs]</a> <span class="k">def</span> <span class="nf">record</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">):</span>
  121. <span class="sd">&quot;&quot;&quot;Registers a function that is called when the blueprint is</span>
  122. <span class="sd"> registered on the application. This function is called with the</span>
  123. <span class="sd"> state as argument as returned by the :meth:`make_setup_state`</span>
  124. <span class="sd"> method.</span>
  125. <span class="sd"> &quot;&quot;&quot;</span>
  126. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_got_registered_once</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">warn_on_modifications</span><span class="p">:</span>
  127. <span class="kn">from</span> <span class="nn">warnings</span> <span class="k">import</span> <span class="n">warn</span>
  128. <span class="n">warn</span><span class="p">(</span><span class="ne">Warning</span><span class="p">(</span><span class="s1">&#39;The blueprint was already registered once &#39;</span>
  129. <span class="s1">&#39;but is getting modified now. These changes &#39;</span>
  130. <span class="s1">&#39;will not show up.&#39;</span><span class="p">))</span>
  131. <span class="bp">self</span><span class="o">.</span><span class="n">deferred_functions</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">func</span><span class="p">)</span></div>
  132. <div class="viewcode-block" id="Blueprint.record_once"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.record_once">[docs]</a> <span class="k">def</span> <span class="nf">record_once</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">):</span>
  133. <span class="sd">&quot;&quot;&quot;Works like :meth:`record` but wraps the function in another</span>
  134. <span class="sd"> function that will ensure the function is only called once. If the</span>
  135. <span class="sd"> blueprint is registered a second time on the application, the</span>
  136. <span class="sd"> function passed is not called.</span>
  137. <span class="sd"> &quot;&quot;&quot;</span>
  138. <span class="k">def</span> <span class="nf">wrapper</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
  139. <span class="k">if</span> <span class="n">state</span><span class="o">.</span><span class="n">first_registration</span><span class="p">:</span>
  140. <span class="n">func</span><span class="p">(</span><span class="n">state</span><span class="p">)</span>
  141. <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">(</span><span class="n">update_wrapper</span><span class="p">(</span><span class="n">wrapper</span><span class="p">,</span> <span class="n">func</span><span class="p">))</span></div>
  142. <div class="viewcode-block" id="Blueprint.make_setup_state"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.make_setup_state">[docs]</a> <span class="k">def</span> <span class="nf">make_setup_state</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">first_registration</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
  143. <span class="sd">&quot;&quot;&quot;Creates an instance of :meth:`~flask.blueprints.BlueprintSetupState`</span>
  144. <span class="sd"> object that is later passed to the register callback functions.</span>
  145. <span class="sd"> Subclasses can override this to return a subclass of the setup state.</span>
  146. <span class="sd"> &quot;&quot;&quot;</span>
  147. <span class="k">return</span> <span class="n">BlueprintSetupState</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">first_registration</span><span class="p">)</span></div>
  148. <div class="viewcode-block" id="Blueprint.register"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.register">[docs]</a> <span class="k">def</span> <span class="nf">register</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">app</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">first_registration</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
  149. <span class="sd">&quot;&quot;&quot;Called by :meth:`Flask.register_blueprint` to register a blueprint</span>
  150. <span class="sd"> on the application. This can be overridden to customize the register</span>
  151. <span class="sd"> behavior. Keyword arguments from</span>
  152. <span class="sd"> :func:`~flask.Flask.register_blueprint` are directly forwarded to this</span>
  153. <span class="sd"> method in the `options` dictionary.</span>
  154. <span class="sd"> &quot;&quot;&quot;</span>
  155. <span class="bp">self</span><span class="o">.</span><span class="n">_got_registered_once</span> <span class="o">=</span> <span class="kc">True</span>
  156. <span class="n">state</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">make_setup_state</span><span class="p">(</span><span class="n">app</span><span class="p">,</span> <span class="n">options</span><span class="p">,</span> <span class="n">first_registration</span><span class="p">)</span>
  157. <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_static_folder</span><span class="p">:</span>
  158. <span class="n">state</span><span class="o">.</span><span class="n">add_url_rule</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">static_url_path</span> <span class="o">+</span> <span class="s1">&#39;/&lt;path:filename&gt;&#39;</span><span class="p">,</span>
  159. <span class="n">view_func</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">send_static_file</span><span class="p">,</span>
  160. <span class="n">endpoint</span><span class="o">=</span><span class="s1">&#39;static&#39;</span><span class="p">)</span>
  161. <span class="k">for</span> <span class="n">deferred</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">deferred_functions</span><span class="p">:</span>
  162. <span class="n">deferred</span><span class="p">(</span><span class="n">state</span><span class="p">)</span></div>
  163. <div class="viewcode-block" id="Blueprint.route"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.route">[docs]</a> <span class="k">def</span> <span class="nf">route</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rule</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">):</span>
  164. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.route` but for a blueprint. The endpoint for the</span>
  165. <span class="sd"> :func:`url_for` function is prefixed with the name of the blueprint.</span>
  166. <span class="sd"> &quot;&quot;&quot;</span>
  167. <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  168. <span class="n">endpoint</span> <span class="o">=</span> <span class="n">options</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">&quot;endpoint&quot;</span><span class="p">,</span> <span class="n">f</span><span class="o">.</span><span class="n">__name__</span><span class="p">)</span>
  169. <span class="bp">self</span><span class="o">.</span><span class="n">add_url_rule</span><span class="p">(</span><span class="n">rule</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">)</span>
  170. <span class="k">return</span> <span class="n">f</span>
  171. <span class="k">return</span> <span class="n">decorator</span></div>
  172. <div class="viewcode-block" id="Blueprint.add_url_rule"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.add_url_rule">[docs]</a> <span class="k">def</span> <span class="nf">add_url_rule</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">rule</span><span class="p">,</span> <span class="n">endpoint</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">view_func</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">):</span>
  173. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.add_url_rule` but for a blueprint. The endpoint for</span>
  174. <span class="sd"> the :func:`url_for` function is prefixed with the name of the blueprint.</span>
  175. <span class="sd"> &quot;&quot;&quot;</span>
  176. <span class="k">if</span> <span class="n">endpoint</span><span class="p">:</span>
  177. <span class="k">assert</span> <span class="s1">&#39;.&#39;</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">endpoint</span><span class="p">,</span> <span class="s2">&quot;Blueprint endpoints should not contain dots&quot;</span>
  178. <span class="bp">self</span><span class="o">.</span><span class="n">record</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span>
  179. <span class="n">s</span><span class="o">.</span><span class="n">add_url_rule</span><span class="p">(</span><span class="n">rule</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">,</span> <span class="n">view_func</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">))</span></div>
  180. <div class="viewcode-block" id="Blueprint.endpoint"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.endpoint">[docs]</a> <span class="k">def</span> <span class="nf">endpoint</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">endpoint</span><span class="p">):</span>
  181. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.endpoint` but for a blueprint. This does not</span>
  182. <span class="sd"> prefix the endpoint with the blueprint name, this has to be done</span>
  183. <span class="sd"> explicitly by the user of this method. If the endpoint is prefixed</span>
  184. <span class="sd"> with a `.` it will be registered to the current blueprint, otherwise</span>
  185. <span class="sd"> it&#39;s an application independent endpoint.</span>
  186. <span class="sd"> &quot;&quot;&quot;</span>
  187. <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  188. <span class="k">def</span> <span class="nf">register_endpoint</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
  189. <span class="n">state</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">view_functions</span><span class="p">[</span><span class="n">endpoint</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span>
  190. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="n">register_endpoint</span><span class="p">)</span>
  191. <span class="k">return</span> <span class="n">f</span>
  192. <span class="k">return</span> <span class="n">decorator</span></div>
  193. <div class="viewcode-block" id="Blueprint.app_template_filter"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.app_template_filter">[docs]</a> <span class="k">def</span> <span class="nf">app_template_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  194. <span class="sd">&quot;&quot;&quot;Register a custom template filter, available application wide. Like</span>
  195. <span class="sd"> :meth:`Flask.template_filter` but for a blueprint.</span>
  196. <span class="sd"> :param name: the optional name of the filter, otherwise the</span>
  197. <span class="sd"> function name will be used.</span>
  198. <span class="sd"> &quot;&quot;&quot;</span>
  199. <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  200. <span class="bp">self</span><span class="o">.</span><span class="n">add_app_template_filter</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
  201. <span class="k">return</span> <span class="n">f</span>
  202. <span class="k">return</span> <span class="n">decorator</span></div>
  203. <div class="viewcode-block" id="Blueprint.add_app_template_filter"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.add_app_template_filter">[docs]</a> <span class="k">def</span> <span class="nf">add_app_template_filter</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  204. <span class="sd">&quot;&quot;&quot;Register a custom template filter, available application wide. Like</span>
  205. <span class="sd"> :meth:`Flask.add_template_filter` but for a blueprint. Works exactly</span>
  206. <span class="sd"> like the :meth:`app_template_filter` decorator.</span>
  207. <span class="sd"> :param name: the optional name of the filter, otherwise the</span>
  208. <span class="sd"> function name will be used.</span>
  209. <span class="sd"> &quot;&quot;&quot;</span>
  210. <span class="k">def</span> <span class="nf">register_template</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
  211. <span class="n">state</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">jinja_env</span><span class="o">.</span><span class="n">filters</span><span class="p">[</span><span class="n">name</span> <span class="ow">or</span> <span class="n">f</span><span class="o">.</span><span class="n">__name__</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span>
  212. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="n">register_template</span><span class="p">)</span></div>
  213. <div class="viewcode-block" id="Blueprint.app_template_test"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.app_template_test">[docs]</a> <span class="k">def</span> <span class="nf">app_template_test</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  214. <span class="sd">&quot;&quot;&quot;Register a custom template test, available application wide. Like</span>
  215. <span class="sd"> :meth:`Flask.template_test` but for a blueprint.</span>
  216. <span class="sd"> .. versionadded:: 0.10</span>
  217. <span class="sd"> :param name: the optional name of the test, otherwise the</span>
  218. <span class="sd"> function name will be used.</span>
  219. <span class="sd"> &quot;&quot;&quot;</span>
  220. <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  221. <span class="bp">self</span><span class="o">.</span><span class="n">add_app_template_test</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
  222. <span class="k">return</span> <span class="n">f</span>
  223. <span class="k">return</span> <span class="n">decorator</span></div>
  224. <div class="viewcode-block" id="Blueprint.add_app_template_test"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.add_app_template_test">[docs]</a> <span class="k">def</span> <span class="nf">add_app_template_test</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  225. <span class="sd">&quot;&quot;&quot;Register a custom template test, available application wide. Like</span>
  226. <span class="sd"> :meth:`Flask.add_template_test` but for a blueprint. Works exactly</span>
  227. <span class="sd"> like the :meth:`app_template_test` decorator.</span>
  228. <span class="sd"> .. versionadded:: 0.10</span>
  229. <span class="sd"> :param name: the optional name of the test, otherwise the</span>
  230. <span class="sd"> function name will be used.</span>
  231. <span class="sd"> &quot;&quot;&quot;</span>
  232. <span class="k">def</span> <span class="nf">register_template</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
  233. <span class="n">state</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">jinja_env</span><span class="o">.</span><span class="n">tests</span><span class="p">[</span><span class="n">name</span> <span class="ow">or</span> <span class="n">f</span><span class="o">.</span><span class="n">__name__</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span>
  234. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="n">register_template</span><span class="p">)</span></div>
  235. <div class="viewcode-block" id="Blueprint.app_template_global"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.app_template_global">[docs]</a> <span class="k">def</span> <span class="nf">app_template_global</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  236. <span class="sd">&quot;&quot;&quot;Register a custom template global, available application wide. Like</span>
  237. <span class="sd"> :meth:`Flask.template_global` but for a blueprint.</span>
  238. <span class="sd"> .. versionadded:: 0.10</span>
  239. <span class="sd"> :param name: the optional name of the global, otherwise the</span>
  240. <span class="sd"> function name will be used.</span>
  241. <span class="sd"> &quot;&quot;&quot;</span>
  242. <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  243. <span class="bp">self</span><span class="o">.</span><span class="n">add_app_template_global</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">name</span><span class="p">)</span>
  244. <span class="k">return</span> <span class="n">f</span>
  245. <span class="k">return</span> <span class="n">decorator</span></div>
  246. <div class="viewcode-block" id="Blueprint.add_app_template_global"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.add_app_template_global">[docs]</a> <span class="k">def</span> <span class="nf">add_app_template_global</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
  247. <span class="sd">&quot;&quot;&quot;Register a custom template global, available application wide. Like</span>
  248. <span class="sd"> :meth:`Flask.add_template_global` but for a blueprint. Works exactly</span>
  249. <span class="sd"> like the :meth:`app_template_global` decorator.</span>
  250. <span class="sd"> .. versionadded:: 0.10</span>
  251. <span class="sd"> :param name: the optional name of the global, otherwise the</span>
  252. <span class="sd"> function name will be used.</span>
  253. <span class="sd"> &quot;&quot;&quot;</span>
  254. <span class="k">def</span> <span class="nf">register_template</span><span class="p">(</span><span class="n">state</span><span class="p">):</span>
  255. <span class="n">state</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">jinja_env</span><span class="o">.</span><span class="n">globals</span><span class="p">[</span><span class="n">name</span> <span class="ow">or</span> <span class="n">f</span><span class="o">.</span><span class="n">__name__</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span>
  256. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="n">register_template</span><span class="p">)</span></div>
  257. <div class="viewcode-block" id="Blueprint.before_request"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.before_request">[docs]</a> <span class="k">def</span> <span class="nf">before_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  258. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.before_request` but for a blueprint. This function</span>
  259. <span class="sd"> is only executed before each request that is handled by a function of</span>
  260. <span class="sd"> that blueprint.</span>
  261. <span class="sd"> &quot;&quot;&quot;</span>
  262. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">before_request_funcs</span>
  263. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  264. <span class="k">return</span> <span class="n">f</span></div>
  265. <div class="viewcode-block" id="Blueprint.before_app_request"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.before_app_request">[docs]</a> <span class="k">def</span> <span class="nf">before_app_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  266. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.before_request`. Such a function is executed</span>
  267. <span class="sd"> before each request, even if outside of a blueprint.</span>
  268. <span class="sd"> &quot;&quot;&quot;</span>
  269. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">before_request_funcs</span>
  270. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  271. <span class="k">return</span> <span class="n">f</span></div>
  272. <div class="viewcode-block" id="Blueprint.before_app_first_request"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.before_app_first_request">[docs]</a> <span class="k">def</span> <span class="nf">before_app_first_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  273. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.before_first_request`. Such a function is</span>
  274. <span class="sd"> executed before the first request to the application.</span>
  275. <span class="sd"> &quot;&quot;&quot;</span>
  276. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">before_first_request_funcs</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  277. <span class="k">return</span> <span class="n">f</span></div>
  278. <div class="viewcode-block" id="Blueprint.after_request"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.after_request">[docs]</a> <span class="k">def</span> <span class="nf">after_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  279. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.after_request` but for a blueprint. This function</span>
  280. <span class="sd"> is only executed after each request that is handled by a function of</span>
  281. <span class="sd"> that blueprint.</span>
  282. <span class="sd"> &quot;&quot;&quot;</span>
  283. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">after_request_funcs</span>
  284. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  285. <span class="k">return</span> <span class="n">f</span></div>
  286. <div class="viewcode-block" id="Blueprint.after_app_request"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.after_app_request">[docs]</a> <span class="k">def</span> <span class="nf">after_app_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  287. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.after_request` but for a blueprint. Such a function</span>
  288. <span class="sd"> is executed after each request, even if outside of the blueprint.</span>
  289. <span class="sd"> &quot;&quot;&quot;</span>
  290. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">after_request_funcs</span>
  291. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  292. <span class="k">return</span> <span class="n">f</span></div>
  293. <div class="viewcode-block" id="Blueprint.teardown_request"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.teardown_request">[docs]</a> <span class="k">def</span> <span class="nf">teardown_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  294. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.teardown_request` but for a blueprint. This</span>
  295. <span class="sd"> function is only executed when tearing down requests handled by a</span>
  296. <span class="sd"> function of that blueprint. Teardown request functions are executed</span>
  297. <span class="sd"> when the request context is popped, even when no actual request was</span>
  298. <span class="sd"> performed.</span>
  299. <span class="sd"> &quot;&quot;&quot;</span>
  300. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">teardown_request_funcs</span>
  301. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  302. <span class="k">return</span> <span class="n">f</span></div>
  303. <div class="viewcode-block" id="Blueprint.teardown_app_request"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.teardown_app_request">[docs]</a> <span class="k">def</span> <span class="nf">teardown_app_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  304. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.teardown_request` but for a blueprint. Such a</span>
  305. <span class="sd"> function is executed when tearing down each request, even if outside of</span>
  306. <span class="sd"> the blueprint.</span>
  307. <span class="sd"> &quot;&quot;&quot;</span>
  308. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">teardown_request_funcs</span>
  309. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  310. <span class="k">return</span> <span class="n">f</span></div>
  311. <div class="viewcode-block" id="Blueprint.context_processor"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.context_processor">[docs]</a> <span class="k">def</span> <span class="nf">context_processor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  312. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.context_processor` but for a blueprint. This</span>
  313. <span class="sd"> function is only executed for requests handled by a blueprint.</span>
  314. <span class="sd"> &quot;&quot;&quot;</span>
  315. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">template_context_processors</span>
  316. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  317. <span class="k">return</span> <span class="n">f</span></div>
  318. <div class="viewcode-block" id="Blueprint.app_context_processor"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.app_context_processor">[docs]</a> <span class="k">def</span> <span class="nf">app_context_processor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  319. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.context_processor` but for a blueprint. Such a</span>
  320. <span class="sd"> function is executed each request, even if outside of the blueprint.</span>
  321. <span class="sd"> &quot;&quot;&quot;</span>
  322. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">template_context_processors</span>
  323. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  324. <span class="k">return</span> <span class="n">f</span></div>
  325. <div class="viewcode-block" id="Blueprint.app_errorhandler"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.app_errorhandler">[docs]</a> <span class="k">def</span> <span class="nf">app_errorhandler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">code</span><span class="p">):</span>
  326. <span class="sd">&quot;&quot;&quot;Like :meth:`Flask.errorhandler` but for a blueprint. This</span>
  327. <span class="sd"> handler is used for all requests, even if outside of the blueprint.</span>
  328. <span class="sd"> &quot;&quot;&quot;</span>
  329. <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  330. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">errorhandler</span><span class="p">(</span><span class="n">code</span><span class="p">)(</span><span class="n">f</span><span class="p">))</span>
  331. <span class="k">return</span> <span class="n">f</span>
  332. <span class="k">return</span> <span class="n">decorator</span></div>
  333. <div class="viewcode-block" id="Blueprint.url_value_preprocessor"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.url_value_preprocessor">[docs]</a> <span class="k">def</span> <span class="nf">url_value_preprocessor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  334. <span class="sd">&quot;&quot;&quot;Registers a function as URL value preprocessor for this</span>
  335. <span class="sd"> blueprint. It&#39;s called before the view functions are called and</span>
  336. <span class="sd"> can modify the url values provided.</span>
  337. <span class="sd"> &quot;&quot;&quot;</span>
  338. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">url_value_preprocessors</span>
  339. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  340. <span class="k">return</span> <span class="n">f</span></div>
  341. <div class="viewcode-block" id="Blueprint.url_defaults"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.url_defaults">[docs]</a> <span class="k">def</span> <span class="nf">url_defaults</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  342. <span class="sd">&quot;&quot;&quot;Callback function for URL defaults for this blueprint. It&#39;s called</span>
  343. <span class="sd"> with the endpoint and values and should update the values passed</span>
  344. <span class="sd"> in place.</span>
  345. <span class="sd"> &quot;&quot;&quot;</span>
  346. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">url_default_functions</span>
  347. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  348. <span class="k">return</span> <span class="n">f</span></div>
  349. <div class="viewcode-block" id="Blueprint.app_url_value_preprocessor"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.app_url_value_preprocessor">[docs]</a> <span class="k">def</span> <span class="nf">app_url_value_preprocessor</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  350. <span class="sd">&quot;&quot;&quot;Same as :meth:`url_value_preprocessor` but application wide.</span>
  351. <span class="sd"> &quot;&quot;&quot;</span>
  352. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">url_value_preprocessors</span>
  353. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  354. <span class="k">return</span> <span class="n">f</span></div>
  355. <div class="viewcode-block" id="Blueprint.app_url_defaults"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.app_url_defaults">[docs]</a> <span class="k">def</span> <span class="nf">app_url_defaults</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  356. <span class="sd">&quot;&quot;&quot;Same as :meth:`url_defaults` but application wide.</span>
  357. <span class="sd"> &quot;&quot;&quot;</span>
  358. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">url_default_functions</span>
  359. <span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="kc">None</span><span class="p">,</span> <span class="p">[])</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">f</span><span class="p">))</span>
  360. <span class="k">return</span> <span class="n">f</span></div>
  361. <div class="viewcode-block" id="Blueprint.errorhandler"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.errorhandler">[docs]</a> <span class="k">def</span> <span class="nf">errorhandler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">code_or_exception</span><span class="p">):</span>
  362. <span class="sd">&quot;&quot;&quot;Registers an error handler that becomes active for this blueprint</span>
  363. <span class="sd"> only. Please be aware that routing does not happen local to a</span>
  364. <span class="sd"> blueprint so an error handler for 404 usually is not handled by</span>
  365. <span class="sd"> a blueprint unless it is caused inside a view function. Another</span>
  366. <span class="sd"> special case is the 500 internal server error which is always looked</span>
  367. <span class="sd"> up from the application.</span>
  368. <span class="sd"> Otherwise works as the :meth:`~flask.Flask.errorhandler` decorator</span>
  369. <span class="sd"> of the :class:`~flask.Flask` object.</span>
  370. <span class="sd"> &quot;&quot;&quot;</span>
  371. <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span>
  372. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">_register_error_handler</span><span class="p">(</span>
  373. <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">code_or_exception</span><span class="p">,</span> <span class="n">f</span><span class="p">))</span>
  374. <span class="k">return</span> <span class="n">f</span>
  375. <span class="k">return</span> <span class="n">decorator</span></div>
  376. <div class="viewcode-block" id="Blueprint.register_error_handler"><a class="viewcode-back" href="../../flask/flask.html#flask.blueprints.Blueprint.register_error_handler">[docs]</a> <span class="k">def</span> <span class="nf">register_error_handler</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">code_or_exception</span><span class="p">,</span> <span class="n">f</span><span class="p">):</span>
  377. <span class="sd">&quot;&quot;&quot;Non-decorator version of the :meth:`errorhandler` error attach</span>
  378. <span class="sd"> function, akin to the :meth:`~flask.Flask.register_error_handler`</span>
  379. <span class="sd"> application-wide function of the :class:`~flask.Flask` object but</span>
  380. <span class="sd"> for error handlers limited to this blueprint.</span>
  381. <span class="sd"> .. versionadded:: 0.11</span>
  382. <span class="sd"> &quot;&quot;&quot;</span>
  383. <span class="bp">self</span><span class="o">.</span><span class="n">record_once</span><span class="p">(</span><span class="k">lambda</span> <span class="n">s</span><span class="p">:</span> <span class="n">s</span><span class="o">.</span><span class="n">app</span><span class="o">.</span><span class="n">_register_error_handler</span><span class="p">(</span>
  384. <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">code_or_exception</span><span class="p">,</span> <span class="n">f</span><span class="p">))</span></div></div>
  385. </pre></div>
  386. </div>
  387. </div>
  388. </div>
  389. <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
  390. <div class="sphinxsidebarwrapper"><div class="relations">
  391. <h3>Related Topics</h3>
  392. <ul>
  393. <li><a href="../../index.html">Documentation overview</a><ul>
  394. <li><a href="../index.html">Module code</a><ul>
  395. </ul></li>
  396. </ul></li>
  397. </ul>
  398. </div>
  399. <div id="searchbox" style="display: none" role="search">
  400. <h3>Quick search</h3>
  401. <form class="search" action="../../search.html" method="get">
  402. <div><input type="text" name="q" /></div>
  403. <div><input type="submit" value="Go" /></div>
  404. <input type="hidden" name="check_keywords" value="yes" />
  405. <input type="hidden" name="area" value="default" />
  406. </form>
  407. </div>
  408. <script type="text/javascript">$('#searchbox').show(0);</script>
  409. </div>
  410. </div>
  411. <div class="clearer"></div>
  412. </div>
  413. <div class="footer">
  414. &copy;2016, Author.
  415. |
  416. Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.8</a>
  417. &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.9</a>
  418. </div>
  419. </body>
  420. </html>