fix: satisfy ruff and pylint rules

Author: BryanttV

openedx/core/djangoapps/user_api/accounts/api.py

@@ -6,7 +6,6 @@
 import datetime
 import logging
 import re
-from typing import Optional
 from zoneinfo import ZoneInfo
 
 from django import forms
@@ -366,7 +365,7 @@ def _notify_language_proficiencies_update_if_needed(data, user, user_profile, ol
 
 
 def _update_extended_profile_if_needed(
-    data: dict, user_profile: UserProfile, extended_profile_form: Optional[forms.Form]
+    data: dict, user_profile: UserProfile, extended_profile_form: forms.Form | None
 ) -> None:
     """
     Update the extended profile information if present in the data.
@@ -378,7 +377,7 @@ def _update_extended_profile_if_needed(
     Args:
         data (dict): Dictionary containing the update data, may include 'extended_profile' key
         user_profile (UserProfile): The UserProfile instance to update
-        extended_profile_form (Optional[forms.Form]): The validated extended profile form
+        extended_profile_form (forms.Form | None): The validated extended profile form
             containing extended profile data, or None if no extended profile form is provided
 
     Note:

openedx/core/djangoapps/user_api/accounts/forms.py

@@ -3,7 +3,6 @@
 """
 
 import logging
-from typing import Optional, Tuple
 
 from django import forms
 from django.core.exceptions import ObjectDoesNotExist, ValidationError
@@ -47,12 +46,12 @@ def save(self, retirement):
         handle_retirement_cancellation(retirement)
 
 
-def extract_extended_profile_fields_data(extended_profile: Optional[list[dict]]) -> Tuple[dict, dict]:
+def extract_extended_profile_fields_data(extended_profile: list[dict] | None) -> tuple[dict, dict]:
     """
     Extract extended profile fields data from extended_profile structure.
 
     Args:
-        extended_profile (Optional[list[dict]]): List of field data dictionaries with keys
+        extended_profile (list[dict] | None): List of field data dictionaries with keys
             `field_name` and `field_value`
 
     Returns:
@@ -91,7 +90,7 @@ def extract_extended_profile_fields_data(extended_profile: Optional[list[dict]])
 def get_extended_profile_form(
     extended_profile_fields_data: dict,
     user: User,
-) -> Tuple[Optional[forms.Form], dict]:
+) -> tuple[forms.Form | None, dict]:
     """
     Get and validate an extended profile form instance.
 
@@ -103,7 +102,7 @@ def get_extended_profile_form(
 
     Returns:
         tuple: A tuple containing (extended_profile_form, field_errors)
-            - extended_profile_form (Optional[forms.Form]): The validated form instance,
+            - extended_profile_form (forms.Form | None): The validated form instance,
               or None if no extended profile form is configured, creation fails,
               or form validation fails.
             - field_errors (dict): Dictionary of validation errors, if any
@@ -148,7 +147,7 @@ def get_extended_profile_form(
 
 def validate_and_get_extended_profile_form(
     extended_profile_data: list, user: User
-) -> Tuple[Optional[forms.Form], dict]:
+) -> tuple[forms.Form | None, dict]:
     """
     Validate and return an extended profile form instance.
 
@@ -160,7 +159,7 @@ def validate_and_get_extended_profile_form(
 
     Returns:
         tuple: A tuple containing (validated_form, field_errors)
-            - validated_form (Optional[forms.Form]): The validated form instance, or None if
+            - validated_form (forms.Form | None): The validated form instance, or None if
               validation fails or no extended profile is configured
             - field_errors (dict): Dictionary of validation errors, if any
     """

openedx/core/djangoapps/user_api/accounts/tests/test_api.py

@@ -174,15 +174,15 @@ def test_update_username_provided_with_extended_profile(self):
 
         update_account_settings(self.user, {"extended_profile": extended_profile_data, "name": "Donald Duck"})
         account_settings = get_account_settings(self.default_request)[0]
-        self.assertEqual(extended_profile_data, account_settings["extended_profile"])
-        self.assertEqual("Donald Duck", account_settings["name"])
+        self.assertEqual(extended_profile_data, account_settings["extended_profile"])  # noqa: PT009
+        self.assertEqual("Donald Duck", account_settings["name"])  # noqa: PT009
 
         update_account_settings(
             self.user, {"extended_profile": extended_profile_data, "name": "Mickey Mouse"}, username=self.user.username
         )
         account_settings = get_account_settings(self.default_request)[0]
-        self.assertEqual(extended_profile_data, account_settings["extended_profile"])
-        self.assertEqual("Mickey Mouse", account_settings["name"])
+        self.assertEqual(extended_profile_data, account_settings["extended_profile"])  # noqa: PT009
+        self.assertEqual("Mickey Mouse", account_settings["name"])  # noqa: PT009
 
         with pytest.raises(UserNotAuthorized):
             update_account_settings(
@@ -531,10 +531,10 @@ def test_add_account_recovery(self):
         assert account_recovery.secondary_email == test_email
 
     def test_change_country_removes_state(self):
-        '''
+        """
         Test that changing the country (to something other than a country with
         states) removes the state
-        '''
+        """
         # First set the country and state
         update_account_settings(self.user, {"country": UserProfile.COUNTRY_WITH_STATES, "state": "MA"})
         account_settings = get_account_settings(self.default_request)[0]
@@ -586,9 +586,9 @@ def test_update_extended_profile_with_meta_only(self):
 
         user_profile = UserProfile.objects.get(user=self.user)
         meta = user_profile.get_meta()
-        self.assertEqual(meta["department"], "Engineering")
-        self.assertEqual(meta["title"], "Software Engineer")
-        self.assertEqual(user_profile.bio, "Updated bio")
+        self.assertEqual(meta["department"], "Engineering")  # noqa: PT009
+        self.assertEqual(meta["title"], "Software Engineer")  # noqa: PT009
+        self.assertEqual(user_profile.bio, "Updated bio")  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form")
     def test_update_extended_profile_with_form(self, mock_validate_and_get_form):
@@ -605,7 +605,7 @@ def test_update_extended_profile_with_form(self, mock_validate_and_get_form):
         mock_form.save.assert_called_once_with(commit=False)
         mock_form.save.return_value.save.assert_called_once()
         meta = UserProfile.objects.get(user=self.user).get_meta()
-        self.assertEqual(meta["department"], "Engineering")
+        self.assertEqual(meta["department"], "Engineering")  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form")
     def test_update_extended_profile_with_form_new_instance(self, mock_validate_and_get_form):
@@ -621,7 +621,7 @@ def test_update_extended_profile_with_form_new_instance(self, mock_validate_and_
 
         mock_validate_and_get_form.assert_called_once_with(extended_profile_data, self.user)
         mock_form.save.assert_called_once_with(commit=False)
-        self.assertEqual(mock_instance.user, self.user)
+        self.assertEqual(mock_instance.user, self.user)  # noqa: PT009
         mock_instance.save.assert_called_once()
 
     @patch("openedx.core.djangoapps.user_api.accounts.api.validate_and_get_extended_profile_form")
@@ -644,15 +644,15 @@ def test_update_extended_profile_form_save_error(self, exception, expected_dev_m
         with pytest.raises(AccountUpdateError) as context_manager:
             update_account_settings(self.user, {"extended_profile": extended_profile_data})
 
-        self.assertIn(expected_dev_msg, context_manager.value.developer_message)
-        self.assertIsNotNone(context_manager.value.user_message)
+        self.assertIn(expected_dev_msg, context_manager.value.developer_message)  # noqa: PT009
+        self.assertIsNotNone(context_manager.value.user_message)  # noqa: PT009
 
         mock_validate_and_get_form.assert_called_once_with(extended_profile_data, self.user)
         mock_form.save.assert_called_once_with(commit=False)
 
         # The meta update is in the same transaction, it should be rolled back.
         meta = UserProfile.objects.get(user=self.user).get_meta()
-        self.assertNotIn("department", meta)
+        self.assertNotIn("department", meta)  # noqa: PT009
 
     def test_update_extended_profile_without_extended_profile_data(self):
         """
@@ -663,7 +663,7 @@ def test_update_extended_profile_without_extended_profile_data(self):
         update_account_settings(self.user, update_data)
 
         user_profile = UserProfile.objects.get(user=self.user)
-        self.assertEqual(user_profile.bio, "Updated bio")
+        self.assertEqual(user_profile.bio, "Updated bio")  # noqa: PT009
 
 
 @patch('openedx.core.djangoapps.user_api.accounts.image_helpers._PROFILE_IMAGE_SIZES', [50, 10])

openedx/core/djangoapps/user_api/accounts/tests/test_forms.py

@@ -31,8 +31,8 @@ def test_extract_valid_extended_profile_data(self):
 
         extracted_data, errors = extract_extended_profile_fields_data(extended_profile)
 
-        self.assertEqual(errors, {})
-        self.assertEqual(extracted_data, {"department": "Engineering", "title": "Software Engineer"})
+        self.assertEqual(errors, {})  # noqa: PT009
+        self.assertEqual(extracted_data, {"department": "Engineering", "title": "Software Engineer"})  # noqa: PT009
 
     def test_extract_extended_profile_with_empty_string(self):
         """
@@ -45,8 +45,8 @@ def test_extract_extended_profile_with_empty_string(self):
 
         extracted_data, errors = extract_extended_profile_fields_data(extended_profile)
 
-        self.assertEqual(errors, {})
-        self.assertEqual(extracted_data, {"department": "", "title": "Engineer"})
+        self.assertEqual(errors, {})  # noqa: PT009
+        self.assertEqual(extracted_data, {"department": "", "title": "Engineer"})  # noqa: PT009
 
     def test_extract_extended_profile_not_a_list(self):
         """
@@ -56,9 +56,11 @@ def test_extract_extended_profile_not_a_list(self):
 
         extracted_data, errors = extract_extended_profile_fields_data(extended_profile)
 
-        self.assertEqual(extracted_data, {})
-        self.assertIn("extended_profile", errors)
-        self.assertEqual(errors["extended_profile"]["developer_message"], "extended_profile must be a list")
+        self.assertEqual(extracted_data, {})  # noqa: PT009
+        self.assertIn("extended_profile", errors)  # noqa: PT009
+        self.assertEqual(  # noqa: PT009
+            errors["extended_profile"]["developer_message"], "extended_profile must be a list"
+        )
 
     def test_extract_extended_profile_with_invalid_field_data(self):
         """
@@ -73,8 +75,8 @@ def test_extract_extended_profile_with_invalid_field_data(self):
         extracted_data, errors = extract_extended_profile_fields_data(extended_profile)
 
         # Invalid entry should be skipped, but valid ones should be extracted
-        self.assertEqual(errors, {})
-        self.assertEqual(extracted_data, {"department": "Engineering", "title": "Engineer"})
+        self.assertEqual(errors, {})  # noqa: PT009
+        self.assertEqual(extracted_data, {"department": "Engineering", "title": "Engineer"})  # noqa: PT009
 
     def test_extract_extended_profile_missing_field_name(self):
         """
@@ -87,8 +89,8 @@ def test_extract_extended_profile_missing_field_name(self):
 
         extracted_data, errors = extract_extended_profile_fields_data(extended_profile)
 
-        self.assertEqual(errors, {})
-        self.assertEqual(extracted_data, {"department": "Engineering"})
+        self.assertEqual(errors, {})  # noqa: PT009
+        self.assertEqual(extracted_data, {"department": "Engineering"})  # noqa: PT009
 
     def test_extract_extended_profile_empty_list(self):
         """
@@ -98,8 +100,8 @@ def test_extract_extended_profile_empty_list(self):
 
         extracted_data, errors = extract_extended_profile_fields_data(extended_profile)
 
-        self.assertEqual(errors, {})
-        self.assertEqual(extracted_data, {})
+        self.assertEqual(errors, {})  # noqa: PT009
+        self.assertEqual(extracted_data, {})  # noqa: PT009
 
 
 class TestGetExtendedProfileForm(TestCase):
@@ -121,8 +123,8 @@ def test_get_extended_profile_form_no_model_configured(self, mock_get_model: Moc
 
         form, errors = get_extended_profile_form(extended_profile_fields_data, self.user)
 
-        self.assertIsNone(form)
-        self.assertEqual(errors, {})
+        self.assertIsNone(form)  # noqa: PT009
+        self.assertEqual(errors, {})  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model")
     def test_get_extended_profile_form_model_has_no_objects(self, mock_get_model: Mock):
@@ -135,8 +137,8 @@ def test_get_extended_profile_form_model_has_no_objects(self, mock_get_model: Mo
 
         form, errors = get_extended_profile_form(extended_profile_fields_data, self.user)
 
-        self.assertIsNone(form)
-        self.assertEqual(errors, {})
+        self.assertIsNone(form)  # noqa: PT009
+        self.assertEqual(errors, {})  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form")
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model")
@@ -155,8 +157,8 @@ def test_get_extended_profile_form_with_existing_instance(self, mock_get_model:
 
         form, errors = get_extended_profile_form(extended_profile_fields_data, self.user)
 
-        self.assertEqual(form, mock_form_instance)
-        self.assertEqual(errors, {})
+        self.assertEqual(form, mock_form_instance)  # noqa: PT009
+        self.assertEqual(errors, {})  # noqa: PT009
         mock_model.objects.get.assert_called_once_with(user=self.user)
         mock_get_form.assert_called_once_with(data=extended_profile_fields_data, instance=mock_instance)
 
@@ -177,14 +179,14 @@ def test_get_extended_profile_form_without_existing_instance(self, mock_get_mode
 
         form, errors = get_extended_profile_form(extended_profile_fields_data, self.user)
 
-        self.assertEqual(form, mock_form_instance)
-        self.assertEqual(errors, {})
+        self.assertEqual(form, mock_form_instance)  # noqa: PT009
+        self.assertEqual(errors, {})  # noqa: PT009
         mock_model.objects.get.assert_called_once_with(user=self.user)
         mock_get_form.assert_called_once_with(data=extended_profile_fields_data)
 
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form")
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model")
-    def test_get_extended_profile_form_validation_errors(self, _: Mock, mock_get_form: Mock):
+    def test_get_extended_profile_form_validation_errors(self, mock_get_model: Mock, mock_get_form: Mock):
         """
         Test when form validation fails
         """
@@ -196,11 +198,12 @@ def test_get_extended_profile_form_validation_errors(self, _: Mock, mock_get_for
 
         form, errors = get_extended_profile_form(extended_profile_fields_data, self.user)
 
-        self.assertIsNone(form)
-        self.assertIn("department", errors)
-        self.assertIn("title", errors)
-        self.assertEqual(errors["department"]["user_message"], "This field is required")
-        self.assertEqual(errors["title"]["user_message"], "Invalid value")
+        mock_get_model.assert_called_once()
+        self.assertIsNone(form)  # noqa: PT009
+        self.assertIn("department", errors)  # noqa: PT009
+        self.assertIn("title", errors)  # noqa: PT009
+        self.assertEqual(errors["department"]["user_message"], "This field is required")  # noqa: PT009
+        self.assertEqual(errors["title"]["user_message"], "Invalid value")  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form")
     def test_get_extended_profile_form_returns_none(self, mock_get_form: Mock):
@@ -213,8 +216,8 @@ def test_get_extended_profile_form_returns_none(self, mock_get_form: Mock):
         with patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model"):
             form, errors = get_extended_profile_form(extended_profile_fields_data, self.user)
 
-        self.assertIsNone(form)
-        self.assertEqual(errors, {})
+        self.assertIsNone(form)  # noqa: PT009
+        self.assertEqual(errors, {})  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_registration_extension_form")
     def test_get_extended_profile_form_exception_during_creation(self, mock_get_form: Mock):
@@ -227,9 +230,9 @@ def test_get_extended_profile_form_exception_during_creation(self, mock_get_form
         with patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_model"):
             form, errors = get_extended_profile_form(extended_profile_fields_data, self.user)
 
-        self.assertIsNone(form)
-        self.assertIn("extended_profile", errors)
-        self.assertIn("Error creating custom form", errors["extended_profile"]["developer_message"])
+        self.assertIsNone(form)  # noqa: PT009
+        self.assertIn("extended_profile", errors)  # noqa: PT009
+        self.assertIn("Error creating custom form", errors["extended_profile"]["developer_message"])  # noqa: PT009
 
 
 class TestValidateAndGetExtendedProfileForm(TestCase):
@@ -254,8 +257,8 @@ def test_validate_with_valid_data(self, mock_extract: Mock, mock_get_form: Mock)
 
         form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user)
 
-        self.assertEqual(form, mock_form)
-        self.assertEqual(errors, {})
+        self.assertEqual(form, mock_form)  # noqa: PT009
+        self.assertEqual(errors, {})  # noqa: PT009
         mock_extract.assert_called_once_with(extended_profile_data)
         mock_get_form.assert_called_once_with({"department": "Engineering"}, self.user)
 
@@ -269,8 +272,8 @@ def test_validate_with_extraction_errors(self, mock_extract: Mock):
 
         form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user)
 
-        self.assertIsNone(form)
-        self.assertIn("extended_profile", errors)
+        self.assertIsNone(form)  # noqa: PT009
+        self.assertIn("extended_profile", errors)  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.forms.extract_extended_profile_fields_data")
     def test_validate_with_empty_data(self, mock_extract: Mock):
@@ -282,8 +285,8 @@ def test_validate_with_empty_data(self, mock_extract: Mock):
 
         form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user)
 
-        self.assertIsNone(form)
-        self.assertEqual(errors, {})
+        self.assertIsNone(form)  # noqa: PT009
+        self.assertEqual(errors, {})  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_form")
     @patch("openedx.core.djangoapps.user_api.accounts.forms.extract_extended_profile_fields_data")
@@ -299,8 +302,8 @@ def test_validate_with_form_errors(self, mock_extract: Mock, mock_get_form: Mock
 
         form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user)
 
-        self.assertEqual(form, mock_form)
-        self.assertIn("department", errors)
+        self.assertEqual(form, mock_form)  # noqa: PT009
+        self.assertIn("department", errors)  # noqa: PT009
 
     @patch("openedx.core.djangoapps.user_api.accounts.forms.get_extended_profile_form")
     @patch("openedx.core.djangoapps.user_api.accounts.forms.extract_extended_profile_fields_data")
@@ -316,5 +319,5 @@ def test_validate_merges_errors(self, mock_extract: Mock, mock_get_form: Mock):
 
         form, errors = validate_and_get_extended_profile_form(extended_profile_data, self.user)
 
-        self.assertEqual(form, mock_form)
-        self.assertIn("title", errors)
+        self.assertEqual(form, mock_form)  # noqa: PT009
+        self.assertIn("title", errors)  # noqa: PT009