Mjg/mypy

Makefile

@@ -49,6 +49,7 @@ upgrade:  ## update the requirements/*.txt files with the latest packages satisf
 
 quality: ## check coding style with pycodestyle and pylint
 	pylint openedx_filters test_utils *.py
+	mypy
 	pycodestyle openedx_filters  *.py
 	pydocstyle openedx_filters *.py
 	isort --check-only --diff --recursive test_utils openedx_filters *.py test_settings.py

mypy.ini

@@ -0,0 +1,9 @@
+[mypy]
+allow_untyped_globals = False
+plugins =
+    mypy_django_plugin.main,
+files =
+    openedx_filters
+
+[mypy.plugins.django-stubs]
+django_settings_module = "test_utils.test_settings"

openedx_filters/course_authoring/filters.py

@@ -7,15 +7,26 @@
 
 class LMSPageURLRequested(OpenEdxPublicFilter):
     """
-    Custom class used to get lms page url filters and its custom methods.
+    Filter used to modify the URL of the page requested by the user.
+
+    This filter is triggered when a user loads a page in Studio that references an LMS page, allowing the filter to
+    modify the URL of the page requested by the user.
+
+    Filter Type:
+        org.openedx.course_authoring.lms.page.url.requested.v1
+
+    Trigger:
+        - Repository: openedx/edx-platform
+        - Path: cms/djangoapps/contentstore/asset_storage_handler.py
+        - Function or Method: get_asset_json
     """
 
     filter_type = "org.openedx.course_authoring.lms.page.url.requested.v1"
 
     @classmethod
-    def run_filter(cls, url, org):
+    def run_filter(cls, url: str, org: str) -> tuple[str, str]:
         """
-        Execute a filter with the signature specified.
+        Process the inputs using the configured pipeline steps to modify the URL of the page requested by the user.
 
         Arguments:
             url (str): the URL of the page to be modified.