refactor: [ACI-972] change course status to is_passing & add docs (#14)

* chore: Updating Python Requirements (openedx#343) * chore: Updating Python Requirements (openedx#344) * refactor: [ACI-972] change course status to is_passing & add docs * chore: [ACI-972] requirements update * fix: remove local development index from requirements --------- Co-authored-by: edX requirements bot <[email protected]> Co-authored-by: Andrii <[email protected]> Co-authored-by: wowkalucky <[email protected]>
raccoongang · May 7, 2024 · dce6069 · dce6069
1 parent 619289a
commit dce6069
Show file tree

Hide file tree

Showing 11 changed files with 49 additions and 43 deletions.
diff --git a/.../avro/tests/schemas/org+openedx+learning+ccx+course+passing+status+updated+v1_schema.avsc b/.../avro/tests/schemas/org+openedx+learning+ccx+course+passing+status+updated+v1_schema.avsc
@@ -10,8 +10,8 @@
         "type": "record",
         "fields": [
           {
-            "name": "status",
-            "type": "string"
+            "name": "is_passing",
+            "type": "boolean"
           },
           {
             "name": "user",

diff --git a/..._bus/avro/tests/schemas/org+openedx+learning+course+passing+status+updated+v1_schema.avsc b/..._bus/avro/tests/schemas/org+openedx+learning+course+passing+status+updated+v1_schema.avsc
@@ -10,8 +10,8 @@
         "type": "record",
         "fields": [
           {
-            "name": "status",
-            "type": "string"
+            "name": "is_passing",
+            "type": "boolean"
           },
           {
             "name": "course",

diff --git a/openedx_events/event_bus/avro/tests/test_custom_serializers.py b/openedx_events/event_bus/avro/tests/test_custom_serializers.py
@@ -8,13 +8,23 @@
 
 
 class TestCCXLocatorSerailizer(TestCase):
+    """Test case for CCXLocator serializer."""
+
     def test_serialize(self):
+        """
+        Test case for serializing CCXLocator object.
+        """
+
         obj1 = CCXLocator(org="edx", course="DemoX", run="Demo_course", ccx="1")
         expected1 = "ccx-v1:edx+DemoX+Demo_course+ccx@1"
         result1 = CcxCourseLocatorAvroSerializer.serialize(obj1)
         self.assertEqual(result1, expected1)
 
     def test_deseialize(self):
+        """
+        Test case for deserializing CCXLocator object.
+        """
+
         data1 = "ccx-v1:edx+DemoX+Demo_course+ccx@1"
         expected1 = CCXLocator(org="edx", course="DemoX", run="Demo_course", ccx="1")
         result1 = CcxCourseLocatorAvroSerializer.deserialize(data1)

diff --git a/openedx_events/learning/data.py b/openedx_events/learning/data.py
@@ -528,14 +528,13 @@ class CoursePassingStatusData:
     Represents the event data when a user's grade is updated, indicates if current grade is enough for course passing.
 
     Attributes:
-        status (str): A string containing information about user's current course grade value
-        in comparison to the grading policy threshold.
+        is_passing (bool): Indicates whether the user's grade is enough to pass the course.
         user (UserData): An instance of UserData containing information about the user whose grade was updated.
         course (CourseData): An instance of CourseData containing details about the course
         in which the grade was updated.
     """
 
-    status = attr.ib(type=str)
+    is_passing = attr.ib(type=bool)
     course = attr.ib(type=CourseData)
     user = attr.ib(type=UserData)
 

diff --git a/requirements/base.txt b/requirements/base.txt
@@ -31,7 +31,7 @@ dnspython==2.6.1
     # via pymongo
 edx-ccx-keys==1.3.0
     # via -r requirements/base.in
-edx-django-utils==5.12.0
+edx-django-utils==5.13.0
     # via -r requirements/base.in
 edx-opaque-keys[django]==2.9.0
     # via

diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -12,7 +12,7 @@ colorama==0.4.6
     # via tox
 distlib==0.3.8
     # via virtualenv
-filelock==3.13.4
+filelock==3.14.0
     # via
     #   tox
     #   virtualenv
@@ -32,7 +32,7 @@ tomli==2.0.1
     # via
     #   pyproject-api
     #   tox
-tox==4.14.2
+tox==4.15.0
     # via -r requirements/ci.in
-virtualenv==20.26.0
+virtualenv==20.26.1
     # via tox
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -71,7 +71,7 @@ colorama==0.4.6
     # via
     #   -r requirements/ci.txt
     #   tox
-coverage[toml]==7.5.0
+coverage[toml]==7.5.1
     # via
     #   -r requirements/quality.txt
     #   pytest-cov
@@ -112,7 +112,7 @@ docutils==0.20.1
     #   readme-renderer
 edx-ccx-keys==1.3.0
     # via -r requirements/quality.txt
-edx-django-utils==5.12.0
+edx-django-utils==5.13.0
     # via -r requirements/quality.txt
 edx-lint==5.3.6
     # via -r requirements/quality.txt
@@ -126,7 +126,7 @@ exceptiongroup==1.2.1
     #   pytest
 fastavro==1.9.4
     # via -r requirements/quality.txt
-filelock==3.13.4
+filelock==3.14.0
     # via
     #   -r requirements/ci.txt
     #   tox
@@ -167,12 +167,12 @@ jaraco-functools==4.0.1
     # via
     #   -r requirements/quality.txt
     #   keyring
-jinja2==3.1.3
+jinja2==3.1.4
     # via
     #   -r requirements/quality.txt
     #   code-annotations
     #   diff-cover
-keyring==25.1.0
+keyring==25.2.0
     # via
     #   -r requirements/quality.txt
     #   twine
@@ -254,7 +254,7 @@ pycparser==2.22
     #   cffi
 pydocstyle==6.3.0
     # via -r requirements/quality.txt
-pygments==2.17.2
+pygments==2.18.0
     # via
     #   -r requirements/quality.txt
     #   diff-cover
@@ -292,12 +292,12 @@ pyproject-api==1.6.1
     # via
     #   -r requirements/ci.txt
     #   tox
-pyproject-hooks==1.0.0
+pyproject-hooks==1.1.0
     # via
     #   -r requirements/pip-tools.txt
     #   build
     #   pip-tools
-pytest==8.1.1
+pytest==8.2.0
     # via
     #   -r requirements/quality.txt
     #   pytest-cov
@@ -368,14 +368,13 @@ tomli==2.0.1
     #   pip-tools
     #   pylint
     #   pyproject-api
-    #   pyproject-hooks
     #   pytest
     #   tox
 tomlkit==0.12.4
     # via
     #   -r requirements/quality.txt
     #   pylint
-tox==4.14.2
+tox==4.15.0
     # via -r requirements/ci.txt
 twine==5.0.0
     # via -r requirements/quality.txt
@@ -392,7 +391,7 @@ urllib3==2.2.1
     #   -r requirements/quality.txt
     #   requests
     #   twine
-virtualenv==20.26.0
+virtualenv==20.26.1
     # via
     #   -r requirements/ci.txt
     #   tox

diff --git a/requirements/doc.txt b/requirements/doc.txt
@@ -14,7 +14,7 @@ asgiref==3.8.1
     #   django
 attrs==23.2.0
     # via -r requirements/test.txt
-babel==2.14.0
+babel==2.15.0
     # via
     #   pydata-sphinx-theme
     #   sphinx
@@ -46,7 +46,7 @@ code-annotations==1.7.0
     # via -r requirements/test.txt
 colorama==0.4.6
     # via sphinx-autobuild
-coverage[toml]==7.5.0
+coverage[toml]==7.5.1
     # via
     #   -r requirements/test.txt
     #   pytest-cov
@@ -82,7 +82,7 @@ docutils==0.19
     #   sphinx
 edx-ccx-keys==1.3.0
     # via -r requirements/test.txt
-edx-django-utils==5.12.0
+edx-django-utils==5.13.0
     # via -r requirements/test.txt
 edx-opaque-keys[django]==2.9.0
     # via
@@ -117,12 +117,12 @@ jaraco-context==5.3.0
     # via keyring
 jaraco-functools==4.0.1
     # via keyring
-jinja2==3.1.3
+jinja2==3.1.4
     # via
     #   -r requirements/test.txt
     #   code-annotations
     #   sphinx
-keyring==25.1.0
+keyring==25.2.0
     # via twine
 livereload==2.6.3
     # via sphinx-autobuild
@@ -171,7 +171,7 @@ pycparser==2.22
     #   cffi
 pydata-sphinx-theme==0.14.4
     # via sphinx-book-theme
-pygments==2.17.2
+pygments==2.18.0
     # via
     #   accessible-pygments
     #   doc8
@@ -187,9 +187,9 @@ pynacl==1.5.0
     # via
     #   -r requirements/test.txt
     #   edx-django-utils
-pyproject-hooks==1.0.0
+pyproject-hooks==1.1.0
     # via build
-pytest==8.1.1
+pytest==8.2.0
     # via
     #   -r requirements/test.txt
     #   pytest-cov
@@ -283,7 +283,6 @@ tomli==2.0.1
     #   build
     #   coverage
     #   doc8
-    #   pyproject-hooks
     #   pytest
 tornado==6.4
     # via livereload

diff --git a/requirements/pip-tools.txt b/requirements/pip-tools.txt
@@ -16,15 +16,14 @@ packaging==24.0
     # via build
 pip-tools==7.4.1
     # via -r requirements/pip-tools.in
-pyproject-hooks==1.0.0
+pyproject-hooks==1.1.0
     # via
     #   build
     #   pip-tools
 tomli==2.0.1
     # via
     #   build
     #   pip-tools
-    #   pyproject-hooks
 wheel==0.43.0
     # via pip-tools
 zipp==3.18.1

diff --git a/requirements/quality.txt b/requirements/quality.txt
@@ -43,7 +43,7 @@ code-annotations==1.7.0
     # via
     #   -r requirements/test.txt
     #   edx-lint
-coverage[toml]==7.5.0
+coverage[toml]==7.5.1
     # via
     #   -r requirements/test.txt
     #   pytest-cov
@@ -74,7 +74,7 @@ docutils==0.20.1
     # via readme-renderer
 edx-ccx-keys==1.3.0
     # via -r requirements/test.txt
-edx-django-utils==5.12.0
+edx-django-utils==5.13.0
     # via -r requirements/test.txt
 edx-lint==5.3.6
     # via -r requirements/quality.in
@@ -111,11 +111,11 @@ jaraco-context==5.3.0
     # via keyring
 jaraco-functools==4.0.1
     # via keyring
-jinja2==3.1.3
+jinja2==3.1.4
     # via
     #   -r requirements/test.txt
     #   code-annotations
-keyring==25.1.0
+keyring==25.2.0
     # via twine
 lazy-object-proxy==1.10.0
     # via astroid
@@ -167,7 +167,7 @@ pycparser==2.22
     #   cffi
 pydocstyle==6.3.0
     # via -r requirements/quality.in
-pygments==2.17.2
+pygments==2.18.0
     # via
     #   readme-renderer
     #   rich
@@ -193,7 +193,7 @@ pynacl==1.5.0
     # via
     #   -r requirements/test.txt
     #   edx-django-utils
-pytest==8.1.1
+pytest==8.2.0
     # via
     #   -r requirements/test.txt
     #   pytest-cov

diff --git a/requirements/test.txt b/requirements/test.txt
@@ -26,7 +26,7 @@ click==8.1.7
     #   edx-django-utils
 code-annotations==1.7.0
     # via -r requirements/test.in
-coverage[toml]==7.5.0
+coverage[toml]==7.5.1
     # via pytest-cov
 ddt==1.7.2
     # via -r requirements/test.in
@@ -50,7 +50,7 @@ dnspython==2.6.1
     #   pymongo
 edx-ccx-keys==1.3.0
     # via -r requirements/base.txt
-edx-django-utils==5.12.0
+edx-django-utils==5.13.0
     # via -r requirements/base.txt
 edx-opaque-keys[django]==2.9.0
     # via
@@ -62,7 +62,7 @@ fastavro==1.9.4
     # via -r requirements/base.txt
 iniconfig==2.0.0
     # via pytest
-jinja2==3.1.3
+jinja2==3.1.4
     # via code-annotations
 markupsafe==2.1.5
     # via jinja2
@@ -94,7 +94,7 @@ pynacl==1.5.0
     # via
     #   -r requirements/base.txt
     #   edx-django-utils
-pytest==8.1.1
+pytest==8.2.0
     # via
     #   pytest-cov
     #   pytest-django