Ruff: add and fix Q (except Q000) (#10094)

* Ruff: add Q001

* Ruff: fix Q001

* Ruff: add Q002

* Ruff: fix Q002

* Ruff: add Q003

* Ruff: fix Q003

* Ruff: add Q004

* Ruff: fix Q004

Author: kiblik

dojo/api_v2/permissions.py

@@ -437,7 +437,7 @@ def has_permission(self, request, view):
             )
         elif engagement_id := converted_dict.get("engagement_id"):
             # engagement_id doesn't exist
-            msg = f"Engagement \"{engagement_id}\" does not exist"
+            msg = f'Engagement "{engagement_id}" does not exist'
             raise serializers.ValidationError(msg)
 
         if not converted_dict.get("auto_create_context"):
@@ -492,7 +492,7 @@ def has_permission(self, request, view):
             )
         elif product_id := converted_dict.get("product_id"):
             # product_id doesn't exist
-            msg = f"Product \"{product_id}\" does not exist"
+            msg = f'Product "{product_id}" does not exist'
             raise serializers.ValidationError(msg)
         else:
             msg = "Need product_id or product_name to perform import"
@@ -633,7 +633,7 @@ def has_permission(self, request, view):
             )
         elif test_id := converted_dict.get("test_id"):
             # test_id doesn't exist
-            msg = f"Test \"{test_id}\" does not exist"
+            msg = f'Test "{test_id}" does not exist'
             raise serializers.ValidationError(msg)
 
         if not converted_dict.get("auto_create_context"):
