<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[12808] twext/trunk/twext/enterprise/jobqueue.py</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.calendarserver.org//changeset/12808">12808</a></dd>
<dt>Author</dt> <dd>wsanchez@apple.com</dd>
<dt>Date</dt> <dd>2014-03-04 20:39:53 -0800 (Tue, 04 Mar 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add JobItem.workTypes()</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#twexttrunktwextenterprisejobqueuepy">twext/trunk/twext/enterprise/jobqueue.py</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="twexttrunktwextenterprisejobqueuepy"></a>
<div class="modfile"><h4>Modified: twext/trunk/twext/enterprise/jobqueue.py (12807 => 12808)</h4>
<pre class="diff"><span>
<span class="info">--- twext/trunk/twext/enterprise/jobqueue.py 2014-03-05 04:38:34 UTC (rev 12807)
+++ twext/trunk/twext/enterprise/jobqueue.py 2014-03-05 04:39:53 UTC (rev 12808)
</span><span class="lines">@@ -95,8 +95,9 @@
</span><span class="cx"> from twisted.python.reflect import qual
</span><span class="cx"> from twisted.python import log
</span><span class="cx">
</span><del>-from twext.enterprise.dal.syntax import SchemaSyntax, Lock, NamedValue, Select, \
- Count
</del><ins>+from twext.enterprise.dal.syntax import (
+ SchemaSyntax, Lock, NamedValue, Select, Count
+)
</ins><span class="cx">
</span><span class="cx"> from twext.enterprise.dal.model import ProcedureCall
</span><span class="cx"> from twext.enterprise.dal.record import Record, fromTable, NoSuchRecord
</span><span class="lines">@@ -117,7 +118,7 @@
</span><span class="cx"> (in the worst case) pass from worker->controller->controller->worker.
</span><span class="cx"> """
</span><span class="cx">
</span><del>- def performJob(jobID): #@NoSelf
</del><ins>+ def performJob(jobID): # @NoSelf
</ins><span class="cx"> """
</span><span class="cx"> @param jobID: The primary key identifier of the given job.
</span><span class="cx"> @type jobID: L{int}
</span><span class="lines">@@ -269,22 +270,25 @@
</span><span class="cx">
</span><span class="cx"> class JobItem(Record, fromTable(JobInfoSchema.JOB)):
</span><span class="cx"> """
</span><del>- An item in the job table. This is typically not directly used by code creating
- work items, but rather is used for internal book keeping of jobs associated with
- work items.
</del><ins>+ An item in the job table. This is typically not directly used by code
+ creating work items, but rather is used for internal book keeping of jobs
+ associated with work items.
</ins><span class="cx"> """
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><span class="cx"> def getWorkForJob(self):
</span><span class="cx"> workItemClass = WorkItem.forTableName(self.workType)
</span><del>- workItems = yield workItemClass.loadForJob(self.transaction, self.jobID)
</del><ins>+ workItems = yield workItemClass.loadForJob(
+ self.transaction, self.jobID
+ )
</ins><span class="cx"> returnValue(workItems[0] if len(workItems) == 1 else None)
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> @inlineCallbacks
</span><span class="cx"> def run(self):
</span><span class="cx"> """
</span><del>- Run this job item by finding the appropriate work item class and running that.
</del><ins>+ Run this job item by finding the appropriate work item class and
+ running that.
</ins><span class="cx"> """
</span><span class="cx"> workItem = yield self.getWorkForJob()
</span><span class="cx"> if workItem is not None:
</span><span class="lines">@@ -309,6 +313,15 @@
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> @classmethod
</span><ins>+ def workTypes(cls):
+ """
+ @return: All of the work item types.
+ @rtype: iterable of L{WorkItem} subclasses
+ """
+ return WorkItem.__subclasses__()
+
+
+ @classmethod
</ins><span class="cx"> @inlineCallbacks
</span><span class="cx"> def histogram(cls, txn):
</span><span class="cx"> """
</span><span class="lines">@@ -323,24 +336,25 @@
</span><span class="cx"> results = dict(rows)
</span><span class="cx">
</span><span class="cx"> # Add in empty data for other work
</span><del>- allwork = WorkItem.__subclasses__()
- for workitem in allwork:
- if workitem.table.model.name not in results:
- results[workitem.table.model.name] = 0
</del><ins>+ for workType in cls.workTypes():
+ results.setdefault(workType.table.model.name, 0)
+
</ins><span class="cx"> returnValue(results)
</span><span class="cx">
</span><span class="cx">
</span><span class="cx"> @classmethod
</span><span class="cx"> def numberOfWorkTypes(cls):
</span><del>- return len(WorkItem.__subclasses__())
</del><ins>+ return len(cls.workTypes())
</ins><span class="cx">
</span><span class="cx">
</span><ins>+
</ins><span class="cx"> # Priority for work - used to order work items in the job queue
</span><span class="cx"> WORK_PRIORITY_LOW = 1
</span><span class="cx"> WORK_PRIORITY_MEDIUM = 2
</span><span class="cx"> WORK_PRIORITY_HIGH = 3
</span><span class="cx">
</span><span class="cx">
</span><ins>+
</ins><span class="cx"> class WorkItem(Record):
</span><span class="cx"> """
</span><span class="cx"> A L{WorkItem} is an item of work which may be stored in a database, then
</span><span class="lines">@@ -441,8 +455,8 @@
</span><span class="cx"> @inlineCallbacks
</span><span class="cx"> def makeJob(cls, transaction, **kwargs):
</span><span class="cx"> """
</span><del>- A new work item needs to be created. First we create a Job record, then we create
- the actual work item related to the job.
</del><ins>+ A new work item needs to be created. First we create a Job record, then
+ we create the actual work item related to the job.
</ins><span class="cx">
</span><span class="cx"> @param transaction: the transaction to use
</span><span class="cx"> @type transaction: L{IAsyncTransaction}
</span><span class="lines">@@ -451,6 +465,7 @@
</span><span class="cx"> jobargs = {
</span><span class="cx"> "workType": cls.table.model.name
</span><span class="cx"> }
</span><ins>+
</ins><span class="cx"> def _transferArg(name):
</span><span class="cx"> if name in kwargs:
</span><span class="cx"> jobargs[name] = kwargs[name]
</span><span class="lines">@@ -978,7 +993,9 @@
</span><span class="cx"> Create a L{ConnectionFromController} connected to the
</span><span class="cx"> transactionFactory and store.
</span><span class="cx"> """
</span><del>- return ConnectionFromController(self.transactionFactory, self.whenConnected)
</del><ins>+ return ConnectionFromController(
+ self.transactionFactory, self.whenConnected
+ )
</ins><span class="cx">
</span><span class="cx">
</span><span class="cx">
</span><span class="lines">@@ -1066,7 +1083,14 @@
</span><span class="cx"> self._whenExecuted.errback(why)
</span><span class="cx">
</span><span class="cx"> reactor = self._chooser.reactor
</span><del>- when = max(0, astimestamp(created.job.notBefore) - reactor.seconds()) if created.job.notBefore is not None else 0
</del><ins>+
+ if created.job.notBefore is not None:
+ when = max(
+ 0,
+ astimestamp(created.job.notBefore) - reactor.seconds()
+ )
+ else:
+ when = 0
</ins><span class="cx"> # TODO: Track the returned DelayedCall so it can be stopped
</span><span class="cx"> # when the service stops.
</span><span class="cx"> self._chooser.reactor.callLater(when, maybeLater)
</span><span class="lines">@@ -1351,8 +1375,8 @@
</span><span class="cx"> (self.thisProcess.hostname, self.thisProcess.port)
</span><span class="cx"> )
</span><span class="cx">
</span><del>- # TODO: here is where we should iterate over the unlocked items that
- # are due, ordered by priority, notBefore etc
</del><ins>+ # TODO: here is where we should iterate over the unlocked items
+ # that are due, ordered by priority, notBefore etc
</ins><span class="cx"> tooLate = datetime.utcfromtimestamp(
</span><span class="cx"> self.reactor.seconds() - self.queueProcessTimeout
</span><span class="cx"> )
</span></span></pre>
</div>
</div>
</body>
</html>