Skip to content

Commit

Permalink
feat: add typing to the ensure cea utility method
Browse files Browse the repository at this point in the history
  • Loading branch information
tecoholic committed Aug 3, 2023
1 parent b20bf0e commit b6b2f25
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions enterprise/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@
from django.utils.translation import gettext as _
from django.utils.translation import ngettext

from enterprise.api_client.lms import EnrollmentApiClient
from enterprise.constants import (
ALLOWED_TAGS,
BEST_MODE_ORDER,
Expand Down Expand Up @@ -2327,14 +2328,14 @@ def get_default_invite_key_expiration_date():
return localized_utcnow() + datetime.timedelta(days=365)


def ensure_course_enrollment_is_allowed(course_id, email, enrollment_api_client):
def ensure_course_enrollment_is_allowed(course_id: str, email: str, enrollment_api_client: EnrollmentApiClient):
"""
Create a CourseEnrollmentAllowed object for invitation-only courses.
Arguments:
course_id (str): ID of the course to allow enrollment
email (str): email of the user whose enrollment should be allowed
enrollment_api_client (:class:`enterprise.api_client.lms.EnrollmentApiClient`): Enrollment API Client
course_id: ID of the course to allow enrollment
email: email of the user whose enrollment should be allowed
enrollment_api_client: Enrollment API Client
"""
if not CourseEnrollmentAllowed:
raise NotConnectedToOpenEdX()
Expand Down

0 comments on commit b6b2f25

Please sign in to comment.