[qa] Switched to enforcing double quotes for Python code #451

Removed flag from  function to ebfirce Black enforces double quotes.

Fixes #451

Author: aoutifrak

openwisp-qa-check

@@ -145,7 +145,7 @@ runisort() {
 }
 
 runblack() {
-  black -S --check --diff --quiet . &&
+  black --check --diff --quiet . &&
     echo "SUCCESS: Black check successful!" ||
     {
       echoerr "ERROR: Black check failed! Hint: did you forget to run openwisp-qa-format?"

openwisp-qa-format

@@ -2,7 +2,7 @@
 set -e
 
 isort .
-black -S .
+black .
 docstrfmt --no-docstring-trailing-line --ignore-cache --line-length 74 .
 
 if which prettier > /dev/null; then

openwisp_utils/__init__.py

@@ -1,18 +1,18 @@
-VERSION = (1, 2, 0, 'alpha')
+VERSION = (1, 2, 0, "alpha")
 __version__ = VERSION  # alias
 
 
 def get_version():
-    version = '%s.%s' % (VERSION[0], VERSION[1])
+    version = "%s.%s" % (VERSION[0], VERSION[1])
     if VERSION[2]:
-        version = '%s.%s' % (version, VERSION[2])
-    if VERSION[3:] == ('alpha', 0):
-        version = '%s pre-alpha' % version
+        version = "%s.%s" % (version, VERSION[2])
+    if VERSION[3:] == ("alpha", 0):
+        version = "%s pre-alpha" % version
     else:
-        if VERSION[3] != 'final':
+        if VERSION[3] != "final":
             try:
                 rev = VERSION[4]
             except IndexError:
                 rev = 0
-            version = '%s%s%s' % (version, VERSION[3][0:1], rev)
+            version = "%s%s%s" % (version, VERSION[3][0:1], rev)
     return version

openwisp_utils/admin.py

@@ -8,7 +8,7 @@ class TimeReadonlyAdminMixin(object):
     """A mixin that automatically flags `created` and `modified` as readonly."""
 
     def __init__(self, *args, **kwargs):
-        self.readonly_fields += ('created', 'modified')
+        self.readonly_fields += ("created", "modified")
         super().__init__(*args, **kwargs)
 
 
@@ -26,8 +26,8 @@ def __init__(self, *args, **kwargs):
 
     def get_actions(self, request):
         actions = super().get_actions(request)
-        if 'delete_selected' in actions:  # pragma: no cover
-            del actions['delete_selected']
+        if "delete_selected" in actions:  # pragma: no cover
+            del actions["delete_selected"]
         return actions
 
     def has_add_permission(self, request):
@@ -47,8 +47,8 @@ def save_related(self, request, form, formsets, change):  # pragma: nocover
 
     def change_view(self, request, object_id, extra_context=None):
         extra_context = extra_context or {}
-        extra_context['show_save_and_continue'] = False
-        extra_context['show_save'] = False
+        extra_context["show_save_and_continue"] = False
+        extra_context["show_save"] = False
         return super().change_view(request, object_id, extra_context=extra_context)
 
 
@@ -77,15 +77,15 @@ class CopyableFieldsAdmin(ModelAdmin):
     """
 
     copyable_fields = ()
-    change_form_template = 'admin/change_form.html'
+    change_form_template = "admin/change_form.html"
 
     def _check_copyable_subset_fields(self, copyable_fields, fields):
         if not set(copyable_fields).issubset(fields):
             class_name = self.__class__.__name__
             raise CopyableFieldError(
                 (
-                    f'{copyable_fields} not in {class_name}.fields {fields}, '
-                    f'Check copyable_fields attribute of class {class_name}.'
+                    f"{copyable_fields} not in {class_name}.fields {fields}, "
+                    f"Check copyable_fields attribute of class {class_name}."
                 )
             )
 
@@ -111,18 +111,18 @@ def get_readonly_fields(self, request, obj=None):
             return tuple([*readonly_fields, *self.copyable_fields])
         return readonly_fields
 
-    def add_view(self, request, form_url='', extra_context=None):
+    def add_view(self, request, form_url="", extra_context=None):
         extra_context = extra_context or {}
-        extra_context['copyable_fields'] = []
+        extra_context["copyable_fields"] = []
         return super().add_view(
             request,
             form_url,
             extra_context=extra_context,
         )
 
-    def change_view(self, request, object_id, form_url='', extra_context=None):
+    def change_view(self, request, object_id, form_url="", extra_context=None):
         extra_context = extra_context or {}
-        extra_context['copyable_fields'] = list(self.copyable_fields)
+        extra_context["copyable_fields"] = list(self.copyable_fields)
         return super().change_view(
             request,
             object_id,
@@ -131,7 +131,7 @@ def change_view(self, request, object_id, form_url='', extra_context=None):
         )
 
     class Media:
-        js = ('admin/js/jquery.init.js', 'openwisp-utils/js/copyable.js')
+        js = ("admin/js/jquery.init.js", "openwisp-utils/js/copyable.js")
 
 
 class UUIDAdmin(CopyableFieldsAdmin):
@@ -142,12 +142,12 @@ class UUIDAdmin(CopyableFieldsAdmin):
     OpenWISP modules show `uuid` as the only copyable field.
     """
 
-    copyable_fields = ('uuid',)
+    copyable_fields = ("uuid",)
 
     def uuid(self, obj):
         return obj.pk
 
-    uuid.short_description = _('UUID')
+    uuid.short_description = _("UUID")
 
 
 class ReceiveUrlAdmin(ModelAdmin):
@@ -160,8 +160,8 @@ class ReceiveUrlAdmin(ModelAdmin):
     - receive_url_object_arg
     """
 
-    receive_url_querystring_arg = 'key'
-    receive_url_object_arg = 'pk'
+    receive_url_querystring_arg = "key"
+    receive_url_object_arg = "pk"
     receive_url_name = None
     receive_url_urlconf = None
     receive_url_baseurl = None
@@ -177,7 +177,7 @@ def change_view(self, request, *args, **kwargs):
     def receive_url(self, obj):
         """:param obj: Object for which the url is generated"""
         if self.receive_url_name is None:
-            raise ValueError('receive_url_name is not set up')
+            raise ValueError("receive_url_name is not set up")
         reverse_kwargs = {}
         if self.receive_url_object_arg:
             reverse_kwargs = {
@@ -190,9 +190,9 @@ def receive_url(self, obj):
         )
         baseurl = self.receive_url_baseurl
         if not baseurl:
-            baseurl = '{0}://{1}'.format(self.request.scheme, self.request.get_host())
+            baseurl = "{0}://{1}".format(self.request.scheme, self.request.get_host())
         if self.receive_url_querystring_arg:
-            url = '{0}{1}?{2}={3}'.format(
+            url = "{0}{1}?{2}={3}".format(
                 baseurl,
                 receive_path,
                 self.receive_url_querystring_arg,
@@ -201,17 +201,17 @@ def receive_url(self, obj):
         return url
 
     class Media:
-        js = ('admin/js/jquery.init.js', 'openwisp-utils/js/receive_url.js')
+        js = ("admin/js/jquery.init.js", "openwisp-utils/js/receive_url.js")
 
-    receive_url.short_description = _('URL')
+    receive_url.short_description = _("URL")
 
 
 class HelpTextStackedInline(StackedInline):
     help_text = None
-    template = 'admin/edit_inline/help_text_stacked.html'
+    template = "admin/edit_inline/help_text_stacked.html"
 
     class Media:
-        css = {'all': ['admin/css/help-text-stacked.css']}
+        css = {"all": ["admin/css/help-text-stacked.css"]}
 
     def get_formset(self, request, obj=None, **kwargs):
         formset = super().get_formset(request, obj, **kwargs)

openwisp_utils/admin_theme/admin.py

@@ -21,12 +21,12 @@
 
 class OpenwispAdminSite(admin.AdminSite):
     # <title>
-    site_title = getattr(settings, 'OPENWISP_ADMIN_SITE_TITLE', 'OpenWISP Admin')
+    site_title = getattr(settings, "OPENWISP_ADMIN_SITE_TITLE", "OpenWISP Admin")
     # h1 text
-    site_header = getattr(settings, 'OPENWISP_ADMIN_SITE_HEADER', 'OpenWISP')
+    site_header = getattr(settings, "OPENWISP_ADMIN_SITE_HEADER", "OpenWISP")
     # text at the top of the admin index page
     index_title = _(
-        getattr(settings, 'OPENWISP_ADMIN_INDEX_TITLE', 'Network Administration')
+        getattr(settings, "OPENWISP_ADMIN_INDEX_TITLE", "Network Administration")
     )
     enable_nav_sidebar = False
     metric_collection = MetricCollectionAdminSiteHelper
@@ -35,32 +35,32 @@ def index(self, request, extra_context=None):
         if app_settings.ADMIN_DASHBOARD_ENABLED:
             context = get_dashboard_context(request)
         else:
-            context = {'dashboard_enabled': False}
+            context = {"dashboard_enabled": False}
         self.metric_collection.show_consent_info(request)
         return super().index(request, extra_context=context)
 
     def openwisp_info(self, request, *args, **kwargs):
         context = {
-            'enabled_openwisp_modules': get_enabled_openwisp_modules(),
-            'system_info': get_os_details(),
-            'openwisp_version': get_openwisp_version(),
-            'title': _('System Information'),
-            'site_title': self.site_title,
+            "enabled_openwisp_modules": get_enabled_openwisp_modules(),
+            "system_info": get_os_details(),
+            "openwisp_version": get_openwisp_version(),
+            "title": _("System Information"),
+            "site_title": self.site_title,
         }
         self.metric_collection.manage_form(request, context)
-        return render(request, 'admin/openwisp_info.html', context)
+        return render(request, "admin/openwisp_info.html", context)
 
     def get_urls(self):
         autocomplete_view = import_string(app_settings.AUTOCOMPLETE_FILTER_VIEW)
         return [
             path(
-                'ow-auto-filter/',
+                "ow-auto-filter/",
                 self.admin_view(autocomplete_view.as_view(admin_site=self)),
-                name='ow-auto-filter',
+                name="ow-auto-filter",
             ),
             path(
-                'openwisp-system-info/',
+                "openwisp-system-info/",
                 self.admin_view(self.openwisp_info),
-                name='ow-info',
+                name="ow-info",
             ),
         ] + super().get_urls()

openwisp_utils/admin_theme/apps.py

@@ -34,8 +34,8 @@ def _staticfy(value):
 
 
 class OpenWispAdminThemeConfig(AppConfig):
-    app_label = 'openwisp_admin'
-    name = 'openwisp_utils.admin_theme'
+    app_label = "openwisp_admin"
+    name = "openwisp_utils.admin_theme"
 
     def ready(self):
         admin_theme_settings_checks(self)
@@ -53,28 +53,28 @@ def register_menu_groups(self):
         # register dashboard item
         register_menu_group(
             position=10,
-            config={'label': _('Home'), 'url': '/admin', 'icon': 'ow-dashboard-icon'},
+            config={"label": _("Home"), "url": "/admin", "icon": "ow-dashboard-icon"},
         )
         register_menu_group(
             position=899,
             config={
-                'label': _('System info'),
-                'url': '/admin/openwisp-system-info/',
-                'icon': 'ow-info-icon',
+                "label": _("System info"),
+                "url": "/admin/openwisp-system-info/",
+                "icon": "ow-info-icon",
             },
         )
 
     def modify_admin_theme_settings_links(self):
         link_files = []
         for link_file in theme.THEME_LINKS:
-            href = link_file['href']
-            href = href.replace('/static/', '')
-            link_file['href'] = _staticfy(href)
+            href = link_file["href"]
+            href = href.replace("/static/", "")
+            link_file["href"] = _staticfy(href)
             link_files.append(link_file)
 
         js_files = []
         for js_file in theme.THEME_JS:
-            js_file = js_file.replace('/static/', '')
+            js_file = js_file.replace("/static/", "")
             js_files.append(_staticfy(js_file))
 
         theme.THEME_LINKS = link_files

openwisp_utils/admin_theme/checks.py

@@ -11,16 +11,16 @@ def admin_theme_settings_checks(app_configs, **kwargs):
         if not isinstance(item, dict):
             links_error = True
             break
-        if any(['rel' not in item, 'type' not in item, 'href' not in item]):
+        if any(["rel" not in item, "type" not in item, "href" not in item]):
             links_error = True
             break
     if links_error:
         errors.append(
             Error(
-                msg='Invalid item: {}'.format(item),
-                hint='OPENWISP_ADMIN_THEME_LINKS should be a list of dictionaries, '
-                'each dictionary must contain the following keys: rel, type and href.',
-                obj='OPENWISP_ADMIN_THEME_LINKS',
+                msg="Invalid item: {}".format(item),
+                hint="OPENWISP_ADMIN_THEME_LINKS should be a list of dictionaries, "
+                "each dictionary must contain the following keys: rel, type and href.",
+                obj="OPENWISP_ADMIN_THEME_LINKS",
             )
         )
 
@@ -30,9 +30,9 @@ def admin_theme_settings_checks(app_configs, **kwargs):
     if not isinstance(app_settings.OPENWISP_ADMIN_THEME_JS, list) or not is_list_of_str:
         errors.append(
             Error(
-                msg='Improperly Configured',
-                hint='OPENWISP_ADMIN_THEME_JS should be a list of strings.',
-                obj='OPENWISP_ADMIN_THEME_JS',
+                msg="Improperly Configured",
+                hint="OPENWISP_ADMIN_THEME_JS should be a list of strings.",
+                obj="OPENWISP_ADMIN_THEME_JS",
             )
         )
     return errors

openwisp_utils/admin_theme/context_processor.py

@@ -11,45 +11,45 @@
 
 def menu_groups(request):
     menu = build_menu(request)
-    if menu and sys.argv[1:2] != ['test']:
+    if menu and sys.argv[1:2] != ["test"]:
         logging.warning(
-            'register_menu_items is deprecated. Please update to use register_menu_group'
+            "register_menu_items is deprecated. Please update to use register_menu_group"
         )
     menu_groups = build_menu_groups(request)
     return {
-        'openwisp_menu_items': menu,
-        'openwisp_menu_groups': menu_groups,
-        'show_userlinks_block': getattr(
-            settings, 'OPENWISP_ADMIN_SHOW_USERLINKS_BLOCK', False
+        "openwisp_menu_items": menu,
+        "openwisp_menu_groups": menu_groups,
+        "show_userlinks_block": getattr(
+            settings, "OPENWISP_ADMIN_SHOW_USERLINKS_BLOCK", False
         ),
     }
 
 
 def build_menu(request):
-    default_items = getattr(settings, 'OPENWISP_DEFAULT_ADMIN_MENU_ITEMS', [])
-    custom_items = getattr(settings, 'OPENWISP_ADMIN_MENU_ITEMS', [])
+    default_items = getattr(settings, "OPENWISP_DEFAULT_ADMIN_MENU_ITEMS", [])
+    custom_items = getattr(settings, "OPENWISP_ADMIN_MENU_ITEMS", [])
     items = custom_items or default_items
     menu = []
     # loop over each item to build the menu
     # and check user has permission to see each item
     for item in items:
-        app_label, model = item['model'].split('.')
+        app_label, model = item["model"].split(".")
         model_class = registry.apps.get_model(app_label, model)
         model_label = model.lower()
-        url = reverse(f'admin:{app_label}_{model_label}_changelist')
-        label = item.get('label', model_class._meta.verbose_name_plural)
-        view_perm = f'{app_label}.view_{model_label}'
-        change_perm = f'{app_label}.change_{model_label}'
+        url = reverse(f"admin:{app_label}_{model_label}_changelist")
+        label = item.get("label", model_class._meta.verbose_name_plural)
+        view_perm = f"{app_label}.view_{model_label}"
+        change_perm = f"{app_label}.change_{model_label}"
         user = request.user
         if user.has_perm(view_perm) or user.has_perm(change_perm):
-            menu.append({'url': url, 'label': label, 'class': model_label})
+            menu.append({"url": url, "label": label, "class": model_label})
     return menu
 
 
 def admin_theme_settings(request):
     return {
-        'OPENWISP_ADMIN_THEME_LINKS': theme.THEME_LINKS,
-        'OPENWISP_ADMIN_THEME_JS': theme.THEME_JS,
+        "OPENWISP_ADMIN_THEME_LINKS": theme.THEME_LINKS,
+        "OPENWISP_ADMIN_THEME_JS": theme.THEME_JS,
     }