chore: remove all lint-amnesty annotations

We added those annotations when we first applied lint-amnesty to be able
to run pylint in zero-tolerance mode.  But now the comments keep getting
copied to other places and among other things causing lines to overrun
un-necessarily.

See
https://docs.openedx.org/projects/openedx-proposals/en/latest/archived/oep-0034-bp-lint-amnesty.html
for more historical details.

Generated with:

    grep -r "lint-amnesty" --include="*.py" -l \
        | xargs sed -i \
            's/  # lint-amnesty,\?\s*/  # /g;
             s/# lint-amnesty,\?\s*/# /g;
             s/  # $//'

The first two expressions are identical in effect but handle two spacing
variants: the common case where the comment is preceded by two spaces
("  # lint-amnesty, pylint: ...") and the rarer single-space case
("# lint-amnesty, pylint: ..."). Both strip the prefix while preserving
whatever pylint disable follows. The comma is made optional (",\?") to
handle the rare case where lint-amnesty appears without one. The third
expression cleans up any trailing "  #" left on lines where lint-amnesty
was the entire comment (e.g. ") -> None:  # lint-amnesty" becomes
") -> None:").

Co-Authored-By: Claude Sonnet 4.6 <[email protected]>

Author: feanil

cms/__init__.py

@@ -21,4 +21,4 @@
 # This will make sure the app is always imported when Django starts so
 # that shared_task will use this app, and also ensures that the celery
 # singleton is always configured for the CMS.
-from .celery import APP as CELERY_APP  # lint-amnesty, pylint: disable=wrong-import-position  # noqa: F401
+from .celery import APP as CELERY_APP  # pylint: disable=wrong-import-position  # noqa: F401

cms/conftest.py

