Solved rules (#518)

raffaellasuardini · marksweb · web-flow · commit 7b7e5e54ae19 · 2024-02-20T20:10:22.000Z
* fix ruff rule I001

* fix ruff rule E501

* fix ruff rule C408

* removed extend-ignore list from pyproject.toml

* chore: ruff reformatted

* chore: trim trailing whitespace

* chore: create extend-exclude section

* Add SVG to ruff exclude

---------

Co-authored-by: Mark Walker &lt;theshow@gmail.com&gt;
diff --git a/djangocms_admin_style/__init__.py b/djangocms_admin_style/__init__.py
@@ -3,7 +3,8 @@
 
 Release logic:
  1. Increase version number (change __version__ below).
- 2. Ensure the static bundle is upto date with ``nvm use && gulp icons && gulp sass bundle``
+ 2. Ensure the static bundle is upto date with
+   ``nvm use && gulp icons && gulp sass bundle``
  3. Assure that all changes have been documented in CHANGELOG.rst.
  4. In setup.py check that
    - versions from all third party packages are pinned in ``REQUIREMENTS``.
@@ -16,4 +17,4 @@
 10. Publish the release when ready
 11. Github actions will publish the new package to pypi
 """
-__version__ = '3.3.0'
+__version__ = "3.3.0"
diff --git a/djangocms_admin_style/locale/de/LC_MESSAGES/django.po b/djangocms_admin_style/locale/de/LC_MESSAGES/django.po
@@ -1,7 +1,7 @@
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
-# 
+#
 # Translators:
 # Translators:
 # Angelo Dini <finalangeljp@hotmail.com>, 2016
diff --git a/djangocms_admin_style/locale/es/LC_MESSAGES/django.po b/djangocms_admin_style/locale/es/LC_MESSAGES/django.po
@@ -1,7 +1,7 @@
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
-# 
+#
 # Translators:
 # Translators:
 # Paulo <paulo.alvarado@divio.ch>, 2015
diff --git a/djangocms_admin_style/locale/fr/LC_MESSAGES/django.po b/djangocms_admin_style/locale/fr/LC_MESSAGES/django.po
@@ -1,7 +1,7 @@
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
-# 
+#
 # Translators:
 # Translators:
 # Frigory33 <chironsylvain@orange.fr>, 2016
diff --git a/djangocms_admin_style/locale/it/LC_MESSAGES/django.po b/djangocms_admin_style/locale/it/LC_MESSAGES/django.po
@@ -1,7 +1,7 @@
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
-# 
+#
 # Translators:
 # Translators:
 # yakky <i.spalletti@nephila.it>, 2015
diff --git a/djangocms_admin_style/locale/lt/LC_MESSAGES/django.po b/djangocms_admin_style/locale/lt/LC_MESSAGES/django.po
@@ -1,7 +1,7 @@
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
-# 
+#
 # Translators:
 # Translators:
 # Matas Dailyda <matas@dailyda.com>, 2015
diff --git a/djangocms_admin_style/locale/ru/LC_MESSAGES/django.po b/djangocms_admin_style/locale/ru/LC_MESSAGES/django.po
@@ -1,7 +1,7 @@
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
-# 
+#
 # Translators:
 # Translators:
 # Mikhail Kolesnik <mike@openbunker.org>, 2015
diff --git a/djangocms_admin_style/locale/uk/LC_MESSAGES/django.po b/djangocms_admin_style/locale/uk/LC_MESSAGES/django.po
@@ -1,7 +1,7 @@
 # SOME DESCRIPTIVE TITLE.
 # Copyright (C) YEAR THE PACKAGE'S COPYRIGHT HOLDER
 # This file is distributed under the same license as the PACKAGE package.
-# 
+#
 # Translators:
 # Translators:
 # Mikhail Kolesnik <mike@openbunker.org>, 2015
diff --git a/djangocms_admin_style/sass/libs/html5-boilerplate/_reset.scss b/djangocms_admin_style/sass/libs/html5-boilerplate/_reset.scss
@@ -115,7 +115,7 @@
 
     mark {
         color: $black;
-        font-weight: bold; 
+        font-weight: bold;
         font-style: italic;
         background-color: #ff9;
     }
diff --git a/djangocms_admin_style/static/djangocms_admin_style/fonts/django-admin-icons.svg b/djangocms_admin_style/static/djangocms_admin_style/fonts/django-admin-icons.svg
@@ -10,8 +10,8 @@ This is a custom SVG font generated by IcoMoon.
 <font-face units-per-em="512" ascent="480" descent="-32" />
 <missing-glyph horiz-adv-x="512" />
 <glyph unicode="&#x21;" d="M 488.00,456.00c-32.00,32.00-64.00,32.00-96.00,0.00l-8.00-8.00l 96.00-96.00l 8.00,8.00C 520.00,392.00, 520.00,424.00, 488.00,456.00zM 32.00,96.00L0.00-32.00l 128.00,32.00l 320.00,320.00l-96.00,96.00L 32.00,96.00z M 128.00,64.00l-32.00,32.00l 256.00,256.00l 32.00-32.00L 128.00,64.00z" />
-<glyph unicode="&#x22;" d="M 496.00,288.00L 320.00,288.00 L 320.00,464.00 c0.00,8.836-7.164,16.00-16.00,16.00l-96.00,0.00 c-8.836,0.00-16.00-7.164-16.00-16.00l0.00-176.00 L 16.00,288.00 c-8.836,0.00-16.00-7.164-16.00-16.00l0.00-96.00 
-	c0.00-8.836, 7.164-16.00, 16.00-16.00l 176.00,0.00 l0.00-176.00 c0.00-8.836, 7.164-16.00, 16.00-16.00l 96.00,0.00 c 8.836,0.00, 16.00,7.164, 16.00,16.00L 320.00,160.00 l 176.00,0.00 c 8.836,0.00, 16.00,7.164, 16.00,16.00l0.00,96.00 
+<glyph unicode="&#x22;" d="M 496.00,288.00L 320.00,288.00 L 320.00,464.00 c0.00,8.836-7.164,16.00-16.00,16.00l-96.00,0.00 c-8.836,0.00-16.00-7.164-16.00-16.00l0.00-176.00 L 16.00,288.00 c-8.836,0.00-16.00-7.164-16.00-16.00l0.00-96.00
+	c0.00-8.836, 7.164-16.00, 16.00-16.00l 176.00,0.00 l0.00-176.00 c0.00-8.836, 7.164-16.00, 16.00-16.00l 96.00,0.00 c 8.836,0.00, 16.00,7.164, 16.00,16.00L 320.00,160.00 l 176.00,0.00 c 8.836,0.00, 16.00,7.164, 16.00,16.00l0.00,96.00
 	C 512.00,280.836, 504.836,288.00, 496.00,288.00z" />
 <glyph unicode="&#x23;" d="M 449.077,10.754l-114.54,168.305c 65.459,51.835, 83.963,145.677, 39.835,219.126
 		C 326.445,477.959, 222.559,503.857, 142.793,455.94C 63.028,408.007, 37.131,304.124, 85.054,224.357
@@ -33,12 +33,12 @@ This is a custom SVG font generated by IcoMoon.
 	 M 128.00,224.00l 128.00,128.00l0.00-96.00 l 128.00,0.00 l0.00-64.00 l-128.00,0.00 l0.00-96.00 L 128.00,224.00z" />
 <glyph unicode="&#x26;" d="M0.00,224.00c0.00-141.376, 114.624-256.00, 256.00-256.00c 141.392,0.00, 256.00,114.624, 256.00,256.00c0.00,141.392-114.608,256.00-256.00,256.00C 114.624,480.00,0.00,365.392,0.00,224.00z M 384.00,224.00
 	l-128.00-128.00l0.00,96.00 L 128.00,192.00 l0.00,64.00 l 128.00,0.00 L 256.00,352.00 L 384.00,224.00z" />
-<glyph unicode="&#x27;" d="M 224.00,288.00L 416.00,288.00L 416.00,256.00L 224.00,256.00zM 224.00,224.00L 416.00,224.00L 416.00,192.00L 224.00,192.00zM 224.00,160.00L 416.00,160.00L 416.00,128.00L 224.00,128.00zM 224.00,96.00L 352.00,96.00L 352.00,64.00L 224.00,64.00zM 480.00,384.00l-96.00,0.00 L 384.00,448.00 c0.00,17.60-14.40,32.00-32.00,32.00L 32.00,480.00 C 14.40,480.00,0.00,465.60,0.00,448.00l0.00-352.00 c0.00-17.60, 14.40-32.00, 32.00-32.00l 96.00,0.00 l0.00-64.00 c0.00-17.60, 14.40-32.00, 32.00-32.00l 320.00,0.00 
-		c 17.60,0.00, 32.00,14.40, 32.00,32.00L 512.00,352.00 C 512.00,369.60, 497.60,384.00, 480.00,384.00z M 128.00,352.00l0.00-240.00 L 48.00,112.00 L 48.00,432.00 l 288.00,0.00 l0.00-48.00 L 160.00,384.00 C 142.40,384.00, 128.00,369.60, 128.00,352.00z M 464.00,16.00L 176.00,16.00 
+<glyph unicode="&#x27;" d="M 224.00,288.00L 416.00,288.00L 416.00,256.00L 224.00,256.00zM 224.00,224.00L 416.00,224.00L 416.00,192.00L 224.00,192.00zM 224.00,160.00L 416.00,160.00L 416.00,128.00L 224.00,128.00zM 224.00,96.00L 352.00,96.00L 352.00,64.00L 224.00,64.00zM 480.00,384.00l-96.00,0.00 L 384.00,448.00 c0.00,17.60-14.40,32.00-32.00,32.00L 32.00,480.00 C 14.40,480.00,0.00,465.60,0.00,448.00l0.00-352.00 c0.00-17.60, 14.40-32.00, 32.00-32.00l 96.00,0.00 l0.00-64.00 c0.00-17.60, 14.40-32.00, 32.00-32.00l 320.00,0.00
+		c 17.60,0.00, 32.00,14.40, 32.00,32.00L 512.00,352.00 C 512.00,369.60, 497.60,384.00, 480.00,384.00z M 128.00,352.00l0.00-240.00 L 48.00,112.00 L 48.00,432.00 l 288.00,0.00 l0.00-48.00 L 160.00,384.00 C 142.40,384.00, 128.00,369.60, 128.00,352.00z M 464.00,16.00L 176.00,16.00
 		L 176.00,336.00 l 288.00,0.00 L 464.00,16.00 z" />
 <glyph unicode="&#x28;" d="M 512.00,192.00L 416.00,288.00L 416.00,384.00L 352.00,384.00L 352.00,352.00L 256.00,448.00L0.00,192.00L 64.00,192.00L 64.00,0.00L 224.00,0.00L 224.00,128.00L 288.00,128.00L 288.00,0.00L 448.00,0.00L 448.00,192.00 	z" />
 <glyph unicode="&#x29;" d="M 128.00,320.00A128.00,128.00 6300.00 1,0 384.00,320A128.00,128.00 6300.00 1,0 128.00,320zM 384.00,160.00L 128.00,160.00 C 57.308,160.00,0.00,102.691,0.00,32.00l0.00-32.00 l 4.033,0.00 l 503.934,0.00 L 512.00,0.00 l0.00,32.00 C 512.00,102.691, 454.692,160.00, 384.00,160.00z" />
-<glyph unicode="&#x2a;" d="M 432.00-32.00L 80.00-32.00 c-8.848,0.00-16.00,7.152-16.00,16.00L 64.00,320.00 l 16.00,0.00 l0.00,0.00l 128.00,0.00 c 8.848,0.00, 16.00,7.168, 16.00,16.00L 224.00,416.00 L 224.00,464.00 L 224.00,480.00 l 208.00,0.00 
+<glyph unicode="&#x2a;" d="M 432.00-32.00L 80.00-32.00 c-8.848,0.00-16.00,7.152-16.00,16.00L 64.00,320.00 l 16.00,0.00 l0.00,0.00l 128.00,0.00 c 8.848,0.00, 16.00,7.168, 16.00,16.00L 224.00,416.00 L 224.00,464.00 L 224.00,480.00 l 208.00,0.00
 	c 8.848,0.00, 16.00-7.168, 16.00-16.00l0.00-480.00 C 448.00-24.848, 440.848-32.00, 432.00-32.00z M 192.00,480.00l0.00-64.00 l0.00-64.00 L 64.00,352.00 L 192.00,480.00z" />
 <glyph unicode="&#x2b;" d="M 325.608,214.818L 512.00,86.264L 512.00,382.211 	zM0.00,382.211L0.00,86.264L 186.388,214.836 	zM 256.00,152.309L 211.499,192.264L0.00,64.00L 512.00,64.00L 300.495,192.264 	zM 496.64,384.00L 15.36,384.00L 256.00,203.074 	z" />
 <glyph unicode="&#x2c;" d="M 160.00,288.00L 224.00,288.00L 224.00,224.00L 160.00,224.00zM 256.00,288.00L 320.00,288.00L 320.00,224.00L 256.00,224.00zM 352.00,288.00L 416.00,288.00L 416.00,224.00L 352.00,224.00zM 64.00,96.00L 128.00,96.00L 128.00,32.00L 64.00,32.00zM 160.00,96.00L 224.00,96.00L 224.00,32.00L 160.00,32.00zM 256.00,96.00L 320.00,96.00L 320.00,32.00L 256.00,32.00zM 160.00,192.00L 224.00,192.00L 224.00,128.00L 160.00,128.00zM 256.00,192.00L 320.00,192.00L 320.00,128.00L 256.00,128.00zM 352.00,192.00L 416.00,192.00L 416.00,128.00L 352.00,128.00zM 64.00,192.00L 128.00,192.00L 128.00,128.00L 64.00,128.00zM 416.00,480.00l0.00-32.00 l-64.00,0.00 L 352.00,480.00 L 128.00,480.00 l0.00-32.00 L 64.00,448.00 L 64.00,480.00 L0.00,480.00 l0.00-512.00 l 480.00,0.00 L 480.00,480.00 L 416.00,480.00 z M 448.00,0.00L 32.00,0.00 L 32.00,352.00 l 416.00,0.00 L 448.00,0.00 z" />
diff --git a/djangocms_admin_style/templates/admin/inc/branding.html b/djangocms_admin_style/templates/admin/inc/branding.html
@@ -25,7 +25,7 @@ <h1>{{ site_header|default:_('Django Administration') }}</h1>
             {% endif %}
             {% if user.is_authenticated %}
                 <li>
-                    <form method="POST" action="{% url 'admin:logout' %}"> 
+                    <form method="POST" action="{% url 'admin:logout' %}">
                         {% csrf_token %}
                         <button type="submit">
                             <b>{% trans 'Log out' %} {% firstof user.get_short_name user.get_username %}</b>
diff --git a/djangocms_admin_style/templatetags/admin_style_tags.py b/djangocms_admin_style/templatetags/admin_style_tags.py
@@ -5,25 +5,24 @@
 from django.template.loader import render_to_string
 from django.utils.translation import gettext
 
-
 # We follow the Semantic versioning convention
 # minor - Refers to the minor release track (3.x.1)
 # patch - Refers to the patch release track (3.4.x)
-VALID_VERSION_CHECK_TYPES = ('minor', 'patch')
+VALID_VERSION_CHECK_TYPES = ("minor", "patch")
 
 register = template.Library()
 
 
 @register.simple_tag(takes_context=True)
 def current_site_name(context):
-    request = context.get('request')
+    request = context.get("request")
 
     try:
         site_name = get_current_site(request).name
     except AttributeError:
         # This happens if request is None
         # and sites framework is not in INSTALLED_APPS
-        site_name = gettext('my site')
+        site_name = gettext("my site")
     return conditional_escape(site_name)
 
 
@@ -35,22 +34,22 @@ def render_update_notification(context):
         check_type = None
         notifications_enabled = False
     else:
-        check_type = getattr(settings, 'CMS_UPDATE_CHECK_TYPE', 'patch')
-        notifications_enabled = getattr(settings, 'CMS_ENABLE_UPDATE_CHECK', True)
+        check_type = getattr(settings, "CMS_UPDATE_CHECK_TYPE", "patch")
+        notifications_enabled = getattr(settings, "CMS_ENABLE_UPDATE_CHECK", True)
 
-    request = context.get('request')
+    request = context.get("request")
 
     try:
-        index_page = request.resolver_match.url_name == 'index'
+        index_page = request.resolver_match.url_name == "index"
     except AttributeError:
         notifications_enabled = False
     else:
         notifications_enabled = index_page and notifications_enabled
 
     if notifications_enabled and check_type in VALID_VERSION_CHECK_TYPES:
         context = {
-            'cms_version': cms.__version__,
-            'cms_version_check_type': check_type,
+            "cms_version": cms.__version__,
+            "cms_version_check_type": check_type,
         }
-        return render_to_string('admin/inc/cms_upgrade_notification.html', context)
-    return ''
+        return render_to_string("admin/inc/cms_upgrade_notification.html", context)
+    return ""
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,4 +1,15 @@
 [tool.ruff]
+line-length = 119
+
+extend-exclude = [
+  ".ruff_cache",
+  ".env",
+  ".venv",
+  ".po",
+  ".svg",
+]
+
+[tool.ruff.lint]
 select=[
   "E",  # pycodestyle errors
   "W",  # pycodestyle warnings
@@ -11,10 +22,3 @@ select=[
   "PLW", # pylint warning
   "UP", # pyupgrade
 ]
-
-extend-ignore = [
-    # TODO fix separately
-    "E501", # line too long
-    "I001", # import block unsorted
-    "C408", # unnecessary dict call
-]
diff --git a/setup.py b/setup.py
@@ -5,68 +5,67 @@
 
 from djangocms_admin_style import __version__
 
-
 REQUIREMENTS = [
     "Django",
 ]
 
 
 CLASSIFIERS = [
-    'Development Status :: 5 - Production/Stable',
-    'Environment :: Web Environment',
-    'Intended Audience :: Developers',
-    'License :: OSI Approved :: BSD License',
-    'Operating System :: OS Independent',
-    'Programming Language :: Python',
-    'Programming Language :: Python :: 3',
-    'Programming Language :: Python :: 3.7',
-    'Programming Language :: Python :: 3.8',
-    'Programming Language :: Python :: 3.9',
-    'Programming Language :: Python :: 3.10',
-    'Programming Language :: Python :: 3.11',
-    'Framework :: Django',
-    'Framework :: Django :: 2.2',
-    'Framework :: Django :: 3.1',
-    'Framework :: Django :: 3.2',
-    'Framework :: Django :: 4.0',
-    'Framework :: Django :: 4.1',
-    'Framework :: Django :: 4.2',
-    'Framework :: Django :: 5.0',
-    'Framework :: Django CMS',
-    'Framework :: Django CMS :: 3.6',
-    'Framework :: Django CMS :: 3.7',
-    'Framework :: Django CMS :: 3.8',
-    'Framework :: Django CMS :: 3.8',
-    'Framework :: Django CMS :: 3.9',
-    'Framework :: Django CMS :: 3.10',
-    'Framework :: Django CMS :: 3.11',
-    'Framework :: Django CMS :: 4.0',
-    'Framework :: Django CMS :: 4.1',
-    'Topic :: Internet :: WWW/HTTP',
-    'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
-    'Topic :: Software Development',
-    'Topic :: Software Development :: Libraries',
+    "Development Status :: 5 - Production/Stable",
+    "Environment :: Web Environment",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: BSD License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.7",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Framework :: Django",
+    "Framework :: Django :: 2.2",
+    "Framework :: Django :: 3.1",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4.0",
+    "Framework :: Django :: 4.1",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+    "Framework :: Django CMS",
+    "Framework :: Django CMS :: 3.6",
+    "Framework :: Django CMS :: 3.7",
+    "Framework :: Django CMS :: 3.8",
+    "Framework :: Django CMS :: 3.8",
+    "Framework :: Django CMS :: 3.9",
+    "Framework :: Django CMS :: 3.10",
+    "Framework :: Django CMS :: 3.11",
+    "Framework :: Django CMS :: 4.0",
+    "Framework :: Django CMS :: 4.1",
+    "Topic :: Internet :: WWW/HTTP",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+    "Topic :: Software Development",
+    "Topic :: Software Development :: Libraries",
 ]
 
 this_directory = Path(__file__).parent
 long_description = (this_directory / "README.rst").read_text()
 
 setup(
-    name='djangocms-admin-style',
+    name="djangocms-admin-style",
     version=__version__,
-    author='Divio AG',
-    author_email='info@divio.ch',
-    maintainer='Django CMS Association and contributors',
-    maintainer_email='info@django-cms.org',
-    url='https://github.com/django-cms/djangocms-admin-style',
-    license='BSD-3-Clause',
-    description='Adds pretty CSS styles for the django CMS admin interface.',
+    author="Divio AG",
+    author_email="info@divio.ch",
+    maintainer="Django CMS Association and contributors",
+    maintainer_email="info@django-cms.org",
+    url="https://github.com/django-cms/djangocms-admin-style",
+    license="BSD-3-Clause",
+    description="Adds pretty CSS styles for the django CMS admin interface.",
     long_description=long_description,
-    packages=find_packages(exclude=['preview', 'tests']),
-    python_requires='>=3.7',
+    packages=find_packages(exclude=["preview", "tests"]),
+    python_requires=">=3.7",
     include_package_data=True,
     zip_safe=False,
     install_requires=REQUIREMENTS,
     classifiers=CLASSIFIERS,
-    test_suite='tests.settings.run',
+    test_suite="tests.settings.run",
 )
diff --git a/tests/settings-docker.py b/tests/settings-docker.py
diff --git a/tests/settings.py b/tests/settings.py
diff --git a/tests/test_migrations.py b/tests/test_migrations.py
diff --git a/tests/test_templatetags.py b/tests/test_templatetags.py

Original file line number	Diff line number	Diff line change
`@@ -115,7 +115,7 @@`
`115`	`115`
`116`	`116`	`mark {`
`117`	`117`	`color: $black;`
`118`		`- font-weight: bold;`
	`118`	`+ font-weight: bold;`
`119`	`119`	`font-style: italic;`
`120`	`120`	`background-color: #ff9;`
`121`	`121`	`}`