]> git.madduck.net Git - etc/taskwarrior.git/blob - tasklib/lazy.py

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

c3feed574a81eed69f05c5e34733cb1450173602
[etc/taskwarrior.git] / tasklib / lazy.py
1 """
2 Provides lazy implementations for Task and TaskQuerySet.
3 """
4
5
6 class LazyUUIDTask(object):
7     """
8     A lazy wrapper around Task object, referenced by UUID.
9
10     - Supports comparison with LazyUUIDTask or Task objects (equality by UUIDs)
11     - If any attribute other than 'uuid' requested, a lookup in the
12       backend will be performed and this object will be replaced by a proper
13       Task object.
14     """
15
16     def __init__(self, tw, uuid):
17         self._tw = tw
18         self._uuid = uuid
19
20     def __getitem__(self, key):
21         # LazyUUIDTask does not provide anything else other than 'uuid'
22         if key is 'uuid':
23             return self._uuid
24         else:
25             self.replace()
26             return self[key]
27
28     def __getattr__(self, name):
29         # Getattr is called only if the attribute could not be found using
30         # normal means
31         self.replace()
32         return getattr(self, name)
33
34     def __eq__(self, other):
35         if other['uuid']:
36             # For saved Tasks, just define equality by equality of uuids
37             return self['uuid'] == other['uuid']
38
39     def __hash__(self):
40         return self['uuid'].__hash__()
41
42     def __repr__(self):
43         return "LazyUUIDTask: {0}".format(self._uuid)
44
45     @property
46     def saved(self):
47         """
48         Implementation of the 'saved' property. Always returns True.
49         """
50         return True
51
52     def replace(self):
53         """
54         Performs conversion to the regular Task object, referenced by the
55         stored UUID.
56         """
57
58         replacement = self._tw.tasks.get(uuid=self._uuid)
59         self.__class__ = replacement.__class__
60         self.__dict__ = replacement.__dict__
61
62
63 class LazyUUIDTaskSet(object):
64     """
65     A lazy wrapper around TaskQuerySet object, for tasks referenced by UUID.
66
67     - Supports 'in' operator with LazyUUIDTask or Task objects
68     - If iteration over the objects in the LazyUUIDTaskSet is requested, the
69       LazyUUIDTaskSet will be converted to QuerySet and evaluated
70     """
71
72     def __init__(self, tw, uuids):
73         self._tw = tw
74         self._uuids = set(uuids)
75
76     def __getattr__(self, name):
77         # Getattr is called only if the attribute could not be found using
78         # normal means
79
80         if name.startswith('__'):
81             # If some internal method was being search, do not convert
82             # to TaskQuerySet just because of that
83             raise AttributeError
84         else:
85             self.replace()
86             return getattr(self, name)
87
88     def __repr__(self):
89         return "LazyUUIDTaskSet([{0}])".format(', '.join(self._uuids))
90
91     def __eq__(self, other):
92         return set(t['uuid'] for t in other) == self._uuids
93
94     def __ne__(self, other):
95         return not (self == other)
96
97     def __contains__(self, task):
98         return task['uuid'] in self._uuids
99
100     def __len__(self):
101         return len(self._uuids)
102
103     def __iter__(self):
104         for uuid in self._uuids:
105             yield LazyUUIDTask(self._tw, uuid)
106
107     def __sub__(self, other):
108         return self.difference(other)
109
110     def __isub__(self, other):
111         return self.difference_update(other)
112
113     def __or__(self, other):
114         return self.union(other)
115
116     def __ior__(self, other):
117         return self.update(other)
118
119     def __xor__(self, other):
120         return self.symmetric_difference(other)
121
122     def __ixor__(self, other):
123         return self.symmetric_difference_update(other)
124
125     def __le__(self, other):
126         return self.issubset(other)
127
128     def __ge__(self, other):
129         return self.issuperset(other)
130
131     def issubset(self, other):
132         return all([task in other for task in self])
133
134     def issuperset(self, other):
135         return all([task in self for task in other])
136
137     def union(self, other):
138         return LazyUUIDTaskSet(self._tw,
139             self._uuids | set(t['uuid'] for t in other))
140
141     def intersection(self, other):
142         return LazyUUIDTaskSet(self._tw,
143             self._uuids & set(t['uuid'] for t in other))
144
145     def difference(self, other):
146         return LazyUUIDTaskSet(self._tw,
147             self._uuids - set(t['uuid'] for t in other))
148
149     def symmetric_difference(self, other):
150         return LazyUUIDTaskSet(self._tw,
151             self._uuids ^ set(t['uuid'] for t in other))
152
153     def update(self, other):
154         self._uuids |= set(t['uuid'] for t in other)
155         return self
156
157     def intersection_update(self, other):
158         self._uuids &= set(t['uuid'] for t in other)
159         return self
160
161     def difference_update(self, other):
162         self._uuids -= set(t['uuid'] for t in other)
163         return self
164
165     def symmetric_difference_update(self, other):
166         self._uuids ^= set(t['uuid'] for t in other)
167         return self
168
169     def add(self, task):
170         self._uuids.add(task['uuid'])
171
172     def remove(self, task):
173         self._uuids.remove(task['uuid'])
174
175     def pop(self):
176         return self._uuids.pop()
177
178     def clear(self):
179         self._uuids.clear()
180
181     def replace(self):
182         """
183         Performs conversion to the regular TaskQuerySet object, referenced by
184         the stored UUIDs.
185         """
186
187         replacement = self._tw.tasks.filter(' '.join(self._uuids))
188         self.__class__ = replacement.__class__
189         self.__dict__ = replacement.__dict__