iro/controller/task.py
author Sandro Knauß <knauss@netzguerilla.net>
Thu, 29 Mar 2012 18:31:53 +0200
branchdevel
changeset 264 584b9c97ecfd
parent 243 b348d8f15b0a
child 294 0e75bd39767d
permissions -rw-r--r--
iro.controller: adding docstrings
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     1
from functools import partial
143
0b265608b6ce using inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 142
diff changeset
     2
243
b348d8f15b0a tests for OfferChaning added
Sandro Knauß <knauss@netzguerilla.net>
parents: 238
diff changeset
     3
from twisted.python import log
234
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
     4
from twisted.internet.defer import inlineCallbacks, returnValue, maybeDeferred, Deferred
141
90c95fdd1e33 first defer test in job management
Sandro Knauß <knauss@netzguerilla.net>
parents: 140
diff changeset
     5
162
497d6b9b6914 make difference between NoRoute and NoRouteForTask
Sandro Knauß <knauss@netzguerilla.net>
parents: 161
diff changeset
     6
from ..error import NoRouteForTask, RejectRecipient
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
     7
142
7d0c1fa97123 task._run umbau zu inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 141
diff changeset
     8
from ..model.offer import offers
140
75d0eaaa871d start fixing job mangement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
     9
from ..model.job import exJobs
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    10
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    11
from .pool  import taskPool
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    12
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    13
class Task:
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    14
    '''A Task is one message to one recipient and is a part of one :class:`iro.model.job.ExJob`.
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    15
    '''
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    16
    def __init__(self, recipient, job):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    17
        """
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    18
        :param recipient: a recipient
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    19
        :param `iro.model.job.ExJob` job: connected job
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    20
        """
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    21
        self.recipient = recipient
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    22
        self.job = job
217
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    23
        self.status = None
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    24
        self.error = False
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    25
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    26
    def setStatus(self,status):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    27
        """callback, to set status of task"""
217
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    28
        self.status = status
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    29
        return status
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    30
234
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    31
    def setError(self, error):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    32
        """errback to set error of task"""
217
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    33
        self.status = error
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    34
        self.error = True
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    35
        return error
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    36
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    37
    def start(self):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    38
        """Starting to send message to recipient.
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    39
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    40
        :return: a defer, that is fired, when message is sended successfully over any offer.
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    41
        """
234
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    42
        self.d = Deferred()
217
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    43
        self.d.addCallback(self.setStatus)
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    44
        self.d.addCallback(partial(self.job.setStatus,self))
217
d755b2e0cc0b task now saves own status
Sandro Knauß <knauss@netzguerilla.net>
parents: 162
diff changeset
    45
        self.d.addErrback(self.setError)
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    46
        self.d.addErrback(partial(self.job.setError,self))
234
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    47
        taskPool.run(self._run)
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    48
        return self.d
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    49
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    50
    def _run(self):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    51
        """sends the message to recipient, tries all possible offers."""
238
c36b117f7400 using iter function instead of generator
Sandro Knauß <knauss@netzguerilla.net>
parents: 234
diff changeset
    52
        os= iter(self.job.offers)
234
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    53
        def n():
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    54
            try:
234
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    55
                offer = os.next()
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    56
                d = maybeDeferred(offers[offer],self.recipient,self.job.message)
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    57
                d.addCallback(self.d.callback)
243
b348d8f15b0a tests for OfferChaning added
Sandro Knauß <knauss@netzguerilla.net>
parents: 238
diff changeset
    58
                d.addErrback(addErr,offer)
234
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    59
                d.addErrback(self.d.errback)
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    60
                return d
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    61
            except StopIteration:
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    62
                self.d.errback(NoRouteForTask())
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    63
243
b348d8f15b0a tests for OfferChaning added
Sandro Knauß <knauss@netzguerilla.net>
parents: 238
diff changeset
    64
        def addErr(failure, offer):
b348d8f15b0a tests for OfferChaning added
Sandro Knauß <knauss@netzguerilla.net>
parents: 238
diff changeset
    65
            if not isinstance(failure.value, RejectRecipient):  
b348d8f15b0a tests for OfferChaning added
Sandro Knauß <knauss@netzguerilla.net>
parents: 238
diff changeset
    66
                log.err(_why="Job(%s): Send to '%s' failed via '%s'"%(self.job.dbjob, self.recipient, offer),_stuff=failure)
b348d8f15b0a tests for OfferChaning added
Sandro Knauß <knauss@netzguerilla.net>
parents: 238
diff changeset
    67
            n()
234
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    68
        
08fcc2b6df99 refactoring task._run
Sandro Knauß <knauss@netzguerilla.net>
parents: 217
diff changeset
    69
        n()
135
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    70
f8640c663e3e model.job created
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff changeset
    71
143
0b265608b6ce using inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 142
diff changeset
    72
@inlineCallbacks
140
75d0eaaa871d start fixing job mangement
Sandro Knauß <knauss@netzguerilla.net>
parents: 135
diff changeset
    73
def createJob(user,recipients, msg, offers, info=None):
264
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    74
    """Creates a :class:`iro.model.job.ExJob` and start for all recipients one task.
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    75
    
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    76
    :param `iro.model.schema.User` user: the sender 
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    77
    :param `iro.model.message.Message` msg: the message
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    78
    :param list offers: a list of possible offer and provider names, to try to send the message over. The first entry will be tried first.
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    79
    :param string info: a bill group name
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    80
    :return: the new :class:`iro.model.job.ExJob` object.
584b9c97ecfd iro.controller: adding docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents: 243
diff changeset
    81
    """
143
0b265608b6ce using inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 142
diff changeset
    82
    job = yield exJobs.create(user, recipients, msg, offers, info)
0b265608b6ce using inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 142
diff changeset
    83
    for r in recipients:
0b265608b6ce using inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 142
diff changeset
    84
        task = Task(r,job)
0b265608b6ce using inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 142
diff changeset
    85
        job.addTask(task)
0b265608b6ce using inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 142
diff changeset
    86
        task.start()
0b265608b6ce using inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents: 142
diff changeset
    87
    returnValue(job)