Home Explore Help
Sign In
221V
/
maple-bbs
1
0
Fork 0
Files Issues 0 Pull Requests 0 Wiki
Tree: fdaa8dda87
Branches Tags
maple-bbs
/
forums
/
docs
/
static
/
flask-maple
/
advanced.html

advanced.html 16 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    2. 

  2.   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
    3. 

  3. 

  4. 

  5. <html xmlns="http://www.w3.org/1999/xhtml">
    6. 

  6.   <head>
    7. 

  7.     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    8. 

  8.     
    9. 

  9.     <title>1 Advanced &mdash; Flask-Maple 0.8 documentation</title>
    10. 

  10.     
    11. 

  11.     <link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
    12. 

  12.     <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    13. 

  13.     
    14. 

  14.     <script type="text/javascript">
    15. 

  15.       var DOCUMENTATION_OPTIONS = {
    16. 

  16.         URL_ROOT:    './',
    17. 

  17.         VERSION:     '0.8',
    18. 

  18.         COLLAPSE_INDEX: false,
    19. 

  19.         FILE_SUFFIX: '.html',
    20. 

  20.         HAS_SOURCE:  true
    21. 

  21.       };
    22. 

  22.     </script>
    23. 

  23.     <script type="text/javascript" src="_static/jquery.js"></script>
    24. 

  24.     <script type="text/javascript" src="_static/underscore.js"></script>
    25. 

  25.     <script type="text/javascript" src="_static/doctools.js"></script>
    26. 

  26.     <link rel="top" title="Flask-Maple 0.8 documentation" href="index.html" />
    27. 

  27.     <link rel="prev" title="1 Introduction To Flask-Maple" href="introduction.html" />
    28. 

  28.    
    29. 

  29.   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
    30. 

  30.   
    31. 

  31.   <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />
    32. 

  32. 

  33.   </head>
    34. 

  34.   <body role="document">
    35. 

  35.   
    36. 

  36. 

  37.     <div class="document">
    38. 

  38.       <div class="documentwrapper">
    39. 

  39.         <div class="bodywrapper">
    40. 

  40.           <div class="body" role="main">
    41. 

  41.             
    42. 

  42.   <div class="section" id="advanced">
    43. 

  43. <h1>1 Advanced<a class="headerlink" href="#advanced" title="Permalink to this headline">¶</a></h1>
    44. 

  44. <div class="section" id="bootstrap">
    45. 

  45. <h2>1.1 Bootstrap<a class="headerlink" href="#bootstrap" title="Permalink to this headline">¶</a></h2>
    46. 

  46. <p>You can add you .js file or .css file with flask-assets</p>
    47. 

  47. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">maple</span> <span class="o">=</span> <span class="n">MapleBootstrap</span><span class="p">(</span><span class="n">css</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;style/xxx.css&#39;</span><span class="p">,),</span><span class="n">js</span><span class="o">=</span><span class="p">(</span><span class="s1">&#39;style/xxx.js&#39;</span><span class="p">,))</span>
    48. 

  48. <span class="n">maple</span><span class="o">.</span><span class="n">init_app</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    49. 

  49. </pre></div>
    50. 

  50. </div>
    51. 

  51. <p>or you can add js or css in <strong>templates</strong></p>
    52. 

  52. <div class="highlight-html"><div class="highlight"><pre><span></span>{% block style -%}
    53. 

  53. {{super()}}
    54. 

  54. You css file
    55. 

  55. {% endblock -%}
    56. 

  56. 

  57. {% block script -%}
    58. 

  58. {{super()}}
    59. 

  59. You js file
    60. 

  60. {% endblock -%}
    61. 

  61. </pre></div>
    62. 

  62. </div>
    63. 

  63. <p>other <strong>block</strong></p>
    64. 

  64. <div class="highlight-html"><div class="highlight"><pre><span></span>{% block title -%}
    65. 

  65. {% endblock -%}
    66. 

  66. </pre></div>
    67. 

  67. </div>
    68. 

  68. </div>
    69. 

  69. <div class="section" id="error">
    70. 

  70. <h2>1.2 Error<a class="headerlink" href="#error" title="Permalink to this headline">¶</a></h2>
    71. 

  71. <p>You can custom you template for error</p>
    72. 

  72. <div class="highlight-html"><div class="highlight"><pre><span></span>templates/templet/error_404.html
    73. 

  73. templates/templet/error_403.html
    74. 

  74. templates/templet/error_500.html
    75. 

  75. </pre></div>
    76. 

  76. </div>
    77. 

  77. </div>
    78. 

  78. <div class="section" id="auth">
    79. 

  79. <h2>1.3 Auth<a class="headerlink" href="#auth" title="Permalink to this headline">¶</a></h2>
    80. 

  80. <p><strong>Auth</strong> api</p>
    81. 

  81. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">Auth</span><span class="p">(</span><span class="n">app</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">db</span><span class="o">=</span><span class="n">none</span><span class="p">,</span> <span class="n">mail</span><span class="o">=</span><span class="n">none</span><span class="p">,</span> <span class="n">user_model</span><span class="o">=</span><span class="n">none</span><span class="p">,</span> <span class="n">use_principal</span><span class="o">=</span><span class="n">false</span><span class="p">,</span>
    82. 

  82.         <span class="n">login_form</span><span class="o">=</span><span class="n">loginform</span><span class="p">,</span> <span class="n">register_form</span><span class="o">=</span><span class="n">registerform</span><span class="p">,</span> <span class="n">forget_form</span><span class="o">=</span><span class="n">forgetpasswordform</span><span class="p">):</span>
    83. 

  83. </pre></div>
    84. 

  84. </div>
    85. 

  85. <p><strong>db</strong></p>
    86. 

  86. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">db</span> <span class="o">=</span> <span class="n">SQLAlchemy</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    87. 

  87. <span class="n">app</span> <span class="o">=</span> <span class="n">Flask</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span>
    88. 

  88. <span class="n">app</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">from_object</span><span class="p">(</span><span class="n">Config</span><span class="p">)</span>
    89. 

  89. <span class="n">db</span> <span class="o">=</span> <span class="n">SQLAlchemy</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    90. 

  90. <span class="n">maplec</span> <span class="o">=</span> <span class="n">MapleCaptcha</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    91. 

  91. <span class="n">mapleb</span> <span class="o">=</span> <span class="n">MapleBootstrap</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    92. 

  92. <span class="n">mail</span> <span class="o">=</span> <span class="n">Mail</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    93. 

  93. <span class="n">babel</span> <span class="o">=</span> <span class="n">Babel</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    94. 

  94. </pre></div>
    95. 

  95. </div>
    96. 

  96. <p><strong>mail</strong></p>
    97. 

  97. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="n">mail</span> <span class="o">=</span> <span class="n">Mail</span><span class="p">(</span><span class="n">app</span><span class="p">)</span>
    98. 

  98. </pre></div>
    99. 

  99. </div>
    100. 

  100. <p><strong>user_model</strong></p>
    101. 

  101. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">User</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">Model</span><span class="p">,</span> <span class="n">UserMixin</span><span class="p">):</span>
    102. 

  102.     <span class="nb">id</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">Column</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">Integer</span><span class="p">,</span> <span class="n">primary_key</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    103. 

  103.     <span class="n">username</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">Column</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">String</span><span class="p">(</span><span class="mi">80</span><span class="p">),</span> <span class="n">unique</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    104. 

  104.     <span class="n">email</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">Column</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">String</span><span class="p">(</span><span class="mi">120</span><span class="p">),</span> <span class="n">unique</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    105. 

  105.     <span class="n">password</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">Column</span><span class="p">(</span><span class="n">db</span><span class="o">.</span><span class="n">String</span><span class="p">(</span><span class="mi">120</span><span class="p">),</span> <span class="n">unique</span><span class="o">=</span><span class="bp">True</span><span class="p">)</span>
    106. 

  106. 

  107.     <span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    108. 

  108.         <span class="k">return</span> <span class="s1">&#39;&lt;User </span><span class="si">%r</span><span class="s1">&gt;&#39;</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
    109. 

  109. 

  110.     <span class="nd">@staticmethod</span>
    111. 

  111.     <span class="k">def</span> <span class="nf">set_password</span><span class="p">(</span><span class="n">password</span><span class="p">):</span>
    112. 

  112.         <span class="n">pw_hash</span> <span class="o">=</span> <span class="n">generate_password_hash</span><span class="p">(</span><span class="n">password</span><span class="p">)</span>
    113. 

  113.         <span class="k">return</span> <span class="n">pw_hash</span>
    114. 

  114. 

  115.     <span class="k">def</span> <span class="nf">check_password</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">password</span><span class="p">):</span>
    116. 

  116.         <span class="k">return</span> <span class="n">check_password_hash</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">password</span><span class="p">,</span> <span class="n">password</span><span class="p">)</span>
    117. 

  117. </pre></div>
    118. 

  118. </div>
    119. 

  119. <p><strong>use_principal</strong>
    120. 

  120. if you use flask-principal,then set <em>use_principal = True</em></p>
    121. 

  121. <p><strong>form</strong>
    122. 

  122. You can customize form</p>
    123. 

  123. <p><strong>Custom Model</strong></p>
    124. 

  124. <div class="section" id="register-models">
    125. 

  125. <h3>1.3.1 register_models<a class="headerlink" href="#register-models" title="Permalink to this headline">¶</a></h3>
    126. 

  126. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">flask_maple</span> <span class="kn">import</span> <span class="n">Auth</span>
    127. 

  127. <span class="k">class</span> <span class="nc">MyAuth</span><span class="p">(</span><span class="n">Auth</span><span class="p">):</span>
    128. 

  128.     <span class="k">def</span> <span class="nf">register_models</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">form</span><span class="p">):</span>
    129. 

  129.         <span class="n">user</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">User</span><span class="p">()</span>
    130. 

  130.         <span class="n">user</span><span class="o">.</span><span class="n">username</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">username</span><span class="o">.</span><span class="n">data</span>
    131. 

  131.         <span class="n">user</span><span class="o">.</span><span class="n">password</span> <span class="o">=</span> <span class="n">user</span><span class="o">.</span><span class="n">set_password</span><span class="p">(</span><span class="n">form</span><span class="o">.</span><span class="n">password</span><span class="o">.</span><span class="n">data</span><span class="p">)</span>
    132. 

  132.         <span class="n">user</span><span class="o">.</span><span class="n">email</span> <span class="o">=</span> <span class="n">form</span><span class="o">.</span><span class="n">email</span><span class="o">.</span><span class="n">data</span>
    133. 

  133.         <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">add</span><span class="p">(</span><span class="n">user</span><span class="p">)</span>
    134. 

  134.         <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
    135. 

  135.         <span class="k">return</span> <span class="n">user</span>
    136. 

  136. </pre></div>
    137. 

  137. </div>
    138. 

  138. </div>
    139. 

  139. <div class="section" id="confirm-models">
    140. 

  140. <h3>1.3.2 confirm_models<a class="headerlink" href="#confirm-models" title="Permalink to this headline">¶</a></h3>
    141. 

  141. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyAuth</span><span class="p">(</span><span class="n">Auth</span><span class="p">):</span>
    142. 

  142.     <span class="k">def</span> <span class="nf">confirm_models</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">user</span><span class="p">):</span>
    143. 

  143.         <span class="n">user</span><span class="o">.</span><span class="n">is_confirmed</span> <span class="o">=</span> <span class="bp">True</span>
    144. 

  144.         <span class="n">user</span><span class="o">.</span><span class="n">confirmed_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
    145. 

  145.         <span class="n">user</span><span class="o">.</span><span class="n">roles</span> <span class="o">=</span> <span class="s1">&#39;writer&#39;</span>
    146. 

  146.         <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
    147. 

  147. </pre></div>
    148. 

  148. </div>
    149. 

  149. </div>
    150. 

  150. <div class="section" id="email-models">
    151. 

  151. <h3>1.3.3 email_models<a class="headerlink" href="#email-models" title="Permalink to this headline">¶</a></h3>
    152. 

  152. <div class="highlight-python"><div class="highlight"><pre><span></span><span class="k">class</span> <span class="nc">MyAuth</span><span class="p">(</span><span class="n">Auth</span><span class="p">):</span>
    153. 

  153.     <span class="k">def</span> <span class="nf">email_models</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
    154. 

  154.         <span class="n">current_user</span><span class="o">.</span><span class="n">send_email_time</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span>
    155. 

  155.         <span class="bp">self</span><span class="o">.</span><span class="n">db</span><span class="o">.</span><span class="n">session</span><span class="o">.</span><span class="n">commit</span><span class="p">()</span>
    156. 

  156. </pre></div>
    157. 

  157. </div>
    158. 

  158. </div>
    159. 

  159. </div>
    160. 

  160. </div>
    161. 

  161. 

  162. 

  163.           </div>
    164. 

  164.         </div>
    165. 

  165.       </div>
    166. 

  166.       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
    167. 

  167.         <div class="sphinxsidebarwrapper">
    168. 

  168.   <h3><a href="index.html">Table Of Contents</a></h3>
    169. 

  169.   <ul>
    170. 

  170. <li><a class="reference internal" href="#">1 Advanced</a><ul>
    171. 

  171. <li><a class="reference internal" href="#bootstrap">1.1 Bootstrap</a></li>
    172. 

  172. <li><a class="reference internal" href="#error">1.2 Error</a></li>
    173. 

  173. <li><a class="reference internal" href="#auth">1.3 Auth</a><ul>
    174. 

  174. <li><a class="reference internal" href="#register-models">1.3.1 register_models</a></li>
    175. 

  175. <li><a class="reference internal" href="#confirm-models">1.3.2 confirm_models</a></li>
    176. 

  176. <li><a class="reference internal" href="#email-models">1.3.3 email_models</a></li>
    177. 

  177. </ul>
    178. 

  178. </li>
    179. 

  179. </ul>
    180. 

  180. </li>
    181. 

  181. </ul>
    182. 

  182. <div class="relations">
    183. 

  183. <h3>Related Topics</h3>
    184. 

  184. <ul>
    185. 

  185.   <li><a href="index.html">Documentation overview</a><ul>
    186. 

  186.       <li>Previous: <a href="introduction.html" title="previous chapter">1 Introduction To Flask-Maple</a></li>
    187. 

  187.   </ul></li>
    188. 

  188. </ul>
    189. 

  189. </div>
    190. 

  190.   <div role="note" aria-label="source link">
    191. 

  191.     <h3>This Page</h3>
    192. 

  192.     <ul class="this-page-menu">
    193. 

  193.       <li><a href="_sources/advanced.txt"
    194. 

  194.             rel="nofollow">Show Source</a></li>
    195. 

  195.     </ul>
    196. 

  196.    </div>
    197. 

  197. <div id="searchbox" style="display: none" role="search">
    198. 

  198.   <h3>Quick search</h3>
    199. 

  199.     <form class="search" action="search.html" method="get">
    200. 

  200.       <input type="text" name="q" />
    201. 

  201.       <input type="submit" value="Go" />
    202. 

  202.       <input type="hidden" name="check_keywords" value="yes" />
    203. 

  203.       <input type="hidden" name="area" value="default" />
    204. 

  204.     </form>
    205. 

  205. </div>
    206. 

  206. <script type="text/javascript">$('#searchbox').show(0);</script>
    207. 

  207.         </div>
    208. 

  208.       </div>
    209. 

  209.       <div class="clearer"></div>
    210. 

  210.     </div>
    211. 

  211.     <div class="footer">
    212. 

  212.       &copy;2016, honmaple.
    213. 

  213.       
    214. 

  214.       |
    215. 

  215.       Powered by <a href="http://sphinx-doc.org/">Sphinx 1.4.1</a>
    216. 

  216.       &amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.8</a>
    217. 

  217.       
    218. 

  218.       |
    219. 

  219.       <a href="_sources/advanced.txt"
    220. 

  220.           rel="nofollow">Page source</a>
    221. 

  221.     </div>
    222. 

  222. 

  223.     
    224. 

  224. 

  225.     
    226. 

  226.   </body>
    227. 

  227. </html>
    228.