Add ruff rules A,B,C4,ISC,PGH,RET,RUF,S,SIM,SLF

.pre-commit-config.yaml

@@ -6,6 +6,6 @@ repos:
     -   id: trailing-whitespace
 
 -   repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.8.4
+    rev: v0.9.7
     hooks:
       - id: ruff

docs/conf.py

@@ -40,7 +40,7 @@
 
 # General information about the project.
 project = 'django-waffle'
-copyright = '2012-2018, James Socol'
+copyright = '2012-2018, James Socol'  # noqa: A001
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

pyproject.toml

@@ -71,9 +71,12 @@ target-version = "py38"
 
 [tool.ruff.lint]
 select = [
+  "A",      # flake8-builtins
   "AIR",    # Airflow
   "ASYNC",  # flake8-async
+  "B",      # flake8-bugbear
   "BLE",    # flake8-blind-except
+  "C4",     # flake8-comprehensions
   "C90",    # McCabe cyclomatic complexity
   "DJ",     # flake8-django
   "DTZ",    # flake8-datetimez
@@ -85,12 +88,19 @@ select = [
   "ICN",    # flake8-import-conventions
   "INP",    # flake8-no-pep420
   "INT",    # flake8-gettext
+  "ISC",    # flake8-implicit-str-concat
   "NPY",    # NumPy-specific rules
   "PD",     # pandas-vet
+  "PGH",    # pygrep-hooks
   "PIE",    # flake8-pie
   "PL",     # Pylint
   "PYI",    # flake8-pyi
+  "RET",    # flake8-return
   "RSE",    # flake8-raise
+  "RUF",    # Ruff-specific rules
+  "S",      # flake8-bandit
+  "SIM",    # flake8-simplify
+  "SLF",    # flake8-self
   "SLOT",   # flake8-slots
   "T10",    # flake8-debugger
   "T20",    # flake8-print
@@ -99,32 +109,22 @@ select = [
   "UP",     # pyupgrade
   "W",      # pycodestyle warnings
   "YTT",    # flake8-2020
-  # "A",    # flake8-builtins
   # "ANN",  # flake8-annotations
   # "ARG",  # flake8-unused-arguments
-  # "B",    # flake8-bugbear
-  # "C4",   # flake8-comprehensions
   # "COM",  # flake8-commas
-  # "CPY",    # flake8-copyright
+  # "CPY",  # flake8-copyright
   # "D",    # pydocstyle
   # "EM",   # flake8-errmsg
   # "ERA",  # eradicate
   # "EXE",  # flake8-executable
   # "FA",   # flake8-future-annotations
   # "FBT",  # flake8-boolean-trap
   # "I",    # isort
-  # "ISC",  # flake8-implicit-str-concat
   # "N",    # pep8-naming
   # "PERF", # Perflint
-  # "PGH",  # pygrep-hooks
   # "PT",   # flake8-pytest-style
   # "PTH",  # flake8-use-pathlib
   # "Q",    # flake8-quotes
-  # "RET",  # flake8-return
-  # "RUF",  # Ruff-specific rules
-  # "S",    # flake8-bandit
-  # "SIM",  # flake8-simplify
-  # "SLF",  # flake8-self
   # "TCH",  # flake8-type-checking
   # "TRY",  # tryceratops
 ]
@@ -135,14 +135,20 @@ exclude = [
     "*/migrations/*",
     "docs",
 ]
-ignore = ["F401"]
+ignore = [
+  "F401",    # Imported but unused
+  "ISC002",  # Implicit string concatenation may conflict with black and ruff format
+  "S101",    # Use of assert detected
+]
 
 [tool.ruff.lint.mccabe]
 max-complexity = 23
 
 [tool.ruff.lint.per-file-ignores]
 "docs/conf.py" = ["INP001"]
 "test_app/models.py" = ["DJ008"]  # FIXME
+"waffle/admin.py" = ["SLF001"]  # FIXME
+"waffle/jinja.py" = [ "PGH003" ]  # FIXME
 "waffle/models.py" = ["DJ012", "PYI019"]  # FIXME
 
 [tool.ruff.lint.pylint]

test_app/models.py

@@ -60,6 +60,8 @@ def is_active_for_user(self, user):
             company_ids = self._get_company_ids()
             if user.company_id in company_ids:
                 return True
+            return None
+        return None
 
     def _get_company_ids(self):
         cache_key = keyfmt(

test_settings.py

@@ -20,7 +20,7 @@
 SITE_ID = 1
 USE_I18N = False
 
-SECRET_KEY = 'foobar'
+SECRET_KEY = 'foobar'  # noqa: S105
 
 DATABASES = {
     'default': {

waffle/__init__.py

@@ -62,9 +62,9 @@ def get_waffle_model(setting_name: str) -> (
 
     try:
         return django_apps.get_model(flag_model_name)
-    except ValueError:
-        raise ImproperlyConfigured(f"WAFFLE_{setting_name} must be of the form 'app_label.model_name'")
-    except LookupError:
+    except ValueError as ve:
+        raise ImproperlyConfigured(f"WAFFLE_{setting_name} must be of the form 'app_label.model_name'") from ve
+    except LookupError as le:
         raise ImproperlyConfigured(
             f"WAFFLE_{setting_name} refers to model '{flag_model_name}' that has not been installed"
-        )
+        ) from le

waffle/admin.py

@@ -1,6 +1,6 @@
 from __future__ import annotations
 
-from typing import Any
+from typing import Any, ClassVar
 
 from django.contrib import admin
 from django.contrib.admin.models import LogEntry, CHANGE, DELETION
@@ -90,7 +90,7 @@ def label_and_url_for_value(self, values: Any) -> tuple[str, str]:
 
 
 class FlagAdmin(BaseAdmin):
-    actions = [enable_for_all, disable_for_all, delete_individually]
+    actions: ClassVar = [enable_for_all, disable_for_all, delete_individually]
     list_display = ('name', 'note', 'everyone', 'percent', 'superusers',
                     'staff', 'authenticated', 'languages')
     list_filter = ('everyone', 'superusers', 'staff', 'authenticated')
@@ -131,14 +131,14 @@ def disable_switches(ma, request, qs):
 
 
 class SwitchAdmin(BaseAdmin):
-    actions = [enable_switches, disable_switches, delete_individually]
+    actions: ClassVar = [enable_switches, disable_switches, delete_individually]
     list_display = ('name', 'active', 'note', 'created', 'modified')
     list_filter = ('active',)
     ordering = ('-id',)
 
 
 class SampleAdmin(BaseAdmin):
-    actions = [delete_individually]
+    actions: ClassVar = [delete_individually]
     list_display = ('name', 'percent', 'note', 'created', 'modified')
     ordering = ('-id',)
 

waffle/apps.py

@@ -7,4 +7,4 @@ class WaffleConfig(AppConfig):
     default_auto_field = 'django.db.models.AutoField'
 
     def ready(self) -> None:
-        import waffle.signals  # noqa: F401
+        import waffle.signals

waffle/decorators.py

@@ -25,8 +25,7 @@ def _wrapped_view(request, *args, **kwargs):
                 response_to_redirect_to = get_response_to_redirect(redirect_to, *args, **kwargs)
                 if response_to_redirect_to:
                     return response_to_redirect_to
-                else:
-                    raise Http404
+                raise Http404
 
             return view(request, *args, **kwargs)
         return _wrapped_view
@@ -48,8 +47,7 @@ def _wrapped_view(request, *args, **kwargs):
                 response_to_redirect_to = get_response_to_redirect(redirect_to, *args, **kwargs)
                 if response_to_redirect_to:
                     return response_to_redirect_to
-                else:
-                    raise Http404
+                raise Http404
 
             return view(request, *args, **kwargs)
         return _wrapped_view

waffle/management/commands/waffle_flag.py

@@ -61,14 +61,14 @@ def add_arguments(self, parser: CommandParser) -> None:
         parser.add_argument(
             '--group', '-g',
             action='append',
-            default=list(),
+            default=[],
             help='Turn on the flag for listed group names (use flag more '
                  'than once for multiple groups). WARNING: This will remove '
                  'any currently associated groups unless --append is used!')
         parser.add_argument(
             '--user', '-u',
             action='append',
-            default=list(),
+            default=[],
             help='Turn on the flag for listed usernames (use flag more '
                  'than once for multiple users). WARNING: This will remove '
                  'any currently associated users unless --append is used!')
@@ -120,8 +120,8 @@ def handle(self, *args: Any, **options: Any) -> None:
         else:
             try:
                 flag = get_waffle_flag_model().objects.get(name=flag_name)
-            except get_waffle_flag_model().DoesNotExist:
-                raise CommandError('This flag does not exist.')
+            except get_waffle_flag_model().DoesNotExist as dne:
+                raise CommandError('This flag does not exist.') from dne
 
         # Group isn't an attribute on the Flag, but a related Many-to-Many
         # field, so we handle it a bit differently by looking up groups and
@@ -133,8 +133,8 @@ def handle(self, *args: Any, **options: Any) -> None:
                 try:
                     group_instance = Group.objects.get(name=group)
                     group_hash[group_instance.name] = group_instance.id
-                except Group.DoesNotExist:
-                    raise CommandError(f'Group {group} does not exist')
+                except Group.DoesNotExist as dne:
+                    raise CommandError(f'Group {group} does not exist') from dne
             # If 'append' was not passed, we clear related groups
             if not options_append:
                 flag.groups.clear()
@@ -152,8 +152,8 @@ def handle(self, *args: Any, **options: Any) -> None:
                         | Q(**{UserModel.EMAIL_FIELD: username})
                     )
                     user_hash.add(user_instance)
-                except UserModel.DoesNotExist:
-                    raise CommandError(f'User {username} does not exist')
+                except UserModel.DoesNotExist as dne:
+                    raise CommandError(f'User {username} does not exist') from dne
             # If 'append' was not passed, we clear related users
             if not options_append:
                 flag.users.clear()

waffle/management/commands/waffle_sample.py

@@ -49,8 +49,8 @@ def handle(self, *args: Any, **options: Any) -> None:
             percent = float(percent)
             if not (0.0 <= percent <= 100.0):
                 raise ValueError
-        except ValueError:
-            raise CommandError('You need to enter a valid percentage value.')
+        except ValueError as e:
+            raise CommandError('You need to enter a valid percentage value.') from e
 
         if options['create']:
             sample, created = get_waffle_sample_model().objects.get_or_create(
@@ -60,8 +60,8 @@ def handle(self, *args: Any, **options: Any) -> None:
         else:
             try:
                 sample = get_waffle_sample_model().objects.get(name=sample_name)
-            except get_waffle_sample_model().DoesNotExist:
-                raise CommandError('This sample does not exist.')
+            except get_waffle_sample_model().DoesNotExist as dne:
+                raise CommandError('This sample does not exist.') from dne
 
         sample.percent = percent
         sample.save()

waffle/management/commands/waffle_switch.py

@@ -64,8 +64,8 @@ def handle(self, *args: Any, **options: Any) -> None:
         else:
             try:
                 switch = get_waffle_switch_model().objects.get(name=switch_name)
-            except get_waffle_switch_model().DoesNotExist:
-                raise CommandError('This switch does not exist.')
+            except get_waffle_switch_model().DoesNotExist as dne:
+                raise CommandError('This switch does not exist.') from dne
 
         switch.active = state
         switch.save()

waffle/managers.py

@@ -6,7 +6,7 @@
 
 
 if TYPE_CHECKING:
-    from waffle.models import _BaseModelType, AbstractBaseFlag, AbstractBaseSample, AbstractBaseSwitch  # noqa: F401
+    from waffle.models import _BaseModelType, AbstractBaseFlag, AbstractBaseSample, AbstractBaseSwitch
 else:
     _BaseModelType = TypeVar("_BaseModelType")
 

waffle/middleware.py

@@ -14,11 +14,8 @@ def process_response(self, request: HttpRequest, response: HttpResponse) -> Http
             for k in request.waffles:
                 name = smart_str(get_setting('COOKIE') % k)
                 active, rollout = request.waffles[k]
-                if rollout and not active:
-                    # "Inactive" is a session cookie during rollout mode.
-                    age = None
-                else:
-                    age = max_age
+                # "Inactive" is a session cookie during rollout mode.
+                age = None if rollout and not active else max_age
                 response.set_cookie(name, value=active, max_age=age,
                                     secure=secure)
         if hasattr(request, 'waffle_tests'):

waffle/mixins.py

@@ -11,10 +11,8 @@ class BaseWaffleMixin:
 
     def validate_waffle(self, waffle, func):
         if waffle.startswith('!'):
-            active = not func(waffle[1:])
-        else:
-            active = func(waffle)
-        return active
+            return not func(waffle[1:])
+        return func(waffle)
 
     def invalid_waffle(self):
         raise Http404('Inactive waffle')

waffle/models.py

@@ -275,13 +275,12 @@ def is_active(self, request: HttpRequest, read_only: bool = False) -> bool | Non
 
             return get_setting('FLAG_DEFAULT')
 
-        if get_setting('OVERRIDE'):
-            if self.name in request.GET:
-                return request.GET[self.name] == '1'
+        if get_setting('OVERRIDE') and self.name in request.GET:
+            return request.GET[self.name] == '1'
 
         if self.everyone:
             return True
-        elif self.everyone is False:
+        if self.everyone is False:
             return False
 
         if self.testing:  # Testing mode is on.
@@ -322,7 +321,7 @@ def is_active(self, request: HttpRequest, read_only: bool = False) -> bool | Non
                 return flag_active
 
             if not read_only:
-                if Decimal(str(random.uniform(0, 100))) <= self.percent:
+                if Decimal(str(random.uniform(0, 100))) <= self.percent:  # noqa: S311
                     set_flag(request, self.name, True, self.rollout)
                     return True
                 set_flag(request, self.name, False, self.rollout)
@@ -551,7 +550,7 @@ def is_active(self) -> bool:
                 cache.set(self._cache_key(self.name), sample)
 
             return get_setting('SAMPLE_DEFAULT')
-        return Decimal(str(random.uniform(0, 100))) <= self.percent
+        return Decimal(str(random.uniform(0, 100))) <= self.percent  # noqa: S311
 
 
 class Switch(AbstractBaseSwitch):

waffle/tests/test_middleware.py

@@ -17,8 +17,8 @@ def test_set_cookies():
     assert 'dwf_foo' in resp.cookies
     assert 'dwf_bar' in resp.cookies
 
-    assert 'True' == resp.cookies['dwf_foo'].value
-    assert 'False' == resp.cookies['dwf_bar'].value
+    assert resp.cookies['dwf_foo'].value == 'True'
+    assert resp.cookies['dwf_bar'].value == 'False'
 
 
 def test_rollout_cookies():

waffle/tests/test_views.py

@@ -37,19 +37,19 @@ def test_waffle_status_response(self):
         self.assertEqual(200, response.status_code)
         content = response.json()
 
-        assert 'test_flag_active' in content['flags'].keys()
+        assert 'test_flag_active' in content['flags']
         assert content['flags']['test_flag_active']['is_active']
-        assert 'test_flag_inactive' in content['flags'].keys()
+        assert 'test_flag_inactive' in content['flags']
         assert not content['flags']['test_flag_inactive']['is_active']
 
-        assert 'test_switch_active' in content['switches'].keys()
+        assert 'test_switch_active' in content['switches']
         assert content['switches']['test_switch_active']['is_active']
-        assert 'test_switch_inactive' in content['switches'].keys()
+        assert 'test_switch_inactive' in content['switches']
         assert not content['switches']['test_switch_inactive']['is_active']
 
-        assert 'test_sample_active' in content['samples'].keys()
+        assert 'test_sample_active' in content['samples']
         assert content['samples']['test_sample_active']['is_active']
-        assert 'test_sample_inactive' in content['samples'].keys()
+        assert 'test_sample_inactive' in content['samples']
         assert not content['samples']['test_sample_inactive']['is_active']
 
     def test_flush_all_flags(self):