| author | Sandro Knauß <knauss@netzguerilla.net> |
| Thu, 29 Mar 2012 13:46:37 +0200 | |
| branch | devel |
| changeset 257 | 31114e40178d |
| parent 161 | 072ee139eb67 |
| child 294 | 0e75bd39767d |
| permissions | -rw-r--r-- |
|
142
7d0c1fa97123
task._run umbau zu inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
1 |
class Offer(): |
|
257
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
2 |
"""One Offer for sending. |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
3 |
This class is used to send a message via a provider. |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
4 |
""" |
|
157
0192f9107870
model.offer.loadOffers implemented
Sandro Knauß <knauss@netzguerilla.net>
parents:
156
diff
changeset
|
5 |
def __init__(self, name, provider, route, typ): |
|
257
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
6 |
""" Constructor for Offer class. |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
7 |
|
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
8 |
:param string name: name is the name in database for the offer |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
9 |
:param `iro.offer.provider.Provider` provider: A valid provider object. |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
10 |
:param sting route: used to the the right send function via :meth:`iro.offer.provider.Provider.getSendFunc`. |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
11 |
:param sting typ: used to the the right send function via :meth:`iro.offer.provider.Provider.getSendFunc`. |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
12 |
|
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
13 |
|
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
14 |
.. automethod:: __call__ |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
15 |
.. automethod:: __eq__ |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
16 |
.. automethod:: __neq__ |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
17 |
.. automethod:: __repr__ |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
18 |
""" |
|
142
7d0c1fa97123
task._run umbau zu inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
19 |
self.name = name |
|
157
0192f9107870
model.offer.loadOffers implemented
Sandro Knauß <knauss@netzguerilla.net>
parents:
156
diff
changeset
|
20 |
self.route = route |
|
0192f9107870
model.offer.loadOffers implemented
Sandro Knauß <knauss@netzguerilla.net>
parents:
156
diff
changeset
|
21 |
self.provider = provider |
|
159
fbd7364b252d
implementing Provider.loadConig started
Sandro Knauß <knauss@netzguerilla.net>
parents:
157
diff
changeset
|
22 |
self.typ = typ |
|
161
072ee139eb67
sending part now in provoder class
Sandro Knauß <knauss@netzguerilla.net>
parents:
160
diff
changeset
|
23 |
self.sendfunc = provider.getSendFunc(typ, route) |
|
142
7d0c1fa97123
task._run umbau zu inlineCallbacks
Sandro Knauß <knauss@netzguerilla.net>
parents:
diff
changeset
|
24 |
|
|
161
072ee139eb67
sending part now in provoder class
Sandro Knauß <knauss@netzguerilla.net>
parents:
160
diff
changeset
|
25 |
def __call__(self, recipient, message): |
|
257
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
26 |
"""send a message to a recipient. This method uses :meth:`iro.offer.provider.Provider.send` |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
27 |
|
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
28 |
:param recipient: one recipient |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
29 |
:param `iro.model.message.Message` message: message to send |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
30 |
""" |
|
161
072ee139eb67
sending part now in provoder class
Sandro Knauß <knauss@netzguerilla.net>
parents:
160
diff
changeset
|
31 |
return self.sendfunc(recipient, message) |
|
160
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
32 |
|
|
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
33 |
def __eq__(self,o): |
|
257
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
34 |
"""return ``True``, if o is equal.""" |
|
160
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
35 |
return (self.name == o.name) and (self.route == o.route) and (self.provider == o.provider) and (self.typ == o.typ) |
|
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
36 |
|
|
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
37 |
def __neq__(self,o): |
|
257
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
38 |
"""return ``True``, if ``o`` is not equal (see :meth:`__eq__`).""" |
|
160
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
39 |
return not self.__eq__(o) |
|
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
40 |
|
|
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
41 |
def __repr__(self): |
|
257
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
42 |
"""string representation of this class for debugging purpose. |
|
160
f4e4f4ba25fb
passing all tests: offer now has a __eq__ function
Sandro Knauß <knauss@netzguerilla.net>
parents:
159
diff
changeset
|
43 |
|
|
257
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
44 |
:return: ``<Offer(name, provider, route, typ)>`` """ |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
45 |
return "<Offer(%s, %s, %s, %s)>"%(self.name,self.provider,self.route,self.typ) |
|
31114e40178d
iro.offer: adds docstrings
Sandro Knauß <knauss@netzguerilla.net>
parents:
161
diff
changeset
|
46 |