Files
edx-platform/lms/djangoapps/courseware/services.py
Kyle McCormick 151bd13666 Use full names for common.djangoapps imports; warn when using old style (#25477)
* Generate common/djangoapps import shims for LMS
* Generate common/djangoapps import shims for Studio
* Stop appending project root to sys.path
* Stop appending common/djangoapps to sys.path
* Import from common.djangoapps.course_action_state instead of course_action_state
* Import from common.djangoapps.course_modes instead of course_modes
* Import from common.djangoapps.database_fixups instead of database_fixups
* Import from common.djangoapps.edxmako instead of edxmako
* Import from common.djangoapps.entitlements instead of entitlements
* Import from common.djangoapps.pipline_mako instead of pipeline_mako
* Import from common.djangoapps.static_replace instead of static_replace
* Import from common.djangoapps.student instead of student
* Import from common.djangoapps.terrain instead of terrain
* Import from common.djangoapps.third_party_auth instead of third_party_auth
* Import from common.djangoapps.track instead of track
* Import from common.djangoapps.util instead of util
* Import from common.djangoapps.xblock_django instead of xblock_django
* Add empty common/djangoapps/__init__.py to fix pytest collection
* Fix pylint formatting violations
* Exclude import_shims/ directory tree from linting
2020-11-10 07:02:01 -05:00

42 lines
1.2 KiB
Python

"""
Courseware services.
"""
import json
from django.contrib.auth.models import User
from lms.djangoapps.courseware.models import StudentModule
from common.djangoapps.student.models import get_user_by_username_or_email
class UserStateService(object):
"""
User state service to make state accessible in runtime.
"""
def get_state_as_dict(self, username_or_email, block_id):
"""
Return dict containing user state for a given set of parameters.
Arguments:
username_or_email: username or email of the user for whom the data is being retrieved
block_id: string/object representation of the block whose user state is required
Returns:
Returns a dict containing user state, if present, else empty.
"""
try:
user = get_user_by_username_or_email(username_or_email=username_or_email)
except User.DoesNotExist:
return {}
try:
student_module = StudentModule.objects.get(
student=user,
module_state_key=block_id
)
return json.loads(student_module.state)
except StudentModule.DoesNotExist:
return {}