celery_app_registry.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. <!doctype html PUBLIC "-//W3C//DTD html 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
  2. <html>
  3. <head>
  4. <meta http-equiv='Content-Type' content='text/html; charset=utf-8'>
  5. <meta http-equiv='X-UA-Compatible' content='IE=emulateIE7' />
  6. <title>Coverage for celery.app.registry: 100%</title>
  7. <link rel='stylesheet' href='style.css' type='text/css'>
  8. <script type='text/javascript' src='jquery-1.4.3.min.js'></script>
  9. <script type='text/javascript' src='jquery.hotkeys.js'></script>
  10. <script type='text/javascript' src='jquery.isonscreen.js'></script>
  11. <script type='text/javascript' src='coverage_html.js'></script>
  12. <script type='text/javascript' charset='utf-8'>
  13. jQuery(document).ready(coverage.pyfile_ready);
  14. </script>
  15. </head>
  16. <body id='pyfile'>
  17. <div id='header'>
  18. <div class='content'>
  19. <h1>Coverage for <b>celery.app.registry</b> :
  20. <span class='pc_cov'>100%</span>
  21. </h1>
  22. <img id='keyboard_icon' src='keybd_closed.png'>
  23. <h2 class='stats'>
  24. 30 statements &nbsp;
  25. <span class='run hide_run shortkey_r button_toggle_run'>30 run</span>
  26. <span class='mis shortkey_m button_toggle_mis'>0 missing</span>
  27. <span class='exc shortkey_x button_toggle_exc'>0 excluded</span>
  28. <span class='par run hide_run shortkey_p button_toggle_par'>0 partial</span>
  29. </h2>
  30. </div>
  31. </div>
  32. <div class='help_panel'>
  33. <img id='panel_icon' src='keybd_open.png'>
  34. <p class='legend'>Hot-keys on this page</p>
  35. <div>
  36. <p class='keyhelp'>
  37. <span class='key'>r</span>
  38. <span class='key'>m</span>
  39. <span class='key'>x</span>
  40. <span class='key'>p</span> &nbsp; toggle line displays
  41. </p>
  42. <p class='keyhelp'>
  43. <span class='key'>j</span>
  44. <span class='key'>k</span> &nbsp; next/prev highlighted chunk
  45. </p>
  46. <p class='keyhelp'>
  47. <span class='key'>0</span> &nbsp; (zero) top of page
  48. </p>
  49. <p class='keyhelp'>
  50. <span class='key'>1</span> &nbsp; (one) first highlighted chunk
  51. </p>
  52. </div>
  53. </div>
  54. <div id='source'>
  55. <table cellspacing='0' cellpadding='0'>
  56. <tr>
  57. <td class='linenos' valign='top'>
  58. <p id='n1' class='pln'><a href='#n1'>1</a></p>
  59. <p id='n2' class='stm run hide_run'><a href='#n2'>2</a></p>
  60. <p id='n3' class='pln'><a href='#n3'>3</a></p>
  61. <p id='n4' class='pln'><a href='#n4'>4</a></p>
  62. <p id='n5' class='pln'><a href='#n5'>5</a></p>
  63. <p id='n6' class='pln'><a href='#n6'>6</a></p>
  64. <p id='n7' class='pln'><a href='#n7'>7</a></p>
  65. <p id='n8' class='pln'><a href='#n8'>8</a></p>
  66. <p id='n9' class='stm run hide_run'><a href='#n9'>9</a></p>
  67. <p id='n10' class='pln'><a href='#n10'>10</a></p>
  68. <p id='n11' class='stm run hide_run'><a href='#n11'>11</a></p>
  69. <p id='n12' class='pln'><a href='#n12'>12</a></p>
  70. <p id='n13' class='stm run hide_run'><a href='#n13'>13</a></p>
  71. <p id='n14' class='pln'><a href='#n14'>14</a></p>
  72. <p id='n15' class='stm run hide_run'><a href='#n15'>15</a></p>
  73. <p id='n16' class='stm run hide_run'><a href='#n16'>16</a></p>
  74. <p id='n17' class='stm run hide_run'><a href='#n17'>17</a></p>
  75. <p id='n18' class='pln'><a href='#n18'>18</a></p>
  76. <p id='n19' class='pln'><a href='#n19'>19</a></p>
  77. <p id='n20' class='stm run hide_run'><a href='#n20'>20</a></p>
  78. <p id='n21' class='stm run hide_run'><a href='#n21'>21</a></p>
  79. <p id='n22' class='pln'><a href='#n22'>22</a></p>
  80. <p id='n23' class='stm run hide_run'><a href='#n23'>23</a></p>
  81. <p id='n24' class='stm run hide_run'><a href='#n24'>24</a></p>
  82. <p id='n25' class='pln'><a href='#n25'>25</a></p>
  83. <p id='n26' class='stm run hide_run'><a href='#n26'>26</a></p>
  84. <p id='n27' class='pln'><a href='#n27'>27</a></p>
  85. <p id='n28' class='pln'><a href='#n28'>28</a></p>
  86. <p id='n29' class='pln'><a href='#n29'>29</a></p>
  87. <p id='n30' class='pln'><a href='#n30'>30</a></p>
  88. <p id='n31' class='pln'><a href='#n31'>31</a></p>
  89. <p id='n32' class='pln'><a href='#n32'>32</a></p>
  90. <p id='n33' class='stm run hide_run'><a href='#n33'>33</a></p>
  91. <p id='n34' class='pln'><a href='#n34'>34</a></p>
  92. <p id='n35' class='stm run hide_run'><a href='#n35'>35</a></p>
  93. <p id='n36' class='pln'><a href='#n36'>36</a></p>
  94. <p id='n37' class='pln'><a href='#n37'>37</a></p>
  95. <p id='n38' class='pln'><a href='#n38'>38</a></p>
  96. <p id='n39' class='pln'><a href='#n39'>39</a></p>
  97. <p id='n40' class='pln'><a href='#n40'>40</a></p>
  98. <p id='n41' class='pln'><a href='#n41'>41</a></p>
  99. <p id='n42' class='pln'><a href='#n42'>42</a></p>
  100. <p id='n43' class='pln'><a href='#n43'>43</a></p>
  101. <p id='n44' class='pln'><a href='#n44'>44</a></p>
  102. <p id='n45' class='stm run hide_run'><a href='#n45'>45</a></p>
  103. <p id='n46' class='stm run hide_run'><a href='#n46'>46</a></p>
  104. <p id='n47' class='stm run hide_run'><a href='#n47'>47</a></p>
  105. <p id='n48' class='stm run hide_run'><a href='#n48'>48</a></p>
  106. <p id='n49' class='pln'><a href='#n49'>49</a></p>
  107. <p id='n50' class='pln'><a href='#n50'>50</a></p>
  108. <p id='n51' class='stm run hide_run'><a href='#n51'>51</a></p>
  109. <p id='n52' class='stm run hide_run'><a href='#n52'>52</a></p>
  110. <p id='n53' class='pln'><a href='#n53'>53</a></p>
  111. <p id='n54' class='stm run hide_run'><a href='#n54'>54</a></p>
  112. <p id='n55' class='stm run hide_run'><a href='#n55'>55</a></p>
  113. <p id='n56' class='pln'><a href='#n56'>56</a></p>
  114. <p id='n57' class='stm run hide_run'><a href='#n57'>57</a></p>
  115. <p id='n58' class='stm run hide_run'><a href='#n58'>58</a></p>
  116. <p id='n59' class='pln'><a href='#n59'>59</a></p>
  117. <p id='n60' class='pln'><a href='#n60'>60</a></p>
  118. <p id='n61' class='pln'><a href='#n61'>61</a></p>
  119. <p id='n62' class='stm run hide_run'><a href='#n62'>62</a></p>
  120. <p id='n63' class='stm run hide_run'><a href='#n63'>63</a></p>
  121. <p id='n64' class='pln'><a href='#n64'>64</a></p>
  122. <p id='n65' class='pln'><a href='#n65'>65</a></p>
  123. <p id='n66' class='stm run hide_run'><a href='#n66'>66</a></p>
  124. <p id='n67' class='stm run hide_run'><a href='#n67'>67</a></p>
  125. <p id='n68' class='stm run hide_run'><a href='#n68'>68</a></p>
  126. <p id='n69' class='stm run hide_run'><a href='#n69'>69</a></p>
  127. </td>
  128. <td class='text' valign='top'>
  129. <p id='t1' class='pln'><span class='com'># -*- coding: utf-8 -*-</span><span class='strut'>&nbsp;</span></p>
  130. <p id='t2' class='stm run hide_run'><span class='str'>&quot;&quot;&quot;</span><span class='strut'>&nbsp;</span></p>
  131. <p id='t3' class='pln'><span class='str'>&nbsp; &nbsp; celery.app.registry</span><span class='strut'>&nbsp;</span></p>
  132. <p id='t4' class='pln'><span class='str'>&nbsp; &nbsp; ~~~~~~~~~~~~~~~~~~~</span><span class='strut'>&nbsp;</span></p>
  133. <p id='t5' class='pln'><span class='strut'>&nbsp;</span></p>
  134. <p id='t6' class='pln'><span class='str'>&nbsp; &nbsp; Registry of available tasks.</span><span class='strut'>&nbsp;</span></p>
  135. <p id='t7' class='pln'><span class='strut'>&nbsp;</span></p>
  136. <p id='t8' class='pln'><span class='str'>&quot;&quot;&quot;</span><span class='strut'>&nbsp;</span></p>
  137. <p id='t9' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>__future__</span> <span class='key'>import</span> <span class='nam'>absolute_import</span><span class='strut'>&nbsp;</span></p>
  138. <p id='t10' class='pln'><span class='strut'>&nbsp;</span></p>
  139. <p id='t11' class='stm run hide_run'><span class='key'>import</span> <span class='nam'>inspect</span><span class='strut'>&nbsp;</span></p>
  140. <p id='t12' class='pln'><span class='strut'>&nbsp;</span></p>
  141. <p id='t13' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>importlib</span> <span class='key'>import</span> <span class='nam'>import_module</span><span class='strut'>&nbsp;</span></p>
  142. <p id='t14' class='pln'><span class='strut'>&nbsp;</span></p>
  143. <p id='t15' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>celery</span><span class='op'>.</span><span class='nam'>_state</span> <span class='key'>import</span> <span class='nam'>get_current_app</span><span class='strut'>&nbsp;</span></p>
  144. <p id='t16' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>celery</span><span class='op'>.</span><span class='nam'>exceptions</span> <span class='key'>import</span> <span class='nam'>NotRegistered</span><span class='strut'>&nbsp;</span></p>
  145. <p id='t17' class='stm run hide_run'><span class='key'>from</span> <span class='nam'>celery</span><span class='op'>.</span><span class='nam'>five</span> <span class='key'>import</span> <span class='nam'>items</span><span class='strut'>&nbsp;</span></p>
  146. <p id='t18' class='pln'><span class='strut'>&nbsp;</span></p>
  147. <p id='t19' class='pln'><span class='strut'>&nbsp;</span></p>
  148. <p id='t20' class='stm run hide_run'><span class='key'>class</span> <span class='nam'>TaskRegistry</span><span class='op'>(</span><span class='nam'>dict</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  149. <p id='t21' class='stm run hide_run'>&nbsp; &nbsp; <span class='nam'>NotRegistered</span> <span class='op'>=</span> <span class='nam'>NotRegistered</span><span class='strut'>&nbsp;</span></p>
  150. <p id='t22' class='pln'><span class='strut'>&nbsp;</span></p>
  151. <p id='t23' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>def</span> <span class='nam'>__missing__</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>key</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  152. <p id='t24' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='key'>raise</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>NotRegistered</span><span class='op'>(</span><span class='nam'>key</span><span class='op'>)</span><span class='strut'>&nbsp;</span></p>
  153. <p id='t25' class='pln'><span class='strut'>&nbsp;</span></p>
  154. <p id='t26' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>def</span> <span class='nam'>register</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>task</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  155. <p id='t27' class='pln'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='str'>&quot;&quot;&quot;Register a task in the task registry.</span><span class='strut'>&nbsp;</span></p>
  156. <p id='t28' class='pln'><span class='strut'>&nbsp;</span></p>
  157. <p id='t29' class='pln'><span class='str'>&nbsp; &nbsp; &nbsp; &nbsp; The task will be automatically instantiated if not already an</span><span class='strut'>&nbsp;</span></p>
  158. <p id='t30' class='pln'><span class='str'>&nbsp; &nbsp; &nbsp; &nbsp; instance.</span><span class='strut'>&nbsp;</span></p>
  159. <p id='t31' class='pln'><span class='strut'>&nbsp;</span></p>
  160. <p id='t32' class='pln'><span class='str'>&nbsp; &nbsp; &nbsp; &nbsp; &quot;&quot;&quot;</span><span class='strut'>&nbsp;</span></p>
  161. <p id='t33' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='nam'>self</span><span class='op'>[</span><span class='nam'>task</span><span class='op'>.</span><span class='nam'>name</span><span class='op'>]</span> <span class='op'>=</span> <span class='nam'>inspect</span><span class='op'>.</span><span class='nam'>isclass</span><span class='op'>(</span><span class='nam'>task</span><span class='op'>)</span> <span class='key'>and</span> <span class='nam'>task</span><span class='op'>(</span><span class='op'>)</span> <span class='key'>or</span> <span class='nam'>task</span><span class='strut'>&nbsp;</span></p>
  162. <p id='t34' class='pln'><span class='strut'>&nbsp;</span></p>
  163. <p id='t35' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>def</span> <span class='nam'>unregister</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>name</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  164. <p id='t36' class='pln'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='str'>&quot;&quot;&quot;Unregister task by name.</span><span class='strut'>&nbsp;</span></p>
  165. <p id='t37' class='pln'><span class='strut'>&nbsp;</span></p>
  166. <p id='t38' class='pln'><span class='str'>&nbsp; &nbsp; &nbsp; &nbsp; :param name: name of the task to unregister, or a</span><span class='strut'>&nbsp;</span></p>
  167. <p id='t39' class='pln'><span class='str'>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; :class:`celery.task.base.Task` with a valid `name` attribute.</span><span class='strut'>&nbsp;</span></p>
  168. <p id='t40' class='pln'><span class='strut'>&nbsp;</span></p>
  169. <p id='t41' class='pln'><span class='str'>&nbsp; &nbsp; &nbsp; &nbsp; :raises celery.exceptions.NotRegistered: if the task has not</span><span class='strut'>&nbsp;</span></p>
  170. <p id='t42' class='pln'><span class='str'>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; been registered.</span><span class='strut'>&nbsp;</span></p>
  171. <p id='t43' class='pln'><span class='strut'>&nbsp;</span></p>
  172. <p id='t44' class='pln'><span class='str'>&nbsp; &nbsp; &nbsp; &nbsp; &quot;&quot;&quot;</span><span class='strut'>&nbsp;</span></p>
  173. <p id='t45' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='key'>try</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  174. <p id='t46' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <span class='nam'>self</span><span class='op'>.</span><span class='nam'>pop</span><span class='op'>(</span><span class='nam'>getattr</span><span class='op'>(</span><span class='nam'>name</span><span class='op'>,</span> <span class='str'>&#39;name&#39;</span><span class='op'>,</span> <span class='nam'>name</span><span class='op'>)</span><span class='op'>)</span><span class='strut'>&nbsp;</span></p>
  175. <p id='t47' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='key'>except</span> <span class='nam'>KeyError</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  176. <p id='t48' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <span class='key'>raise</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>NotRegistered</span><span class='op'>(</span><span class='nam'>name</span><span class='op'>)</span><span class='strut'>&nbsp;</span></p>
  177. <p id='t49' class='pln'><span class='strut'>&nbsp;</span></p>
  178. <p id='t50' class='pln'>&nbsp; &nbsp; <span class='com'># -- these methods are irrelevant now and will be removed in 4.0</span><span class='strut'>&nbsp;</span></p>
  179. <p id='t51' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>def</span> <span class='nam'>regular</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  180. <p id='t52' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>filter_types</span><span class='op'>(</span><span class='str'>&#39;regular&#39;</span><span class='op'>)</span><span class='strut'>&nbsp;</span></p>
  181. <p id='t53' class='pln'><span class='strut'>&nbsp;</span></p>
  182. <p id='t54' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>def</span> <span class='nam'>periodic</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  183. <p id='t55' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='key'>return</span> <span class='nam'>self</span><span class='op'>.</span><span class='nam'>filter_types</span><span class='op'>(</span><span class='str'>&#39;periodic&#39;</span><span class='op'>)</span><span class='strut'>&nbsp;</span></p>
  184. <p id='t56' class='pln'><span class='strut'>&nbsp;</span></p>
  185. <p id='t57' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>def</span> <span class='nam'>filter_types</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>,</span> <span class='nam'>type</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  186. <p id='t58' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='key'>return</span> <span class='nam'>dict</span><span class='op'>(</span><span class='op'>(</span><span class='nam'>name</span><span class='op'>,</span> <span class='nam'>task</span><span class='op'>)</span> <span class='key'>for</span> <span class='nam'>name</span><span class='op'>,</span> <span class='nam'>task</span> <span class='key'>in</span> <span class='nam'>items</span><span class='op'>(</span><span class='nam'>self</span><span class='op'>)</span><span class='strut'>&nbsp;</span></p>
  187. <p id='t59' class='pln'>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; <span class='key'>if</span> <span class='nam'>getattr</span><span class='op'>(</span><span class='nam'>task</span><span class='op'>,</span> <span class='str'>&#39;type&#39;</span><span class='op'>,</span> <span class='str'>&#39;regular&#39;</span><span class='op'>)</span> <span class='op'>==</span> <span class='nam'>type</span><span class='op'>)</span><span class='strut'>&nbsp;</span></p>
  188. <p id='t60' class='pln'><span class='strut'>&nbsp;</span></p>
  189. <p id='t61' class='pln'><span class='strut'>&nbsp;</span></p>
  190. <p id='t62' class='stm run hide_run'><span class='key'>def</span> <span class='nam'>_unpickle_task</span><span class='op'>(</span><span class='nam'>name</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  191. <p id='t63' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>return</span> <span class='nam'>get_current_app</span><span class='op'>(</span><span class='op'>)</span><span class='op'>.</span><span class='nam'>tasks</span><span class='op'>[</span><span class='nam'>name</span><span class='op'>]</span><span class='strut'>&nbsp;</span></p>
  192. <p id='t64' class='pln'><span class='strut'>&nbsp;</span></p>
  193. <p id='t65' class='pln'><span class='strut'>&nbsp;</span></p>
  194. <p id='t66' class='stm run hide_run'><span class='key'>def</span> <span class='nam'>_unpickle_task_v2</span><span class='op'>(</span><span class='nam'>name</span><span class='op'>,</span> <span class='nam'>module</span><span class='op'>=</span><span class='nam'>None</span><span class='op'>)</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  195. <p id='t67' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>if</span> <span class='nam'>module</span><span class='op'>:</span><span class='strut'>&nbsp;</span></p>
  196. <p id='t68' class='stm run hide_run'>&nbsp; &nbsp; &nbsp; &nbsp; <span class='nam'>import_module</span><span class='op'>(</span><span class='nam'>module</span><span class='op'>)</span><span class='strut'>&nbsp;</span></p>
  197. <p id='t69' class='stm run hide_run'>&nbsp; &nbsp; <span class='key'>return</span> <span class='nam'>get_current_app</span><span class='op'>(</span><span class='op'>)</span><span class='op'>.</span><span class='nam'>tasks</span><span class='op'>[</span><span class='nam'>name</span><span class='op'>]</span><span class='strut'>&nbsp;</span></p>
  198. </td>
  199. </tr>
  200. </table>
  201. </div>
  202. <div id='footer'>
  203. <div class='content'>
  204. <p>
  205. <a class='nav' href='index.html'>&#xab; index</a> &nbsp; &nbsp; <a class='nav' href='http://nedbatchelder.com/code/coverage'>coverage.py v3.6</a>
  206. </p>
  207. </div>
  208. </div>
  209. </body>
  210. </html>