From 2a1d1debad78006899934f48d60a24ad656a8b9c Mon Sep 17 00:00:00 2001 From: Bryann Valderrama Date: Fri, 18 Jul 2025 10:53:51 -0500 Subject: [PATCH] chore: add missing inline code annotations in filters (#36474) --- lms/djangoapps/learner_home/serializers.py | 8 ++++++-- openedx/core/djangoapps/user_authn/views/login.py | 2 ++ openedx/core/djangoapps/user_authn/views/register.py | 2 ++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/lms/djangoapps/learner_home/serializers.py b/lms/djangoapps/learner_home/serializers.py index 6235c20de8..f7eed25d22 100644 --- a/lms/djangoapps/learner_home/serializers.py +++ b/lms/djangoapps/learner_home/serializers.py @@ -147,7 +147,9 @@ class CourseRunSerializer(serializers.Serializer): def to_representation(self, instance): """Serialize the courserun instance to be able to update the values before the API finishes rendering.""" serialized_courserun = super().to_representation(instance) - serialized_courserun = CourseRunAPIRenderStarted().run_filter( + # .. filter_implemented_name: CourseRunAPIRenderStarted + # .. filter_type: org.openedx.learning.home.courserun.api.rendered.started.v1 + serialized_courserun = CourseRunAPIRenderStarted.run_filter( serialized_courserun=serialized_courserun, ) return serialized_courserun @@ -264,7 +266,9 @@ class EnrollmentSerializer(serializers.Serializer): def to_representation(self, instance): """Serialize the enrollment instance to be able to update the values before the API finishes rendering.""" serialized_enrollment = super().to_representation(instance) - course_key, serialized_enrollment = CourseEnrollmentAPIRenderStarted().run_filter( + # .. filter_implemented_name: CourseEnrollmentAPIRenderStarted + # .. filter_type: org.openedx.learning.home.enrollment.api.rendered.v1 + course_key, serialized_enrollment = CourseEnrollmentAPIRenderStarted.run_filter( course_key=instance.course_id, serialized_enrollment=serialized_enrollment, ) diff --git a/openedx/core/djangoapps/user_authn/views/login.py b/openedx/core/djangoapps/user_authn/views/login.py index 4a7d88f830..0dd9a4819d 100644 --- a/openedx/core/djangoapps/user_authn/views/login.py +++ b/openedx/core/djangoapps/user_authn/views/login.py @@ -595,6 +595,8 @@ def login_user(request, api_version="v1"): # pylint: disable=too-many-statement possibly_authenticated_user = user try: + # .. filter_implemented_name: StudentLoginRequested + # .. filter_type: org.openedx.learning.student.login.requested.v1 possibly_authenticated_user = StudentLoginRequested.run_filter(user=possibly_authenticated_user) except StudentLoginRequested.PreventLogin as exc: raise AuthFailedError( diff --git a/openedx/core/djangoapps/user_authn/views/register.py b/openedx/core/djangoapps/user_authn/views/register.py index 1529cc12f7..e959420577 100644 --- a/openedx/core/djangoapps/user_authn/views/register.py +++ b/openedx/core/djangoapps/user_authn/views/register.py @@ -593,6 +593,8 @@ class RegistrationView(APIView): data['username'] = get_auto_generated_username(data) try: + # .. filter_implemented_name: StudentRegistrationRequested + # .. filter_type: org.openedx.learning.student.registration.requested.v1 data = StudentRegistrationRequested.run_filter(form_data=data) except StudentRegistrationRequested.PreventRegistration as exc: errors = {