/usr/share/doc/python-gearman/html/_modules/gearman/worker.html is in python-gearman 2.0.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>gearman.worker — python-gearman v2.0.2 documentation</title>
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '2.0.2',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="top" title="python-gearman v2.0.2 documentation" href="../../index.html" />
<link rel="up" title="Module code" href="../index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">python-gearman v2.0.2 documentation</a> »</li>
<li><a href="../index.html" accesskey="U">Module code</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<h1>Source code for gearman.worker</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">random</span>
<span class="kn">import</span> <span class="nn">sys</span>
<span class="kn">from</span> <span class="nn">gearman</span> <span class="kn">import</span> <span class="n">compat</span>
<span class="kn">from</span> <span class="nn">gearman.connection_manager</span> <span class="kn">import</span> <span class="n">GearmanConnectionManager</span>
<span class="kn">from</span> <span class="nn">gearman.worker_handler</span> <span class="kn">import</span> <span class="n">GearmanWorkerCommandHandler</span>
<span class="kn">from</span> <span class="nn">gearman.errors</span> <span class="kn">import</span> <span class="n">ConnectionError</span>
<span class="n">gearman_logger</span> <span class="o">=</span> <span class="n">logging</span><span class="o">.</span><span class="n">getLogger</span><span class="p">(</span><span class="n">__name__</span><span class="p">)</span>
<span class="n">POLL_TIMEOUT_IN_SECONDS</span> <span class="o">=</span> <span class="mf">60.0</span>
<div class="viewcode-block" id="GearmanWorker"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker">[docs]</a><span class="k">class</span> <span class="nc">GearmanWorker</span><span class="p">(</span><span class="n">GearmanConnectionManager</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> GearmanWorker :: Interface to accept jobs from a Gearman server</span>
<span class="sd"> """</span>
<span class="n">command_handler_class</span> <span class="o">=</span> <span class="n">GearmanWorkerCommandHandler</span>
<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">host_list</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GearmanWorker</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">host_list</span><span class="o">=</span><span class="n">host_list</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">randomized_connections</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">worker_abilities</span> <span class="o">=</span> <span class="p">{}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">worker_client_id</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">command_handler_holding_job_lock</span> <span class="o">=</span> <span class="bp">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_initial_state</span><span class="p">()</span>
<span class="k">def</span> <span class="nf">_update_initial_state</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handler_initial_state</span><span class="p">[</span><span class="s">'abilities'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">worker_abilities</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">handler_initial_state</span><span class="p">[</span><span class="s">'client_id'</span><span class="p">]</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">worker_client_id</span>
<span class="c">########################################################</span>
<span class="c">##### Public methods for general GearmanWorker use #####</span>
<span class="c">########################################################</span>
<div class="viewcode-block" id="GearmanWorker.register_task"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker.register_task">[docs]</a> <span class="k">def</span> <span class="nf">register_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task</span><span class="p">,</span> <span class="n">callback_function</span><span class="p">):</span>
<span class="sd">"""Register a function with this worker</span>
<span class="sd"> def function_callback(calling_gearman_worker, current_job):</span>
<span class="sd"> return current_job.data</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">worker_abilities</span><span class="p">[</span><span class="n">task</span><span class="p">]</span> <span class="o">=</span> <span class="n">callback_function</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_initial_state</span><span class="p">()</span>
<span class="k">for</span> <span class="n">command_handler</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">handler_to_connection_map</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">():</span>
<span class="n">command_handler</span><span class="o">.</span><span class="n">set_abilities</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handler_initial_state</span><span class="p">[</span><span class="s">'abilities'</span><span class="p">])</span>
<span class="k">return</span> <span class="n">task</span>
</div>
<div class="viewcode-block" id="GearmanWorker.unregister_task"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker.unregister_task">[docs]</a> <span class="k">def</span> <span class="nf">unregister_task</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">task</span><span class="p">):</span>
<span class="sd">"""Unregister a function with worker"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">worker_abilities</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">task</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_initial_state</span><span class="p">()</span>
<span class="k">for</span> <span class="n">command_handler</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">handler_to_connection_map</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">():</span>
<span class="n">command_handler</span><span class="o">.</span><span class="n">set_abilities</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handler_initial_state</span><span class="p">[</span><span class="s">'abilities'</span><span class="p">])</span>
<span class="k">return</span> <span class="n">task</span>
</div>
<div class="viewcode-block" id="GearmanWorker.set_client_id"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker.set_client_id">[docs]</a> <span class="k">def</span> <span class="nf">set_client_id</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">client_id</span><span class="p">):</span>
<span class="sd">"""Notify the server that we should be identified as this client ID"""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">worker_client_id</span> <span class="o">=</span> <span class="n">client_id</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_update_initial_state</span><span class="p">()</span>
<span class="k">for</span> <span class="n">command_handler</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">handler_to_connection_map</span><span class="o">.</span><span class="n">iterkeys</span><span class="p">():</span>
<span class="n">command_handler</span><span class="o">.</span><span class="n">set_client_id</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">handler_initial_state</span><span class="p">[</span><span class="s">'client_id'</span><span class="p">])</span>
<span class="k">return</span> <span class="n">client_id</span>
</div>
<div class="viewcode-block" id="GearmanWorker.work"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker.work">[docs]</a> <span class="k">def</span> <span class="nf">work</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">POLL_TIMEOUT_IN_SECONDS</span><span class="p">):</span>
<span class="sd">"""Loop indefinitely, complete tasks from all connections."""</span>
<span class="n">continue_working</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">worker_connections</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">def</span> <span class="nf">continue_while_connections_alive</span><span class="p">(</span><span class="n">any_activity</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">after_poll</span><span class="p">(</span><span class="n">any_activity</span><span class="p">)</span>
<span class="c"># Shuffle our connections after the poll timeout</span>
<span class="k">while</span> <span class="n">continue_working</span><span class="p">:</span>
<span class="n">worker_connections</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">establish_worker_connections</span><span class="p">()</span>
<span class="n">continue_working</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">poll_connections_until_stopped</span><span class="p">(</span><span class="n">worker_connections</span><span class="p">,</span> <span class="n">continue_while_connections_alive</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">poll_timeout</span><span class="p">)</span>
<span class="c"># If we were kicked out of the worker loop, we should shutdown all our connections</span>
<span class="k">for</span> <span class="n">current_connection</span> <span class="ow">in</span> <span class="n">worker_connections</span><span class="p">:</span>
<span class="n">current_connection</span><span class="o">.</span><span class="n">close</span><span class="p">()</span>
</div>
<span class="k">def</span> <span class="nf">shutdown</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">command_handler_holding_job_lock</span> <span class="o">=</span> <span class="bp">None</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GearmanWorker</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">shutdown</span><span class="p">()</span>
<span class="c">###############################################################</span>
<span class="c">## Methods to override when dealing with connection polling ##</span>
<span class="c">##############################################################</span>
<span class="k">def</span> <span class="nf">establish_worker_connections</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Return a shuffled list of connections that are alive, and try to reconnect to dead connections if necessary."""</span>
<span class="bp">self</span><span class="o">.</span><span class="n">randomized_connections</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">connection_list</span><span class="p">)</span>
<span class="n">random</span><span class="o">.</span><span class="n">shuffle</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">randomized_connections</span><span class="p">)</span>
<span class="n">output_connections</span> <span class="o">=</span> <span class="p">[]</span>
<span class="k">for</span> <span class="n">current_connection</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">randomized_connections</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">valid_connection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">establish_connection</span><span class="p">(</span><span class="n">current_connection</span><span class="p">)</span>
<span class="n">output_connections</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">valid_connection</span><span class="p">)</span>
<span class="k">except</span> <span class="n">ConnectionError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">return</span> <span class="n">output_connections</span>
<div class="viewcode-block" id="GearmanWorker.after_poll"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker.after_poll">[docs]</a> <span class="k">def</span> <span class="nf">after_poll</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">any_activity</span><span class="p">):</span>
<span class="sd">"""Polling callback to notify any outside listeners whats going on with the GearmanWorker.</span>
<span class="sd"> Return True to continue polling, False to exit the work loop"""</span>
<span class="k">return</span> <span class="bp">True</span>
</div>
<span class="k">def</span> <span class="nf">handle_error</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_connection</span><span class="p">):</span>
<span class="sd">"""If we discover that a connection has a problem, we better release the job lock"""</span>
<span class="n">current_handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection_to_handler_map</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">current_connection</span><span class="p">)</span>
<span class="k">if</span> <span class="n">current_handler</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_job_lock</span><span class="p">(</span><span class="n">current_handler</span><span class="p">,</span> <span class="n">lock</span><span class="o">=</span><span class="bp">False</span><span class="p">)</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GearmanWorker</span><span class="p">,</span> <span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">handle_error</span><span class="p">(</span><span class="n">current_connection</span><span class="p">)</span>
<span class="c">#############################################################</span>
<span class="c">## Public methods so Gearman jobs can send Gearman updates ##</span>
<span class="c">#############################################################</span>
<span class="k">def</span> <span class="nf">_get_handler_for_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">):</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection_to_handler_map</span><span class="p">[</span><span class="n">current_job</span><span class="o">.</span><span class="n">connection</span><span class="p">]</span>
<span class="k">def</span> <span class="nf">wait_until_updates_sent</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">multiple_gearman_jobs</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="n">connection_set</span> <span class="o">=</span> <span class="nb">set</span><span class="p">([</span><span class="n">current_job</span><span class="o">.</span><span class="n">connection</span> <span class="k">for</span> <span class="n">current_job</span> <span class="ow">in</span> <span class="n">multiple_gearman_jobs</span><span class="p">])</span>
<span class="k">def</span> <span class="nf">continue_while_updates_pending</span><span class="p">(</span><span class="n">any_activity</span><span class="p">):</span>
<span class="k">return</span> <span class="n">compat</span><span class="o">.</span><span class="n">any</span><span class="p">(</span><span class="n">current_connection</span><span class="o">.</span><span class="n">writable</span><span class="p">()</span> <span class="k">for</span> <span class="n">current_connection</span> <span class="ow">in</span> <span class="n">connection_set</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">poll_connections_until_stopped</span><span class="p">(</span><span class="n">connection_set</span><span class="p">,</span> <span class="n">continue_while_updates_pending</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">poll_timeout</span><span class="p">)</span>
<div class="viewcode-block" id="GearmanWorker.send_job_status"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker.send_job_status">[docs]</a> <span class="k">def</span> <span class="nf">send_job_status</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">,</span> <span class="n">numerator</span><span class="p">,</span> <span class="n">denominator</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Send a Gearman JOB_STATUS update for an inflight job"""</span>
<span class="n">current_handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_handler_for_job</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="n">current_handler</span><span class="o">.</span><span class="n">send_job_status</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">numerator</span><span class="o">=</span><span class="n">numerator</span><span class="p">,</span> <span class="n">denominator</span><span class="o">=</span><span class="n">denominator</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_updates_sent</span><span class="p">([</span><span class="n">current_job</span><span class="p">],</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">poll_timeout</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">send_job_complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="n">current_handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_handler_for_job</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="n">current_handler</span><span class="o">.</span><span class="n">send_job_complete</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_updates_sent</span><span class="p">([</span><span class="n">current_job</span><span class="p">],</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">poll_timeout</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">send_job_failure</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Removes a job from the queue if its backgrounded"""</span>
<span class="n">current_handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_handler_for_job</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="n">current_handler</span><span class="o">.</span><span class="n">send_job_failure</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_updates_sent</span><span class="p">([</span><span class="n">current_job</span><span class="p">],</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">poll_timeout</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">send_job_exception</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Removes a job from the queue if its backgrounded"""</span>
<span class="c"># Using GEARMAND_COMMAND_WORK_EXCEPTION is not recommended at time of this writing [2010-02-24]</span>
<span class="c"># http://groups.google.com/group/gearman/browse_thread/thread/5c91acc31bd10688/529e586405ed37fe</span>
<span class="c">#</span>
<span class="n">current_handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_handler_for_job</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="n">current_handler</span><span class="o">.</span><span class="n">send_job_exception</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
<span class="n">current_handler</span><span class="o">.</span><span class="n">send_job_failure</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_updates_sent</span><span class="p">([</span><span class="n">current_job</span><span class="p">],</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">poll_timeout</span><span class="p">)</span>
<div class="viewcode-block" id="GearmanWorker.send_job_data"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker.send_job_data">[docs]</a> <span class="k">def</span> <span class="nf">send_job_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Send a Gearman JOB_DATA update for an inflight job"""</span>
<span class="n">current_handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_handler_for_job</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="n">current_handler</span><span class="o">.</span><span class="n">send_job_data</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_updates_sent</span><span class="p">([</span><span class="n">current_job</span><span class="p">],</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">poll_timeout</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="GearmanWorker.send_job_warning"><a class="viewcode-back" href="../../worker.html#gearman.worker.GearmanWorker.send_job_warning">[docs]</a> <span class="k">def</span> <span class="nf">send_job_warning</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Send a Gearman JOB_WARNING update for an inflight job"""</span>
<span class="n">current_handler</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_handler_for_job</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="n">current_handler</span><span class="o">.</span><span class="n">send_job_warning</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_until_updates_sent</span><span class="p">([</span><span class="n">current_job</span><span class="p">],</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">poll_timeout</span><span class="p">)</span>
<span class="c">#####################################################</span>
<span class="c">##### Callback methods for GearmanWorkerHandler #####</span>
<span class="c">#####################################################</span></div>
<span class="k">def</span> <span class="nf">create_job</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command_handler</span><span class="p">,</span> <span class="n">job_handle</span><span class="p">,</span> <span class="n">task</span><span class="p">,</span> <span class="n">unique</span><span class="p">,</span> <span class="n">data</span><span class="p">):</span>
<span class="sd">"""Create a new job using our self.job_class"""</span>
<span class="n">current_connection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">handler_to_connection_map</span><span class="p">[</span><span class="n">command_handler</span><span class="p">]</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">job_class</span><span class="p">(</span><span class="n">current_connection</span><span class="p">,</span> <span class="n">job_handle</span><span class="p">,</span> <span class="n">task</span><span class="p">,</span> <span class="n">unique</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">on_job_execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">function_callback</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">worker_abilities</span><span class="p">[</span><span class="n">current_job</span><span class="o">.</span><span class="n">task</span><span class="p">]</span>
<span class="n">job_result</span> <span class="o">=</span> <span class="n">function_callback</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_job_exception</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">sys</span><span class="o">.</span><span class="n">exc_info</span><span class="p">())</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">on_job_complete</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">job_result</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">on_job_exception</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">,</span> <span class="n">exc_info</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">send_job_failure</span><span class="p">(</span><span class="n">current_job</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">def</span> <span class="nf">on_job_complete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_job</span><span class="p">,</span> <span class="n">job_result</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">send_job_complete</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">job_result</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">def</span> <span class="nf">set_job_lock</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command_handler</span><span class="p">,</span> <span class="n">lock</span><span class="p">):</span>
<span class="sd">"""Set a worker level job lock so we don't try to hold onto 2 jobs at anytime"""</span>
<span class="k">if</span> <span class="n">command_handler</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">handler_to_connection_map</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="n">failed_lock</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="n">lock</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">command_handler_holding_job_lock</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">)</span>
<span class="n">failed_unlock</span> <span class="o">=</span> <span class="nb">bool</span><span class="p">(</span><span class="ow">not</span> <span class="n">lock</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">command_handler_holding_job_lock</span> <span class="o">!=</span> <span class="n">command_handler</span><span class="p">)</span>
<span class="c"># If we've already been locked, we should say the lock failed</span>
<span class="c"># If we're attempting to unlock something when we don't have a lock, we're in a bad state</span>
<span class="k">if</span> <span class="n">failed_lock</span> <span class="ow">or</span> <span class="n">failed_unlock</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">if</span> <span class="n">lock</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">command_handler_holding_job_lock</span> <span class="o">=</span> <span class="n">command_handler</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">command_handler_holding_job_lock</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">def</span> <span class="nf">check_job_lock</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">command_handler</span><span class="p">):</span>
<span class="sd">"""Check to see if we hold the job lock"""</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">command_handler_holding_job_lock</span> <span class="o">==</span> <span class="n">command_handler</span><span class="p">)</span></div>
</pre></div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="../../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li><a href="../../index.html">python-gearman v2.0.2 documentation</a> »</li>
<li><a href="../index.html" >Module code</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010, Matthew Tai.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
</div>
</body>
</html>
|