-
Notifications
You must be signed in to change notification settings - Fork 10
/
trackers.py
266 lines (219 loc) · 10.9 KB
/
trackers.py
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
from .achievements import Achievement
from .backends import AchievementBackend
from .signals import goal_achieved, level_increased, highest_level_achieved
from inspect import isclass as _isclass
class AlreadyRegistered(Exception):
pass
class NotRegistered(Exception):
pass
def median(lst):
n = len(lst)
if n < 1:
return None
if n % 2 == 1:
return sorted(lst)[n // 2]
else:
return sum(sorted(lst)[n // 2-1:n // 2 + 1])/ 2.0
class AchievementTracker(object):
"""
AchievementTracker tracks achievements and current levels for ``tracked_id`` using a configured
achievement backend.
A default instance of Achievement tracker is created as a singleton when pycheivements is
imported as ``pychievements.tracker``. Most often, this is what you will want to use.
Arguments:
backend:
The backend to use for storing/retrieving achievement data. If ``None``, the default
:py:class:`AchievementBackend` will be used, which stores all data in memory.
.. note::
The backend the tracker is using can be updated at any time using the :py:func:`set_backend`
function.
"""
def __init__(self, backend=None):
self._registry = []
self._backend = AchievementBackend() if backend is None else backend
def set_backend(self, backend):
"""
Configures a new backend for storing achievement data.
"""
if not isinstance(backend, AchievementBackend):
raise ValueError('Backend must be an instance of an AchievementBackend')
self._backend = backend
def register(self, achievement_or_iterable, **options):
"""
Registers the given achievement(s) to be tracked.
"""
if _isclass(achievement_or_iterable) and issubclass(achievement_or_iterable, Achievement):
achievement_or_iterable = [achievement_or_iterable]
for achievement in achievement_or_iterable:
if not achievement.category:
raise ValueError('Achievements must specify a category, could not register '
'%s' % achievement.__name__)
if achievement in self._registry:
raise AlreadyRegistered('The achievement %s is already '
'registered' % achievement.__name__)
if achievement is not Achievement:
self._registry.append(achievement)
def unregister(self, achievement_or_iterable):
"""
Un-registers the given achievement(s).
If an achievement isn't already registered, this will raise NotRegistered.
"""
if _isclass(achievement_or_iterable) and issubclass(achievement_or_iterable, Achievement):
achievement_or_iterable = [achievement_or_iterable]
for achievement in achievement_or_iterable:
if achievement not in self._registry:
raise NotRegistered('The achievement %s is not registered' % achievement.__name__)
self._registry.remove(achievement)
def is_registered(self, achievement):
"""
Check if an achievement is registered with this `AchievementTracker`
"""
return achievement in self._registry
def achievements(self, category=None, keywords=None):
"""
Returns all registered achievements.
Arguments:
category
Filters returned achievements by category. This is a strict string match.
keywords
Filters returned achievements by keywords. Returned achievements will match all
given keywords. This will be [] if not provided.
"""
achievements = []
keywords = keywords if keywords is not None else []
for achievement in self._registry:
if category is None or achievement.category == category:
if not keywords or all([_ in achievement.keywords for _ in keywords]):
achievements.append(achievement)
return achievements
def achievement_for_id(self, tracked_id, achievement):
"""
Returns ``Achievement`` for a given ``tracked_id``. Achievement can be an ``Achievement``
class or a string of the name of an achievement class that has been registered with this
tracker.
Raises NotRegistered if the given achievement is not registered with the tracker.
If ``tracked_id`` has not been tracked yet by this tracker, it will be created.
"""
if isinstance(achievement, Achievement):
achievement = achievement.__class__.__name__
elif _isclass(achievement) and issubclass(achievement, Achievement):
achievement = achievement.__name__
a = [_ for _ in self._registry if _.__name__ == achievement]
if a:
return self._backend.achievement_for_id(tracked_id, a[0])
raise NotRegistered('The achievement %s is not registered with this tracker' % achievement)
def achievements_for_id(self, tracked_id, category=None, keywords=None):
""" Returns all of the achievements for tracked_id that match the given category and
keywords. keywords will be [] if not provided."""
keywords = keywords if keywords is not None else []
return self._backend.achievements_for_id(tracked_id, self.achievements(category, keywords))
def _check_signals(self, tracked_id, achievement, old_level, old_achieved):
cur_level = achievement.current[0]
if old_level < cur_level:
level_increased.send_robust(self, tracked_id=tracked_id, achievement=achievement)
if old_achieved != achievement.achieved:
new_goals = [_ for _ in achievement.achieved if _ not in old_achieved]
goal_achieved.send_robust(self, tracked_id=tracked_id, achievement=achievement,
goals=new_goals)
if not achievement.unachieved:
highest_level_achieved.send_robust(self, tracked_id=tracked_id,
achievement=achievement)
return new_goals
return False
def increment(self, tracked_id, achievement, amount=1, *args, **kwargs):
"""
Increments an achievement for a given ``tracked_id``. Achievement can be an ``Achievement``
class or a string of the name of an achievement class that has been registered with this
tracker.
Raises NotRegistered if the given achievement is not registered with the tracker.
If ``tracked_id`` has not been tracked yet by this tracker, it will be created before
incrementing.
Returns an list of achieved goals if a new goal was reached, or False
"""
achievement = self.achievement_for_id(tracked_id, achievement)
cur_level = achievement.current[0]
achieved = achievement.achieved[:]
achievement.increment(amount, *args, **kwargs)
self._backend.set_level_for_id(tracked_id, achievement.__class__, achievement.current[0])
return self._check_signals(tracked_id, achievement, cur_level, achieved)
def evaluate(self, tracked_id, achievement, *args, **kwargs):
"""
Evaluates an achievement for a given ``tracked_id``. Achievement can be an ``Achievement``
class or a string of the name of an achievement class that has been registered with
this tracker.
Raises NotRegistered if the given achievement is not registered with the tracker.
If ``tracked_id`` has not been tracked yet by this tracker, it will be created before
evaluating.
Returns list of achieved goals for the given achievement after evaluation
"""
achievement = self.achievement_for_id(tracked_id, achievement)
cur_level = achievement.current[0]
achieved = achievement.achieved[:]
result = achievement.evaluate(*args, **kwargs)
self._backend.set_level_for_id(tracked_id, achievement.__class__, achievement.current[0])
self._check_signals(tracked_id, achievement, cur_level, achieved)
return result
def current(self, tracked_id, achievement):
"""
Returns ``current`` for a given tracked_id. See :ref:``Achievement``
"""
achievement = self.achievement_for_id(tracked_id, achievement)
return achievement.current
def achieved(self, tracked_id, achievement):
"""
Returns ``achieved`` for a given tracked_id. See :ref:``Achievement``
"""
achievement = self.achievement_for_id(tracked_id, achievement)
return achievement.achieved
def unachieved(self, tracked_id, achievement):
"""
Returns ``unachieved`` for a given tracked_id. See :ref:``Achievement``
"""
achievement = self.achievement_for_id(tracked_id, achievement)
return achievement.unachieved
def set_level(self, tracked_id, achievement, level):
"""
Returns ``set_level`` for a given tracked_id. See :ref:``Achievement``
"""
achievement = self.achievement_for_id(tracked_id, achievement)
cur_level = achievement.current[0]
achieved = achievement.achieved[:]
achievement.set_level(level)
self._backend.set_level_for_id(tracked_id, achievement.__class__, achievement.current[0])
self._check_signals(tracked_id, achievement, cur_level, achieved)
def get_tracked_ids(self):
""" Returns all tracked ids """
return self._backend.get_tracked_ids()
def remove_id(self, tracked_id):
""" Remove all tracked information for tracked_id """
self._backend.remove_id(tracked_id)
def compare_stats(self, tracked_ids, achievement):
"""
Fetches an achievement's statistics for each ID provided, and compares them.
This will return a dictionary that looks like the following:
{
"mean": Number with the average current level. This will be rounded into a goal index.
"median": The median of all the current levels.
"max": The highest level among the IDs.
"min": The lowest level among the IDs.
}
"""
stats = {
"mean": 0,
"median": [],
"max": [],
"min": []
}
for tid in tracked_ids:
personal_achievement = self._backend.achievement_for_id(tid, achievement)
stats["mean"] += personal_achievement.current[0]
for stat in ["median", "max", "min"]:
stats[stat].append(personal_achievement.current[0])
stats["mean"] /= len(tracked_ids)
stats["median"] = median(stats["median"])
stats["max"] = max(stats["max"])
stats["min"] = min(stats["min"])
return stats
def compare_global_stats(self, achievement):
""" Shorthand for tracker.compare_stats(tracker.get_tracked_ids(), ``achievement``) """
return self.compare_stats(self.get_tracked_ids(), achievement)