chore: misc typing improvements + type-check helpers.py in CMS

Author: bradenmacdonald

cms/djangoapps/contentstore/helpers.py

@@ -39,6 +39,7 @@
 from openedx.core.djangoapps.content_tagging.types import TagValuesByObjectIdDict
 from openedx.core.djangoapps.site_configuration import helpers as configuration_helpers
 from openedx.core.djangoapps.video_config.transcripts_utils import Transcript, build_components_import_path
+from openedx.core.types import AuthUser as UserType
 from xmodule.contentstore.content import StaticContent
 from xmodule.contentstore.django import contentstore
 from xmodule.exceptions import NotFoundError
@@ -454,7 +455,7 @@ def _fetch_and_set_upstream_link(
     copied_from_block: str,
     copied_from_version_num: int,
     temp_xblock: XBlock,
-    user: User
+    user: UserType,
 ):
     """
     Fetch and set upstream link for the given xblock which is being pasted. This function handles following cases:
@@ -515,7 +516,7 @@ def _import_xml_node_to_parent(
     # The modulestore we're using
     store,
     # The user who is performing this operation
-    user: User,
+    user: UserType,
     # Hint to use as usage ID (block_id) for the new XBlock
     slug_hint: str | None = None,
     # Content tags applied to the source XBlock(s)

mypy.ini

@@ -9,6 +9,7 @@ files =
     cms/lib/xblock,
     cms/djangoapps/contentstore/rest_api/v2/views,
     cms/djangoapps/contentstore/xblock_storage_handlers,
+    cms/djangoapps/contentstore/helpers.py,
     cms/djangoapps/modulestore_migrator,
     openedx/core/djangoapps/content/learning_sequences,
     # FIXME: need to solve type issues and add 'search' app here:

openedx/core/djangoapps/content_staging/tests/test_clipboard.py

@@ -35,7 +35,7 @@ class ClipboardTestCase(ModuleStoreTestCase):
     Test Clipboard functionality
     """
 
-    def test_empty_clipboard(self):
+    def test_empty_clipboard(self) -> None:
         """
         When a user has no content on their clipboard, we get an empty 200 response
         """
@@ -70,7 +70,7 @@ def _setup_course(self):
 
         return (course_key, client)
 
-    def test_copy_video(self):
+    def test_copy_video(self) -> None:
         """
         Test copying a video from the course, and retrieve it using the REST API
         """
@@ -103,7 +103,7 @@ def test_copy_video(self):
         # Now if we GET the clipboard again, the GET response should exactly equal the last POST response:
         assert client.get(CLIPBOARD_ENDPOINT).json() == response_data
 
-    def test_copy_video_python_get(self):
+    def test_copy_video_python_get(self) -> None:
         """
         Test copying a video from the course, and retrieve it using the python API
         """
@@ -126,9 +126,10 @@ def test_copy_video_python_get(self):
         assert clipboard_data.content.display_name == "default"
         # Test the actual OLX in the clipboard:
         olx_data = python_api.get_staged_content_olx(clipboard_data.content.id)
+        assert olx_data is not None
         self.assertXmlEqual(olx_data, SAMPLE_VIDEO_OLX)
 
-    def test_copy_html(self):
+    def test_copy_html(self) -> None:
         """
         Test copying an HTML XBlock from the course
         """
@@ -166,7 +167,7 @@ def test_copy_html(self):
         # Now if we GET the clipboard again, the GET response should exactly equal the last POST response:
         assert client.get(CLIPBOARD_ENDPOINT).json() == response_data
 
-    def test_copy_unit(self):
+    def test_copy_unit(self) -> None:
         """
         Test copying a unit (vertical block) from the course
         """
@@ -242,7 +243,7 @@ def test_copy_unit(self):
         # Now if we GET the clipboard again, the GET response should exactly equal the last POST response:
         assert client.get(CLIPBOARD_ENDPOINT).json() == response_data
 
-    def test_copy_several_things(self):
+    def test_copy_several_things(self) -> None:
         """
         Test that the clipboard only holds one thing at a time.
         """
@@ -275,7 +276,7 @@ def test_copy_several_things(self):
         # The OLX link from the video will no longer work:
         assert client.get(old_olx_url).status_code == 404
 
-    def test_copy_static_assets(self):
+    def test_copy_static_assets(self) -> None:
         """
         Test copying an HTML from the course that references a static asset file.
         """
@@ -297,6 +298,7 @@ def test_copy_static_assets(self):
         response_data = response.json()
         staged_content_id = cast(python_api.StagedContentID, response_data["content"]["id"])
         olx_str = python_api.get_staged_content_olx(staged_content_id)
+        assert olx_str is not None
         assert '<img src="/static/foo_bar.jpg" />' in olx_str
         static_assets = python_api.get_staged_content_static_files(staged_content_id)
 
@@ -307,7 +309,7 @@ def test_copy_static_assets(self):
             data=None,
         )]
 
-    def test_copy_static_assets_nonexistent(self):
+    def test_copy_static_assets_nonexistent(self) -> None:
         """
         Test copying a HTML block which references non-existent static assets.
         """
@@ -332,11 +334,12 @@ def test_copy_static_assets_nonexistent(self):
         response_data = response.json()
         staged_content_id = response_data["content"]["id"]
         olx_str = python_api.get_staged_content_olx(staged_content_id)
+        assert olx_str is not None
         assert '<a href="/static/nonexistent1.jpg">' in olx_str
         static_assets = python_api.get_staged_content_static_files(staged_content_id)
         assert static_assets == []
 
-    def test_no_course_permission(self):
+    def test_no_course_permission(self) -> None:
         """
         Test that a user without read access cannot copy items in a course
         """
@@ -353,7 +356,7 @@ def test_no_course_permission(self):
         response = nonstaff_client.get(CLIPBOARD_ENDPOINT)
         assert response.json()["content"] is None
 
-    def test_no_stealing_clipboard_content(self):
+    def test_no_stealing_clipboard_content(self) -> None:
         """
         Test that a user cannot see another user's clipboard
         """
@@ -370,7 +373,7 @@ def test_no_stealing_clipboard_content(self):
         response = nonstaff_client.get(olx_url)
         assert response.status_code == 403
 
-    def assertXmlEqual(self, xml_str_a: str, xml_str_b: str):
+    def assertXmlEqual(self, xml_str_a: str, xml_str_b: str) -> None:
         """ Assert that the given XML strings are equal, ignoring attribute order and some whitespace variations. """
         a = ElementTree.canonicalize(xml_str_a, strip_text=True)
         b = ElementTree.canonicalize(xml_str_b, strip_text=True)

openedx/core/types/__init__.py

@@ -3,4 +3,4 @@
 """
 from django.contrib.admin import display as admin_display  # noqa: F401
 
-from .user import User  # noqa: F401
+from .user import AuthUser, User  # noqa: F401

openedx/core/types/user.py

@@ -3,9 +3,9 @@
 """
 from __future__ import annotations
 
-import typing as t
-
 import django.contrib.auth.models
 
-AuthUser: t.TypeAlias = django.contrib.auth.models.User  # noqa: UP040
-User: t.TypeAlias = django.contrib.auth.models.User | django.contrib.auth.models.AnonymousUser  # noqa: UP040
+# base type for an authenticated user
+type AuthUser = django.contrib.auth.models.User
+# base type for a generic user making an HTTP request, which may or may not be authenticated:
+type User = AuthUser | django.contrib.auth.models.AnonymousUser