b8202e40de
* Vertical marks blocks completed when viewed. * Functionality is hidden behind a waffle switch * Submissions from front-end are limited to known-incomplete blocks * Upgrades xblock to version 1.1.1 * Related future requirements listed in TODO tagged with EDUCATOR-1778 and relevant opencraft OC-* ticket IDs. OC-3088
62 lines
1.9 KiB
Python
62 lines
1.9 KiB
Python
"""
|
|
Runtime service for communicating completion information to the xblock system.
|
|
"""
|
|
|
|
from .models import BlockCompletion
|
|
from . import waffle
|
|
|
|
|
|
class CompletionService(object):
|
|
"""
|
|
Service for handling completions for a user within a course.
|
|
|
|
Exposes
|
|
|
|
* self.completion_tracking_enabled() -> bool
|
|
* self.get_completions(candidates)
|
|
|
|
Constructor takes a user object and course_key as arguments.
|
|
"""
|
|
def __init__(self, user, course_key):
|
|
self._user = user
|
|
self._course_key = course_key
|
|
|
|
def completion_tracking_enabled(self):
|
|
"""
|
|
Exposes ENABLE_COMPLETION_TRACKING waffle switch to XModule runtime
|
|
|
|
Return value:
|
|
|
|
bool -> True if completion tracking is enabled.
|
|
"""
|
|
return waffle.waffle().is_enabled(waffle.ENABLE_COMPLETION_TRACKING)
|
|
|
|
def get_completions(self, candidates):
|
|
"""
|
|
Given an iterable collection of block_keys in the course, returns a
|
|
mapping of the block_keys to the present completion values of their
|
|
associated blocks.
|
|
|
|
If a completion is not found for a given block in the current course,
|
|
0.0 is returned. The service does not attempt to verify that the block
|
|
exists within the course.
|
|
|
|
Parameters:
|
|
|
|
candidates: collection of BlockKeys within the current course.
|
|
|
|
Return value:
|
|
|
|
dict[BlockKey] -> float: Mapping blocks to their completion value.
|
|
"""
|
|
completion_queryset = BlockCompletion.objects.filter(
|
|
user=self._user,
|
|
course_key=self._course_key,
|
|
block_key__in=candidates,
|
|
)
|
|
completions = {block.block_key: block.completion for block in completion_queryset}
|
|
for candidate in candidates:
|
|
if candidate not in completions:
|
|
completions[candidate] = 0.0
|
|
return completions
|