/usr/share/doc/python-gearman/html/_modules/gearman/client.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 | <!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.client — 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.client</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">collections</span>
<span class="kn">from</span> <span class="nn">gearman</span> <span class="kn">import</span> <span class="n">compat</span>
<span class="kn">import</span> <span class="nn">logging</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">random</span>
<span class="kn">import</span> <span class="nn">gearman.util</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.client_handler</span> <span class="kn">import</span> <span class="n">GearmanClientCommandHandler</span>
<span class="kn">from</span> <span class="nn">gearman.constants</span> <span class="kn">import</span> <span class="n">PRIORITY_NONE</span><span class="p">,</span> <span class="n">PRIORITY_LOW</span><span class="p">,</span> <span class="n">PRIORITY_HIGH</span><span class="p">,</span> <span class="n">JOB_UNKNOWN</span><span class="p">,</span> <span class="n">JOB_PENDING</span>
<span class="kn">from</span> <span class="nn">gearman.errors</span> <span class="kn">import</span> <span class="n">ConnectionError</span><span class="p">,</span> <span class="n">ExceededConnectionAttempts</span><span class="p">,</span> <span class="n">ServerUnavailable</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="c"># This number must be <= GEARMAN_UNIQUE_SIZE in gearman/libgearman/constants.h </span>
<span class="n">RANDOM_UNIQUE_BYTES</span> <span class="o">=</span> <span class="mi">16</span>
<div class="viewcode-block" id="GearmanClient"><a class="viewcode-back" href="../../client.html#gearman.client.GearmanClient">[docs]</a><span class="k">class</span> <span class="nc">GearmanClient</span><span class="p">(</span><span class="n">GearmanConnectionManager</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> GearmanClient :: Interface to submit jobs to a Gearman server</span>
<span class="sd"> """</span>
<span class="n">command_handler_class</span> <span class="o">=</span> <span class="n">GearmanClientCommandHandler</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="n">random_unique_bytes</span><span class="o">=</span><span class="n">RANDOM_UNIQUE_BYTES</span><span class="p">):</span>
<span class="nb">super</span><span class="p">(</span><span class="n">GearmanClient</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">random_unique_bytes</span> <span class="o">=</span> <span class="n">random_unique_bytes</span>
<span class="c"># The authoritative copy of all requests that this client knows about</span>
<span class="c"># Ignores the fact if a request has been bound to a connection or not</span>
<span class="bp">self</span><span class="o">.</span><span class="n">request_to_rotating_connection_queue</span> <span class="o">=</span> <span class="n">compat</span><span class="o">.</span><span class="n">defaultdict</span><span class="p">(</span><span class="n">collections</span><span class="o">.</span><span class="n">deque</span><span class="p">)</span>
<div class="viewcode-block" id="GearmanClient.submit_job"><a class="viewcode-back" href="../../client.html#gearman.client.GearmanClient.submit_job">[docs]</a> <span class="k">def</span> <span class="nf">submit_job</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">data</span><span class="p">,</span> <span class="n">unique</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="n">PRIORITY_NONE</span><span class="p">,</span> <span class="n">background</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">wait_until_complete</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">max_retries</span><span class="o">=</span><span class="mi">0</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">"""Submit a single job to any gearman server"""</span>
<span class="n">job_info</span> <span class="o">=</span> <span class="nb">dict</span><span class="p">(</span><span class="n">task</span><span class="o">=</span><span class="n">task</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">unique</span><span class="o">=</span><span class="n">unique</span><span class="p">,</span> <span class="n">priority</span><span class="o">=</span><span class="n">priority</span><span class="p">)</span>
<span class="n">completed_job_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">submit_multiple_jobs</span><span class="p">([</span><span class="n">job_info</span><span class="p">],</span> <span class="n">background</span><span class="o">=</span><span class="n">background</span><span class="p">,</span> <span class="n">wait_until_complete</span><span class="o">=</span><span class="n">wait_until_complete</span><span class="p">,</span> <span class="n">max_retries</span><span class="o">=</span><span class="n">max_retries</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">return</span> <span class="n">gearman</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">unlist</span><span class="p">(</span><span class="n">completed_job_list</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="GearmanClient.submit_multiple_jobs"><a class="viewcode-back" href="../../client.html#gearman.client.GearmanClient.submit_multiple_jobs">[docs]</a> <span class="k">def</span> <span class="nf">submit_multiple_jobs</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">jobs_to_submit</span><span class="p">,</span> <span class="n">background</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">wait_until_complete</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">max_retries</span><span class="o">=</span><span class="mi">0</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">"""Takes a list of jobs_to_submit with dicts of</span>
<span class="sd"> {'task': task, 'data': data, 'unique': unique, 'priority': priority}</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">jobs_to_submit</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">,</span> <span class="nb">set</span><span class="p">),</span> <span class="s">"Expected multiple jobs, received 1?"</span>
<span class="c"># Convert all job dicts to job request objects</span>
<span class="n">requests_to_submit</span> <span class="o">=</span> <span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">_create_request_from_dictionary</span><span class="p">(</span><span class="n">job_info</span><span class="p">,</span> <span class="n">background</span><span class="o">=</span><span class="n">background</span><span class="p">,</span> <span class="n">max_retries</span><span class="o">=</span><span class="n">max_retries</span><span class="p">)</span> <span class="k">for</span> <span class="n">job_info</span> <span class="ow">in</span> <span class="n">jobs_to_submit</span><span class="p">]</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">submit_multiple_requests</span><span class="p">(</span><span class="n">requests_to_submit</span><span class="p">,</span> <span class="n">wait_until_complete</span><span class="o">=</span><span class="n">wait_until_complete</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="GearmanClient.submit_multiple_requests"><a class="viewcode-back" href="../../client.html#gearman.client.GearmanClient.submit_multiple_requests">[docs]</a> <span class="k">def</span> <span class="nf">submit_multiple_requests</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_requests</span><span class="p">,</span> <span class="n">wait_until_complete</span><span class="o">=</span><span class="bp">True</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">"""Take GearmanJobRequests, assign them connections, and request that they be done.</span>
<span class="sd"> * Blocks until our jobs are accepted (should be fast) OR times out</span>
<span class="sd"> * Optionally blocks until jobs are all complete</span>
<span class="sd"> You MUST check the status of your requests after calling this function as "timed_out" or "state == JOB_UNKNOWN" maybe True</span>
<span class="sd"> """</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">job_requests</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">,</span> <span class="nb">set</span><span class="p">),</span> <span class="s">"Expected multiple job requests, received 1?"</span>
<span class="n">stopwatch</span> <span class="o">=</span> <span class="n">gearman</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">Stopwatch</span><span class="p">(</span><span class="n">poll_timeout</span><span class="p">)</span>
<span class="c"># We should always wait until our job is accepted, this should be fast</span>
<span class="n">time_remaining</span> <span class="o">=</span> <span class="n">stopwatch</span><span class="o">.</span><span class="n">get_time_remaining</span><span class="p">()</span>
<span class="n">processed_requests</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_until_jobs_accepted</span><span class="p">(</span><span class="n">job_requests</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">time_remaining</span><span class="p">)</span>
<span class="c"># Optionally, we'll allow a user to wait until all jobs are complete with the same poll_timeout</span>
<span class="n">time_remaining</span> <span class="o">=</span> <span class="n">stopwatch</span><span class="o">.</span><span class="n">get_time_remaining</span><span class="p">()</span>
<span class="k">if</span> <span class="n">wait_until_complete</span> <span class="ow">and</span> <span class="nb">bool</span><span class="p">(</span><span class="n">time_remaining</span> <span class="o">!=</span> <span class="mf">0.0</span><span class="p">):</span>
<span class="n">processed_requests</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_until_jobs_completed</span><span class="p">(</span><span class="n">processed_requests</span><span class="p">,</span> <span class="n">poll_timeout</span><span class="o">=</span><span class="n">time_remaining</span><span class="p">)</span>
<span class="k">return</span> <span class="n">processed_requests</span>
</div>
<div class="viewcode-block" id="GearmanClient.wait_until_jobs_accepted"><a class="viewcode-back" href="../../client.html#gearman.client.GearmanClient.wait_until_jobs_accepted">[docs]</a> <span class="k">def</span> <span class="nf">wait_until_jobs_accepted</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_requests</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">"""Go into a select loop until all our jobs have moved to STATE_PENDING"""</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">job_requests</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">,</span> <span class="nb">set</span><span class="p">),</span> <span class="s">"Expected multiple job requests, received 1?"</span>
<span class="k">def</span> <span class="nf">is_request_pending</span><span class="p">(</span><span class="n">current_request</span><span class="p">):</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">current_request</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">JOB_PENDING</span><span class="p">)</span>
<span class="c"># Poll until we know we've gotten acknowledgement that our job's been accepted</span>
<span class="c"># If our connection fails while we're waiting for it to be accepted, automatically retry right here</span>
<span class="k">def</span> <span class="nf">continue_while_jobs_pending</span><span class="p">(</span><span class="n">any_activity</span><span class="p">):</span>
<span class="k">for</span> <span class="n">current_request</span> <span class="ow">in</span> <span class="n">job_requests</span><span class="p">:</span>
<span class="k">if</span> <span class="n">current_request</span><span class="o">.</span><span class="n">state</span> <span class="o">==</span> <span class="n">JOB_UNKNOWN</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">send_job_request</span><span class="p">(</span><span class="n">current_request</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">is_request_pending</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span> <span class="k">for</span> <span class="n">current_request</span> <span class="ow">in</span> <span class="n">job_requests</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="bp">self</span><span class="o">.</span><span class="n">connection_list</span><span class="p">,</span> <span class="n">continue_while_jobs_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>
<span class="c"># Mark any job still in the queued state to poll_timeout</span>
<span class="k">for</span> <span class="n">current_request</span> <span class="ow">in</span> <span class="n">job_requests</span><span class="p">:</span>
<span class="n">current_request</span><span class="o">.</span><span class="n">timed_out</span> <span class="o">=</span> <span class="n">is_request_pending</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span>
<span class="k">return</span> <span class="n">job_requests</span>
</div>
<div class="viewcode-block" id="GearmanClient.wait_until_jobs_completed"><a class="viewcode-back" href="../../client.html#gearman.client.GearmanClient.wait_until_jobs_completed">[docs]</a> <span class="k">def</span> <span class="nf">wait_until_jobs_completed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_requests</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">"""Go into a select loop until all our jobs have completed or failed"""</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">job_requests</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">,</span> <span class="nb">set</span><span class="p">),</span> <span class="s">"Expected multiple job requests, received 1?"</span>
<span class="k">def</span> <span class="nf">is_request_incomplete</span><span class="p">(</span><span class="n">current_request</span><span class="p">):</span>
<span class="k">return</span> <span class="ow">not</span> <span class="n">current_request</span><span class="o">.</span><span class="n">complete</span>
<span class="c"># Poll until we get responses for all our functions</span>
<span class="c"># Do NOT attempt to auto-retry connection failures as we have no idea how for a worker got</span>
<span class="k">def</span> <span class="nf">continue_while_jobs_incomplete</span><span class="p">(</span><span class="n">any_activity</span><span class="p">):</span>
<span class="k">for</span> <span class="n">current_request</span> <span class="ow">in</span> <span class="n">job_requests</span><span class="p">:</span>
<span class="k">if</span> <span class="n">is_request_incomplete</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span> <span class="ow">and</span> <span class="n">current_request</span><span class="o">.</span><span class="n">state</span> <span class="o">!=</span> <span class="n">JOB_UNKNOWN</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">poll_connections_until_stopped</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">continue_while_jobs_incomplete</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"># Mark any job still in the queued state to poll_timeout</span>
<span class="k">for</span> <span class="n">current_request</span> <span class="ow">in</span> <span class="n">job_requests</span><span class="p">:</span>
<span class="n">current_request</span><span class="o">.</span><span class="n">timed_out</span> <span class="o">=</span> <span class="n">is_request_incomplete</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">current_request</span><span class="o">.</span><span class="n">timed_out</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">request_to_rotating_connection_queue</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">current_request</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">return</span> <span class="n">job_requests</span>
</div>
<div class="viewcode-block" id="GearmanClient.get_job_status"><a class="viewcode-back" href="../../client.html#gearman.client.GearmanClient.get_job_status">[docs]</a> <span class="k">def</span> <span class="nf">get_job_status</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_request</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">"""Fetch the job status of a single request"""</span>
<span class="n">request_list</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_job_statuses</span><span class="p">([</span><span class="n">current_request</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">return</span> <span class="n">gearman</span><span class="o">.</span><span class="n">util</span><span class="o">.</span><span class="n">unlist</span><span class="p">(</span><span class="n">request_list</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="GearmanClient.get_job_statuses"><a class="viewcode-back" href="../../client.html#gearman.client.GearmanClient.get_job_statuses">[docs]</a> <span class="k">def</span> <span class="nf">get_job_statuses</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_requests</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">"""Fetch the job status of a multiple requests"""</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">job_requests</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">,</span> <span class="nb">set</span><span class="p">),</span> <span class="s">"Expected multiple job requests, received 1?"</span>
<span class="k">for</span> <span class="n">current_request</span> <span class="ow">in</span> <span class="n">job_requests</span><span class="p">:</span>
<span class="n">current_request</span><span class="o">.</span><span class="n">status</span><span class="p">[</span><span class="s">'last_time_received'</span><span class="p">]</span> <span class="o">=</span> <span class="n">current_request</span><span class="o">.</span><span class="n">status</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'time_received'</span><span class="p">)</span>
<span class="n">current_connection</span> <span class="o">=</span> <span class="n">current_request</span><span class="o">.</span><span class="n">job</span><span class="o">.</span><span class="n">connection</span>
<span class="n">current_command_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="p">[</span><span class="n">current_connection</span><span class="p">]</span>
<span class="n">current_command_handler</span><span class="o">.</span><span class="n">send_get_status_of_job</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">wait_until_job_statuses_received</span><span class="p">(</span><span class="n">job_requests</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">wait_until_job_statuses_received</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_requests</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">"""Go into a select loop until we received statuses on all our requests"""</span>
<span class="k">assert</span> <span class="nb">type</span><span class="p">(</span><span class="n">job_requests</span><span class="p">)</span> <span class="ow">in</span> <span class="p">(</span><span class="nb">list</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">,</span> <span class="nb">set</span><span class="p">),</span> <span class="s">"Expected multiple job requests, received 1?"</span>
<span class="k">def</span> <span class="nf">is_status_not_updated</span><span class="p">(</span><span class="n">current_request</span><span class="p">):</span>
<span class="n">current_status</span> <span class="o">=</span> <span class="n">current_request</span><span class="o">.</span><span class="n">status</span>
<span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">current_status</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'time_received'</span><span class="p">)</span> <span class="o">==</span> <span class="n">current_status</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'last_time_received'</span><span class="p">))</span>
<span class="c"># Poll to make sure we send out our request for a status update</span>
<span class="k">def</span> <span class="nf">continue_while_status_not_updated</span><span class="p">(</span><span class="n">any_activity</span><span class="p">):</span>
<span class="k">for</span> <span class="n">current_request</span> <span class="ow">in</span> <span class="n">job_requests</span><span class="p">:</span>
<span class="k">if</span> <span class="n">is_status_not_updated</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span> <span class="ow">and</span> <span class="n">current_request</span><span class="o">.</span><span class="n">state</span> <span class="o">!=</span> <span class="n">JOB_UNKNOWN</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="bp">self</span><span class="o">.</span><span class="n">poll_connections_until_stopped</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">continue_while_status_not_updated</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="k">for</span> <span class="n">current_request</span> <span class="ow">in</span> <span class="n">job_requests</span><span class="p">:</span>
<span class="n">current_request</span><span class="o">.</span><span class="n">status</span> <span class="o">=</span> <span class="n">current_request</span><span class="o">.</span><span class="n">status</span> <span class="ow">or</span> <span class="p">{}</span>
<span class="n">current_request</span><span class="o">.</span><span class="n">timed_out</span> <span class="o">=</span> <span class="n">is_status_not_updated</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span>
<span class="k">return</span> <span class="n">job_requests</span>
<span class="k">def</span> <span class="nf">_create_request_from_dictionary</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">job_info</span><span class="p">,</span> <span class="n">background</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">max_retries</span><span class="o">=</span><span class="mi">0</span><span class="p">):</span>
<span class="sd">"""Takes a dictionary with fields {'task': task, 'unique': unique, 'data': data, 'priority': priority, 'background': background}"""</span>
<span class="c"># Make sure we have a unique identifier for ALL our tasks</span>
<span class="n">job_unique</span> <span class="o">=</span> <span class="n">job_info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'unique'</span><span class="p">)</span>
<span class="k">if</span> <span class="n">job_unique</span> <span class="o">==</span> <span class="s">'-'</span><span class="p">:</span>
<span class="n">job_unique</span> <span class="o">=</span> <span class="n">job_info</span><span class="p">[</span><span class="s">'data'</span><span class="p">]</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="n">job_unique</span><span class="p">:</span>
<span class="n">job_unique</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">urandom</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">random_unique_bytes</span><span class="p">)</span><span class="o">.</span><span class="n">encode</span><span class="p">(</span><span class="s">'hex'</span><span class="p">)</span>
<span class="n">current_job</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">job_class</span><span class="p">(</span><span class="n">connection</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">handle</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">task</span><span class="o">=</span><span class="n">job_info</span><span class="p">[</span><span class="s">'task'</span><span class="p">],</span> <span class="n">unique</span><span class="o">=</span><span class="n">job_unique</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">job_info</span><span class="p">[</span><span class="s">'data'</span><span class="p">])</span>
<span class="n">initial_priority</span> <span class="o">=</span> <span class="n">job_info</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s">'priority'</span><span class="p">,</span> <span class="n">PRIORITY_NONE</span><span class="p">)</span>
<span class="n">max_attempts</span> <span class="o">=</span> <span class="n">max_retries</span> <span class="o">+</span> <span class="mi">1</span>
<span class="n">current_request</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">job_request_class</span><span class="p">(</span><span class="n">current_job</span><span class="p">,</span> <span class="n">initial_priority</span><span class="o">=</span><span class="n">initial_priority</span><span class="p">,</span> <span class="n">background</span><span class="o">=</span><span class="n">background</span><span class="p">,</span> <span class="n">max_attempts</span><span class="o">=</span><span class="n">max_attempts</span><span class="p">)</span>
<span class="k">return</span> <span class="n">current_request</span>
<span class="k">def</span> <span class="nf">establish_request_connection</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_request</span><span class="p">):</span>
<span class="sd">"""Return a live connection for the given hash"""</span>
<span class="c"># We'll keep track of the connections we're attempting to use so if we ever have to retry, we can use this history</span>
<span class="n">rotating_connections</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">request_to_rotating_connection_queue</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">current_request</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">rotating_connections</span><span class="p">:</span>
<span class="n">shuffled_connection_list</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="n">shuffled_connection_list</span><span class="p">)</span>
<span class="n">rotating_connections</span> <span class="o">=</span> <span class="n">collections</span><span class="o">.</span><span class="n">deque</span><span class="p">(</span><span class="n">shuffled_connection_list</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">request_to_rotating_connection_queue</span><span class="p">[</span><span class="n">current_request</span><span class="p">]</span> <span class="o">=</span> <span class="n">rotating_connections</span>
<span class="n">failed_connections</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">chosen_connection</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">for</span> <span class="n">possible_connection</span> <span class="ow">in</span> <span class="n">rotating_connections</span><span class="p">:</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">chosen_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">possible_connection</span><span class="p">)</span>
<span class="k">break</span>
<span class="k">except</span> <span class="n">ConnectionError</span><span class="p">:</span>
<span class="c"># Rotate our server list so we'll skip all our broken servers</span>
<span class="n">failed_connections</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">chosen_connection</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ServerUnavailable</span><span class="p">(</span><span class="s">'Found no valid connections: </span><span class="si">%r</span><span class="s">'</span> <span class="o">%</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection_list</span><span class="p">)</span>
<span class="c"># Rotate our server list so we'll skip all our broken servers</span>
<span class="n">rotating_connections</span><span class="o">.</span><span class="n">rotate</span><span class="p">(</span><span class="o">-</span><span class="n">failed_connections</span><span class="p">)</span>
<span class="k">return</span> <span class="n">chosen_connection</span>
<span class="k">def</span> <span class="nf">send_job_request</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">current_request</span><span class="p">):</span>
<span class="sd">"""Attempt to send out a job request"""</span>
<span class="k">if</span> <span class="n">current_request</span><span class="o">.</span><span class="n">connection_attempts</span> <span class="o">>=</span> <span class="n">current_request</span><span class="o">.</span><span class="n">max_connection_attempts</span><span class="p">:</span>
<span class="k">raise</span> <span class="n">ExceededConnectionAttempts</span><span class="p">(</span><span class="s">'Exceeded </span><span class="si">%d</span><span class="s"> connection attempt(s) :: </span><span class="si">%r</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">current_request</span><span class="o">.</span><span class="n">max_connection_attempts</span><span class="p">,</span> <span class="n">current_request</span><span class="p">))</span>
<span class="n">chosen_connection</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">establish_request_connection</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span>
<span class="n">current_request</span><span class="o">.</span><span class="n">job</span><span class="o">.</span><span class="n">connection</span> <span class="o">=</span> <span class="n">chosen_connection</span>
<span class="n">current_request</span><span class="o">.</span><span class="n">connection_attempts</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">current_request</span><span class="o">.</span><span class="n">timed_out</span> <span class="o">=</span> <span class="bp">False</span>
<span class="n">current_command_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="p">[</span><span class="n">chosen_connection</span><span class="p">]</span>
<span class="n">current_command_handler</span><span class="o">.</span><span class="n">send_job_request</span><span class="p">(</span><span class="n">current_request</span><span class="p">)</span>
<span class="k">return</span> <span class="n">current_request</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>
|