compat.py

"""
Compatibility layer for testing without Open edX.
"""

import logging
from datetime import datetime

from django.contrib.auth.models import AbstractBaseUser
from opaque_keys.edx.keys import CourseKey

log = logging.getLogger(__name__)


def get_user_course_grade(user: AbstractBaseUser, course_key: CourseKey):
    """
    Retrieve the CourseGrade object for a user in a specific course.
    """
    # pylint: disable=import-outside-toplevel, import-error
    from lms.djangoapps.grades.course_grade_factory import CourseGradeFactory

    course_grade = CourseGradeFactory().read(user, course_key=course_key)
    return course_grade


def get_catalog_api_client(user: AbstractBaseUser):
    """
    Retrieve the api client for user.
    """
    # pylint: disable=import-outside-toplevel, import-error
    from openedx.core.djangoapps.catalog.utils import (
        get_catalog_api_client as api_client,
    )

    return api_client(user)


def get_course_keys_with_outlines() -> list[CourseKey]:
    """
    Retrieve course keys.
    """
    # pylint: disable=import-outside-toplevel, import-error
    from openedx.core.djangoapps.content.learning_sequences.api import (
        get_course_keys_with_outlines as course_keys_with_outlines,
    )

    return course_keys_with_outlines()


def get_course_dates(course_key: CourseKey) -> tuple[datetime | None, datetime | None]:
    """Retrieve course start and end dates."""
    # pylint: disable=import-outside-toplevel, import-error
    from openedx.core.djangoapps.content.course_overviews.models import CourseOverview

    try:
        overview = CourseOverview.objects.get(id=course_key)
        return overview.start, overview.end
    except CourseOverview.DoesNotExist:
        return None, None


def enroll_user_in_course(user: AbstractBaseUser, course_key: CourseKey) -> bool:
    """Enroll a user in a course."""
    # pylint: disable=import-outside-toplevel, import-error
    from common.djangoapps.student.api import CourseEnrollment
    from common.djangoapps.student.models.course_enrollment import (
        CourseEnrollmentException,
    )

    try:
        CourseEnrollment.enroll(user, course_key)
        return True
    except CourseEnrollmentException as exc:
        log.exception("Failed to enroll user %s in course %s: %s", user, course_key, exc)
        return False