@@ -40,4 +40,4 @@ def _django_clear_site_cache():
     clearing mechanism actually works.  So override this fixture to not mess
     with what has been working for us so far.
     """
-    pass  # lint-amnesty, pylint: disable=unnecessary-pass
+    pass  # pylint: disable=unnecessary-pass

cms/djangoapps/api/__init__.py

@@ -1 +1 @@
-# lint-amnesty, pylint: disable=missing-module-docstring
+# pylint: disable=missing-module-docstring

cms/djangoapps/api/v1/serializers/course_runs.py

@@ -13,7 +13,7 @@
 from cms.djangoapps.contentstore.views.course import create_new_course, get_course_and_check_access, rerun_course
 from common.djangoapps.student.models import CourseAccessRole
 from openedx.core.lib.courses import course_image_url
-from xmodule.modulestore.django import modulestore  # lint-amnesty, pylint: disable=wrong-import-order
+from xmodule.modulestore.django import modulestore  # pylint: disable=wrong-import-order
 
 IMAGE_TYPES = {
     'image/jpeg': 'jpg',
@@ -23,29 +23,29 @@
 log = logging.getLogger(__name__)
 
 
-class CourseAccessRoleSerializer(serializers.ModelSerializer):  # lint-amnesty, pylint: disable=missing-class-docstring
+class CourseAccessRoleSerializer(serializers.ModelSerializer):  # pylint: disable=missing-class-docstring
     user = serializers.SlugRelatedField(slug_field='username', queryset=User.objects.all())
 
     class Meta:
         model = CourseAccessRole
         fields = ('user', 'role',)
 
 
-class CourseRunScheduleSerializer(serializers.Serializer):  # lint-amnesty, pylint: disable=abstract-method
+class CourseRunScheduleSerializer(serializers.Serializer):  # pylint: disable=abstract-method
     start = serializers.DateTimeField()
     end = serializers.DateTimeField()
     enrollment_start = serializers.DateTimeField(allow_null=True, required=False)
     enrollment_end = serializers.DateTimeField(allow_null=True, required=False)
 
 
-class CourseRunTeamSerializer(serializers.Serializer):  # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring
+class CourseRunTeamSerializer(serializers.Serializer):  # pylint: disable=abstract-method, missing-class-docstring
     def to_internal_value(self, data):
         """Overriding this to support deserialization, for write operations."""
         for member in data:
             try:
                 User.objects.get(username=member['user'])
             except User.DoesNotExist:
-                raise serializers.ValidationError(  # lint-amnesty, pylint: disable=raise-missing-from  # noqa: B904
+                raise serializers.ValidationError(  # pylint: disable=raise-missing-from  # noqa: B904
                     _('Course team user does not exist')
                 )
 
@@ -61,10 +61,10 @@ def get_attribute(self, instance):
         return instance
 
 
-class CourseRunTeamSerializerMixin(serializers.Serializer):  # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring
+class CourseRunTeamSerializerMixin(serializers.Serializer):  # pylint: disable=abstract-method, missing-class-docstring
     team = CourseRunTeamSerializer(required=False)
 
-    def update_team(self, instance, team):  # lint-amnesty, pylint: disable=missing-function-docstring
+    def update_team(self, instance, team):  # pylint: disable=missing-function-docstring
         # Existing data should remain intact when performing a partial update.
         if not self.partial:
             CourseAccessRole.objects.filter(course_id=instance.id).delete()
@@ -81,7 +81,7 @@ def update_team(self, instance, team):  # lint-amnesty, pylint: disable=missing-
             )
 
 
-class CourseRunImageField(serializers.ImageField):  # lint-amnesty, pylint: disable=missing-class-docstring
+class CourseRunImageField(serializers.ImageField):  # pylint: disable=missing-class-docstring
 
     def get_attribute(self, instance):
         return course_image_url(instance)
@@ -92,15 +92,15 @@ def to_representation(self, value):
         return request.build_absolute_uri(value)
 
 
-class CourseRunPacingTypeField(serializers.ChoiceField):  # lint-amnesty, pylint: disable=missing-class-docstring
+class CourseRunPacingTypeField(serializers.ChoiceField):  # pylint: disable=missing-class-docstring
     def to_representation(self, value):
         return 'self_paced' if value else 'instructor_paced'
 
     def to_internal_value(self, data):
         return data == 'self_paced'
 
 
-class CourseRunImageSerializer(serializers.Serializer):  # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring
+class CourseRunImageSerializer(serializers.Serializer):  # pylint: disable=abstract-method, missing-class-docstring
     # We set an empty default to prevent the parent serializer from attempting
     # to save this value to the Course object.
     card_image = CourseRunImageField(source='course_image', default=empty)
@@ -115,13 +115,13 @@ def update(self, instance, validated_data):
         return instance
 
 
-class CourseRunSerializerCommonFieldsMixin(serializers.Serializer):  # lint-amnesty, pylint: disable=abstract-method
+class CourseRunSerializerCommonFieldsMixin(serializers.Serializer):  # pylint: disable=abstract-method
     schedule = CourseRunScheduleSerializer(source='*', required=False)
     pacing_type = CourseRunPacingTypeField(source='self_paced', required=False,
                                            choices=((False, 'instructor_paced'), (True, 'self_paced'),))
 
 
-class CourseRunSerializer(CourseRunSerializerCommonFieldsMixin, CourseRunTeamSerializerMixin, serializers.Serializer):  # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring
+class CourseRunSerializer(CourseRunSerializerCommonFieldsMixin, CourseRunTeamSerializerMixin, serializers.Serializer):  # pylint: disable=abstract-method, missing-class-docstring
     id = serializers.CharField(read_only=True)
     title = serializers.CharField(source='display_name')
     images = CourseRunImageSerializer(source='*', required=False)
@@ -139,7 +139,7 @@ def update(self, instance, validated_data):
             return instance
 
 
-class CourseRunCreateSerializer(CourseRunSerializer):  # lint-amnesty, pylint: disable=missing-class-docstring
+class CourseRunCreateSerializer(CourseRunSerializer):  # pylint: disable=missing-class-docstring
     org = serializers.CharField(source='id.org')
     number = serializers.CharField(source='id.course')
     run = serializers.CharField(source='id.run')
@@ -155,7 +155,7 @@ def create(self, validated_data):
         return instance
 
 
-class CourseRunRerunSerializer(CourseRunSerializerCommonFieldsMixin, CourseRunTeamSerializerMixin,  # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring
+class CourseRunRerunSerializer(CourseRunSerializerCommonFieldsMixin, CourseRunTeamSerializerMixin,  # pylint: disable=abstract-method, missing-class-docstring
                                serializers.Serializer):
     title = serializers.CharField(source='display_name', required=False)
     number = serializers.CharField(source='id.course', required=False)
@@ -171,7 +171,7 @@ def validate(self, attrs):
             with store.default_store('split'):
                 new_course_run_key = store.make_course_key(course_run_key.org, number, run)
         except InvalidKeyError:
-            raise serializers.ValidationError(  # lint-amnesty, pylint: disable=raise-missing-from  # noqa: B904
+            raise serializers.ValidationError(  # pylint: disable=raise-missing-from  # noqa: B904
                 'Invalid key supplied. Ensure there are no special characters in the Course Number.'
             )
         if store.has_course(new_course_run_key, ignore_case=True):
@@ -200,7 +200,7 @@ def update(self, instance, validated_data):
         return course_run
 
 
-class CourseCloneSerializer(serializers.Serializer):  # lint-amnesty, pylint: disable=abstract-method, missing-class-docstring
+class CourseCloneSerializer(serializers.Serializer):  # pylint: disable=abstract-method, missing-class-docstring
     source_course_id = serializers.CharField()
     destination_course_id = serializers.CharField()
 

cms/djangoapps/api/v1/tests/test_serializers/test_course_runs.py

@@ -11,16 +11,16 @@
 from common.djangoapps.student.tests.factories import UserFactory
 from openedx.core.lib.courses import course_image_url
 from xmodule.modulestore.tests.django_utils import (
-    ModuleStoreTestCase,  # lint-amnesty, pylint: disable=wrong-import-order
+    ModuleStoreTestCase,  # pylint: disable=wrong-import-order
 )
-from xmodule.modulestore.tests.factories import CourseFactory  # lint-amnesty, pylint: disable=wrong-import-order
+from xmodule.modulestore.tests.factories import CourseFactory  # pylint: disable=wrong-import-order
 
 from ...serializers.course_runs import CourseRunSerializer
 from ..utils import serialize_datetime
 
 
 @ddt.ddt
-class CourseRunSerializerTests(ModuleStoreTestCase):  # lint-amnesty, pylint: disable=missing-class-docstring
+class CourseRunSerializerTests(ModuleStoreTestCase):  # pylint: disable=missing-class-docstring
 
     def setUp(self):
         super().setUp()

cms/djangoapps/api/v1/tests/test_views/test_course_runs.py

@@ -2,7 +2,7 @@
 
 
 import datetime
-from unittest.mock import patch  # lint-amnesty, pylint: disable=unused-import  # noqa: F401
+from unittest.mock import patch  # pylint: disable=unused-import  # noqa: F401
 
 import ddt
 import pytz
@@ -16,14 +16,14 @@
 from common.djangoapps.student.models import CourseAccessRole
 from common.djangoapps.student.tests.factories import TEST_PASSWORD, AdminFactory, UserFactory
 from openedx.core.lib.courses import course_image_url
-from xmodule.contentstore.content import StaticContent  # lint-amnesty, pylint: disable=wrong-import-order
-from xmodule.contentstore.django import contentstore  # lint-amnesty, pylint: disable=wrong-import-order
-from xmodule.exceptions import NotFoundError  # lint-amnesty, pylint: disable=wrong-import-order
-from xmodule.modulestore.django import modulestore  # lint-amnesty, pylint: disable=wrong-import-order
+from xmodule.contentstore.content import StaticContent  # pylint: disable=wrong-import-order
+from xmodule.contentstore.django import contentstore  # pylint: disable=wrong-import-order
+from xmodule.exceptions import NotFoundError  # pylint: disable=wrong-import-order
+from xmodule.modulestore.django import modulestore  # pylint: disable=wrong-import-order
 from xmodule.modulestore.tests.django_utils import (
-    ModuleStoreTestCase,  # lint-amnesty, pylint: disable=wrong-import-order
+    ModuleStoreTestCase,  # pylint: disable=wrong-import-order
 )
-from xmodule.modulestore.tests.factories import (  # lint-amnesty, pylint: disable=wrong-import-order
+from xmodule.modulestore.tests.factories import (  # pylint: disable=wrong-import-order
     CourseFactory,
     ToyCourseFactory,
 )
@@ -336,15 +336,15 @@ def test_rerun(self, pacing_type, expected_self_paced_value, number):
         original_course_run = ToyCourseFactory()
         add_organization({
             'name': 'Test Organization',
-            'short_name': original_course_run.id.org,  # lint-amnesty, pylint: disable=no-member
+            'short_name': original_course_run.id.org,  # pylint: disable=no-member
             'description': 'Testing Organization Description',
         })
         start = datetime.datetime.now(pytz.UTC).replace(microsecond=0)
         end = start + datetime.timedelta(days=30)
         user = UserFactory()
         role = 'instructor'
         run = '3T2017'
-        url = reverse('api:v1:course_run-rerun', kwargs={'pk': str(original_course_run.id)})  # lint-amnesty, pylint: disable=no-member
+        url = reverse('api:v1:course_run-rerun', kwargs={'pk': str(original_course_run.id)})  # pylint: disable=no-member
         data = {
             'run': run,
             'schedule': {
@@ -374,16 +374,16 @@ def test_rerun(self, pacing_type, expected_self_paced_value, number):
 
         if number:
             assert course_run.id.course == number
-            assert course_run.id.course != original_course_run.id.course  # lint-amnesty, pylint: disable=no-member
+            assert course_run.id.course != original_course_run.id.course  # pylint: disable=no-member
         else:
-            assert course_run.id.course == original_course_run.id.course  # lint-amnesty, pylint: disable=no-member
+            assert course_run.id.course == original_course_run.id.course  # pylint: disable=no-member
 
         self.assert_course_run_schedule(course_run, start, end)
         self.assert_access_role(course_run, user, role)
         self.assert_course_access_role_count(course_run, 1)
         course_orgs = get_course_organizations(course_run_key)
         self.assertEqual(len(course_orgs), 1)  # noqa: PT009
-        self.assertEqual(course_orgs[0]['short_name'], original_course_run.id.org)  # lint-amnesty, pylint: disable=no-member  # noqa: PT009
+        self.assertEqual(course_orgs[0]['short_name'], original_course_run.id.org)  # pylint: disable=no-member  # noqa: PT009
 
     def test_rerun_duplicate_run(self):
         course_run = ToyCourseFactory()

cms/djangoapps/api/v1/tests/utils.py

@@ -1,3 +1,3 @@
-# lint-amnesty, pylint: disable=missing-module-docstring
+# pylint: disable=missing-module-docstring
 def serialize_datetime(d):
     return d.strftime('%Y-%m-%dT%H:%M:%S.%fZ')

cms/djangoapps/api/v1/views/course_runs.py

@@ -19,7 +19,7 @@
 )
 
 
-class CourseRunViewSet(viewsets.GenericViewSet):  # lint-amnesty, pylint: disable=missing-class-docstring
+class CourseRunViewSet(viewsets.GenericViewSet):  # pylint: disable=missing-class-docstring
     lookup_value_regex = settings.COURSE_KEY_REGEX
     permission_classes = (permissions.IsAdminUser,)
     serializer_class = CourseRunSerializer
@@ -42,18 +42,18 @@ def get_object(self):
 
         raise Http404
 
-    def list(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=unused-argument
+    def list(self, request, *args, **kwargs):  # pylint: disable=unused-argument
         course_runs, __ = _accessible_courses_iter(request)
         page = self.paginate_queryset(list(course_runs))
         serializer = self.get_serializer(page, many=True)
         return self.get_paginated_response(serializer.data)
 
-    def retrieve(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=unused-argument
+    def retrieve(self, request, *args, **kwargs):  # pylint: disable=unused-argument
         course_run = self.get_object()
         serializer = self.get_serializer(course_run)
         return Response(serializer.data)
 
-    def update(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=missing-function-docstring, unused-argument
+    def update(self, request, *args, **kwargs):  # pylint: disable=missing-function-docstring, unused-argument
         course_run = self.get_object()
 
         partial = kwargs.pop('partial', False)
@@ -66,7 +66,7 @@ def partial_update(self, request, *args, **kwargs):
         kwargs['partial'] = True
         return self.update(request, *args, **kwargs)
 
-    def create(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=unused-argument
+    def create(self, request, *args, **kwargs):  # pylint: disable=unused-argument
         serializer = CourseRunCreateSerializer(data=request.data, context=self.get_serializer_context())
         serializer.is_valid(raise_exception=True)
         serializer.save()
@@ -77,15 +77,15 @@ def create(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=unu
         methods=['post', 'put'],
         parser_classes=(parsers.FormParser, parsers.MultiPartParser,),
         serializer_class=CourseRunImageSerializer)
-    def images(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=missing-function-docstring, unused-argument
+    def images(self, request, *args, **kwargs):  # pylint: disable=missing-function-docstring, unused-argument
         course_run = self.get_object()
         serializer = CourseRunImageSerializer(course_run, data=request.data, context=self.get_serializer_context())
         serializer.is_valid(raise_exception=True)
         serializer.save()
         return Response(serializer.data)
 
     @action(detail=True, methods=['post'])
-    def rerun(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=missing-function-docstring, unused-argument
+    def rerun(self, request, *args, **kwargs):  # pylint: disable=missing-function-docstring, unused-argument
         course_run = self.get_object()
         serializer = CourseRunRerunSerializer(course_run, data=request.data, context=self.get_serializer_context())
         serializer.is_valid(raise_exception=True)
@@ -94,7 +94,7 @@ def rerun(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=miss
         return Response(serializer.data, status=status.HTTP_201_CREATED)
 
     @action(detail=False, methods=['post'])
-    def clone(self, request, *args, **kwargs):  # lint-amnesty, pylint: disable=unused-argument
+    def clone(self, request, *args, **kwargs):  # pylint: disable=unused-argument
         """
         **Use Case**
 

cms/djangoapps/cms_user_tasks/tests.py

@@ -77,7 +77,7 @@ class TestUserTasks(APITestCase):
     """
 
     @classmethod
-    def setUpTestData(cls):  # lint-amnesty, pylint: disable=super-method-not-called
+    def setUpTestData(cls):  # pylint: disable=super-method-not-called
         cls.user = UserFactory.create(username='test_user', email='[email protected]', password='password')
         cls.status = UserTaskStatus.objects.create(
             user=cls.user, task_id=str(uuid4()), task_class='test_rest_api.sample_task', name='SampleTask 2',
@@ -151,7 +151,7 @@ class TestUserTaskStopped(APITestCase):
     """
 
     @classmethod
-    def setUpTestData(cls):  # lint-amnesty, pylint: disable=super-method-not-called
+    def setUpTestData(cls):  # pylint: disable=super-method-not-called
         cls.user = UserFactory.create(username='test_user', email='[email protected]', password='password')
         cls.status = UserTaskStatus.objects.create(
             user=cls.user, task_id=str(uuid4()), task_class='test_rest_api.sample_task', name='SampleTask 2',