@@ -927,28 +927,28 @@ def raise_no_auto_create_import_validation_error(
         raise ValidationError(msg)
 
     if product_type_name and not product_type:
-        msg = f"Product Type \"{product_type_name}\" does not exist"
+        msg = f'Product Type "{product_type_name}" does not exist'
         raise serializers.ValidationError(msg)
 
     if product_name and not product:
         if product_type_name:
-            msg = f"Product \"{product_name}\" does not exist in Product_Type \"{product_type_name}\""
+            msg = f'Product "{product_name}" does not exist in Product_Type "{product_type_name}"'
             raise serializers.ValidationError(msg)
         else:
-            msg = f"Product \"{product_name}\" does not exist"
+            msg = f'Product "{product_name}" does not exist'
             raise serializers.ValidationError(msg)
 
     if engagement_name and not engagement:
-        msg = f"Engagement \"{engagement_name}\" does not exist in Product \"{product_name}\""
+        msg = f'Engagement "{engagement_name}" does not exist in Product "{product_name}"'
         raise serializers.ValidationError(msg)
 
     # these are only set for reimport
     if test_title:
-        msg = f"Test \"{test_title}\" with scan_type \"{scan_type}\" does not exist in Engagement \"{engagement_name}\""
+        msg = f'Test "{test_title}" with scan_type "{scan_type}" does not exist in Engagement "{engagement_name}"'
         raise serializers.ValidationError(msg)
 
     if scan_type:
-        msg = f"Test with scan_type \"{scan_type}\" does not exist in Engagement \"{engagement_name}\""
+        msg = f'Test with scan_type "{scan_type}" does not exist in Engagement "{engagement_name}"'
         raise serializers.ValidationError(msg)
 
     raise ValidationError(error_message)
@@ -995,28 +995,28 @@ def check_auto_create_permission(
 
     if product and product_name and engagement_name:
         if not user_has_permission(user, product, Permissions.Engagement_Add):
-            msg = f"No permission to create engagements in product \"{product_name}\""
+            msg = f'No permission to create engagements in product "{product_name}"'
             raise PermissionDenied(msg)
 
         if not user_has_permission(
             user, product, Permissions.Import_Scan_Result
         ):
-            msg = f"No permission to import scans into product \"{product_name}\""
+            msg = f'No permission to import scans into product "{product_name}"'
             raise PermissionDenied(msg)
 
         # all good
         return True
 
     if not product and product_name:
         if not product_type_name:
-            msg = f"Product \"{product_name}\" does not exist and no product_type_name provided to create the new product in"
+            msg = f'Product "{product_name}" does not exist and no product_type_name provided to create the new product in'
             raise serializers.ValidationError(msg)
 
         if not product_type:
             if not user_has_global_permission(
                 user, Permissions.Product_Type_Add
             ):
-                msg = f"No permission to create product_type \"{product_type_name}\""
+                msg = f'No permission to create product_type "{product_type_name}"'
                 raise PermissionDenied(msg)
             # new product type can be created with current user as owner, so
             # all objects in it can be created as well
@@ -1025,7 +1025,7 @@ def check_auto_create_permission(
             if not user_has_permission(
                 user, product_type, Permissions.Product_Type_Add_Product
             ):
-                msg = f"No permission to create products in product_type \"{product_type}\""
+                msg = f'No permission to create products in product_type "{product_type}"'
                 raise PermissionDenied(msg)
 
         # product can be created, so objects in it can be created as well

dojo/filters.py

@@ -1615,7 +1615,7 @@ class FindingFilterHelper(FilterSet):
             "The range of EPSS score percentages to filter on; the left input is a lower bound, "
             "the right is an upper bound. Leaving one empty will skip that bound (e.g., leaving "
             "the lower bound input empty will filter only on the upper bound -- filtering on "
-            "\"less than or equal\")."
+            '"less than or equal").'
         ))
     epss_percentile = PercentageFilter(field_name="epss_percentile", label="EPSS percentile")
     epss_percentile_range = PercentageRangeFilter(
@@ -1624,7 +1624,7 @@ class FindingFilterHelper(FilterSet):
         help_text=(
             "The range of EPSS percentiles to filter on; the left input is a lower bound, the right "
             "is an upper bound. Leaving one empty will skip that bound (e.g., leaving the lower bound "
-            "input empty will filter only on the upper bound -- filtering on \"less than or equal\")."
+            'input empty will filter only on the upper bound -- filtering on "less than or equal").'
         ))
 
     o = OrderingFilter(

dojo/finding/views.py

@@ -1709,7 +1709,7 @@ def request_finding_review(request, fid):
                 finding=finding,
                 reviewers=reviewers,
                 recipients=reviewers_usernames,
-                description=f"User {user.get_full_name()} has requested that user(s) {reviewers_string} review the finding \"{finding.title}\" for accuracy:\n\n{new_note}",
+                description=f'User {user.get_full_name()} has requested that user(s) {reviewers_string} review the finding "{finding.title}" for accuracy:\n\n{new_note}',
                 icon="check",
                 url=reverse("view_finding", args=(finding.id,)),
             )

dojo/forms.py

@@ -3155,8 +3155,8 @@ def __init__(self, *args, **kwargs):
 # Show in admin a multichoice list of validator names
 # pass this to form using field_name='validator_name' ?
 class QuestionForm(forms.Form):
-    ''' Base class for a Question
-    '''
+    """ Base class for a Question
+    """
 
     def __init__(self, *args, **kwargs):
         self.helper = FormHelper()

dojo/importers/base_importer.py

@@ -567,7 +567,7 @@ def sanitize_severity(
         # Ensure the final severity is one of the supported options
         if finding.severity not in SEVERITIES:
             msg = (
-                f"Finding severity \"{finding.severity}\" is not supported. "
+                f'Finding severity "{finding.severity}" is not supported. '
                 f"Any of the following are supported: {SEVERITIES}."
             )
             raise ValidationError(msg)

dojo/importers/default_reimporter.py

@@ -399,7 +399,7 @@ def match_new_finding_to_existing_finding(
                     severity=unsaved_finding.severity,
                     numerical_severity=Finding.get_numerical_severity(unsaved_finding.severity)).order_by('id')
         else:
-            logger.error(f"Internal error: unexpected deduplication_algorithm: \"{self.deduplication_algorithm}\"")
+            logger.error(f'Internal error: unexpected deduplication_algorithm: "{self.deduplication_algorithm}"')
             return None
 
     def process_matched_finding(

dojo/jira_link/views.py

@@ -544,7 +544,7 @@ def post(self, request, tid=None):
                     create_notification(
                         event='jira_config_deleted',
                         title=_('Deletion of JIRA: %s') % jira_instance.configuration_name,
-                        description=f"JIRA \"{jira_instance.configuration_name}\" was deleted by {request.user}",
+                        description=f'JIRA "{jira_instance.configuration_name}" was deleted by {request.user}',
                         url=request.build_absolute_uri(reverse('jira')))
                     return HttpResponseRedirect(reverse('jira'))
                 except Exception as e:

dojo/management/commands/dedupe.py

@@ -38,7 +38,7 @@ def add_arguments(self, parser):
             '--parser',
             dest='parser',
             action='append',
-            help='''List of parsers for which hash_code needs recomputing (defaults to all parsers)'''
+            help="""List of parsers for which hash_code needs recomputing (defaults to all parsers)"""
         )
 
         parser.add_argument('--hash_code_only', action='store_true', help='Only compute hash codes')

dojo/models.py

@@ -553,7 +553,7 @@ class System_Settings(models.Model):
         default=True,
         blank=False,
         verbose_name=_("Password must contain one special character"),
-        help_text=_("Requires user passwords to contain at least one special character (()[]{}|\\`~!@#$%^&*_-+=;:\'\",<>./?)."))
+        help_text=_("Requires user passwords to contain at least one special character (()[]{}|\\`~!@#$%^&*_-+=;:'\",<>./?)."))
     lowercase_character_required = models.BooleanField(
         default=True,
         blank=False,
@@ -3908,7 +3908,7 @@ class JIRA_Project(models.Model):
     engagement = models.OneToOneField(Engagement, on_delete=models.CASCADE, null=True, blank=True)
     component = models.CharField(max_length=200, blank=True)
     custom_fields = models.JSONField(max_length=200, blank=True, null=True,
-                                   help_text=_("JIRA custom field JSON mapping of Id to value, e.g. {\"customfield_10122\": [{\"name\": \"8.0.1\"}]}"))
+                                   help_text=_('JIRA custom field JSON mapping of Id to value, e.g. {"customfield_10122": [{"name": "8.0.1"}]}'))
     default_assignee = models.CharField(max_length=200, blank=True, null=True,
                                      help_text=_("JIRA default assignee (name). If left blank then it defaults to whatever is configured in JIRA."))
     jira_labels = models.CharField(max_length=200, blank=True, null=True,
@@ -4384,9 +4384,9 @@ def __str__(self):
 # ==============================
 with warnings.catch_warnings(action="ignore", category=ManagerInheritanceWarning):
     class Question(PolymorphicModel, TimeStampedModel):
-        '''
+        """
             Represents a question.
-        '''
+        """
 
         class Meta:
             ordering = ['order']
@@ -4407,23 +4407,23 @@ def __str__(self):
 
 
 class TextQuestion(Question):
-    '''
+    """
     Question with a text answer
-    '''
+    """
     objects = PolymorphicManager()
 
     def get_form(self):
-        '''
+        """
         Returns the form for this model
-        '''
+        """
         from .forms import TextQuestionForm
         return TextQuestionForm
 
 
 class Choice(TimeStampedModel):
-    '''
+    """
     Model to store the choices for multi choice questions
-    '''
+    """
 
     order = models.PositiveIntegerField(default=1)
 
@@ -4437,20 +4437,20 @@ def __str__(self):
 
 
 class ChoiceQuestion(Question):
-    '''
+    """
     Question with answers that are chosen from a list of choices defined
     by the user.
-    '''
+    """
 
     multichoice = models.BooleanField(default=False,
                                       help_text=_("Select one or more"))
     choices = models.ManyToManyField(Choice)
     objects = PolymorphicManager()
 
     def get_form(self):
-        '''
+        """
         Returns the form for this model
-        '''
+        """
 
         from .forms import ChoiceQuestionForm
         return ChoiceQuestionForm
@@ -4516,8 +4516,8 @@ def __str__(self):
 
 with warnings.catch_warnings(action="ignore", category=ManagerInheritanceWarning):
     class Answer(PolymorphicModel, TimeStampedModel):
-        ''' Base Answer model
-        '''
+        """ Base Answer model
+        """
         question = models.ForeignKey(Question, on_delete=models.CASCADE)
 
         answered_survey = models.ForeignKey(Answered_Survey,

dojo/product/views.py

@@ -580,11 +580,11 @@ def view_product_metrics(request, pid):
     closed_findings = list(filters.get("closed", []).values('id', 'date', 'severity'))
     accepted_findings = list(filters.get("accepted", []).values('id', 'date', 'severity'))
 
-    '''
+    """
         Optimization: Create dictionaries in the structure of { finding_id: True } for index based search
         Previously the for-loop below used "if finding in open_findings" -- an average O(n^2) time complexity
         This allows for "if open_findings.get(finding_id, None)" -- an average O(n) time complexity
-    '''
+    """
     open_findings_dict = {f.get('id'): True for f in open_findings}
     closed_findings_dict = {f.get('id'): True for f in closed_findings}
     accepted_findings_dict = {f.get('id'): True for f in accepted_findings}

dojo/search/views.py

@@ -364,7 +364,7 @@ def simple_search(request):
         response.delete_cookie("highlight", path='/')
     return response
 
-    '''
+    """
     query:     some keywords
     operators: {}
     keywords:  ['some', 'keywords']
@@ -400,7 +400,7 @@ def simple_search(request):
     query:     tags:anchore vulnerability_id:CVE-2020-1234 jquery
     operators: {'tags': ['anchore'], 'vulnerability_id': ['CVE-2020-1234']}
     keywords:  ['jquery']
-    '''
+    """
 
 
 # it's not google grade parsing, but let's do some basic stuff right

dojo/sla_config/views.py

@@ -42,7 +42,7 @@ def edit_sla_config(request, slaid):
     if request.method == 'POST' and request.POST.get('delete'):
         if sla_config.id != 1:
             if Product.objects.filter(sla_configuration=sla_config).count():
-                msg = f"The \"{sla_config}\" SLA configuration could not be deleted, as it is currently in use by one or more products."
+                msg = f'The "{sla_config}" SLA configuration could not be deleted, as it is currently in use by one or more products.'
                 messages.add_message(request,
                                     messages.ERROR,
                                     msg,

dojo/survey/urls.py

@@ -1,8 +1,8 @@
-'''
+"""
 Created on Feb 18, 2015
 
 @author: jay7958
-'''
+"""
 from django.apps import apps
 from django.contrib import admin
 from django.urls import re_path

dojo/templatetags/display_tags.py

@@ -378,7 +378,7 @@ def notspecified(text):
     if text:
         return text
     else:
-        return mark_safe("<em class=\"text-muted\">Not Specified</em>")
+        return mark_safe('<em class="text-muted">Not Specified</em>')
 
 
 @register.tag

dojo/templatetags/survey_tags.py

@@ -1,8 +1,8 @@
-'''
+"""
 Created on Feb 18, 2015
 
 @author: jay7958
-'''
+"""
 from django import template
 
 from dojo.models import Answered_Survey, Engagement_Survey

dojo/tools/api_sonarqube/api_client.py

@@ -265,7 +265,7 @@ def get_issue(self, issue_key):
             if issue["key"] == issue_key:
                 return issue
         msg = (
-            f"Expected Issue \"{issue_key}\", but it returned"
+            f'Expected Issue "{issue_key}", but it returned'
             f"{[x.get('key') for x in response.json().get('issues')]}. "
             "Full response: "
             f"{response.json()}"

dojo/tools/npm_audit_7_plus/parser.py

@@ -6,7 +6,7 @@
 
 logger = logging.getLogger(__name__)
 
-'''
+"""
 the npm audit json output depends on the params used. this parser
 accepts the formats for any of:
 
@@ -18,7 +18,7 @@
 as the report's meta block indicates, all top level keys
 are consiered a vulnerability and as much information as provided
 is added to each
-'''
+"""
 
 
 class NpmAudit7PlusParser:

dojo/user/validators.py

@@ -86,7 +86,7 @@ def validate(self, password, user=None):
 
     def get_help_text(self):
         return gettext('The password must contain at least 1 special character, '
-            + '''()[]{}|`~!@#$%^&*_-+=;:'",<>./?.''')
+            + """()[]{}|`~!@#$%^&*_-+=;:'",<>./?.""")
 
 
 class DojoCommonPasswordValidator(CommonPasswordValidator):