Merge pull request #1645 from maykinmedia/ruff-bugbear

Initial pass at applying ruff bugbear

Author: swrichards

ruff.toml

@@ -48,6 +48,10 @@ select = [
     "PERF",
     # https://docs.astral.sh/ruff/rules/#refurb-furb
     "FURB",
+    # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+    "B006",
+    "B010",
+    "B904",
 ]
 ignore = [
     # Whitespace before ':' (conflicts with Black)

src/manage.py

@@ -15,7 +15,7 @@
         try:
             import django  # noqa
         except ImportError:
-            raise ImportError(
+            raise ImportError(  # noqa: B904
                 "Couldn't import Django. Are you sure it's installed and "
                 "available on your PYTHONPATH environment variable? Did you "
                 "forget to activate a virtual environment?"

src/open_inwoner/accounts/gateways.py

@@ -64,12 +64,12 @@ def send(self, to, token, **kwargs):
                 to,
                 self.get_message(token),
             )
-        except messagebird.client.ErrorException as e:
-            for error in e.errors:
+        except messagebird.client.ErrorException as exc:
+            for error in exc.errors:
                 logger.critical(
                     ("Could not send SMS to {to}:\n{error}").format(to=to, error=error)
                 )
-            raise GatewayError()
+            raise GatewayError() from exc
         else:
             logging.debug('Sent SMS to %s: "%s"', to, self.get_message(token))
             return True

src/open_inwoner/cms/cases/views/status.py

@@ -111,9 +111,9 @@ def get_context_data(self, **kwargs):
     def get(self, request, *args, **kwargs):
         try:
             ZGWApiGroupConfig.objects.get(pk=self.kwargs["api_group_id"])
-        except ZGWApiGroupConfig.DoesNotExist:
+        except ZGWApiGroupConfig.DoesNotExist as exc:
             logger.exception("Non-existent ZGWApiGroupConfig passed")
-            raise Http404
+            raise Http404 from exc
 
         return super().get(request, *args, **kwargs)
 
@@ -735,9 +735,9 @@ def get(self, request, *args, **kwargs):
 
         try:
             api_group = ZGWApiGroupConfig.objects.get(pk=self.kwargs["api_group_id"])
-        except ZGWApiGroupConfig.DoesNotExist:
+        except ZGWApiGroupConfig.DoesNotExist as exc:
             logger.exception("Non-existent ZGWApiGroupConfig passed")
-            raise Http404
+            raise Http404 from exc
 
         info_object_uuid = kwargs["info_id"]
         info_object = fetch_single_information_object_uuid(
@@ -821,9 +821,9 @@ def handle_document_error(self, request, file):
     def handle_document_upload(self, request, form):
         try:
             api_group = ZGWApiGroupConfig.objects.get(pk=self.kwargs["api_group_id"])
-        except ZGWApiGroupConfig.DoesNotExist:
+        except ZGWApiGroupConfig.DoesNotExist as exc:
             logger.exception("Non-existent ZGWApiGroupConfig passed")
-            raise Http404
+            raise Http404 from exc
 
         cleaned_data = form.cleaned_data
         files = cleaned_data["files"]

src/open_inwoner/components/tests/abstract.py

@@ -1,3 +1,5 @@
+from typing import Any
+
 from django.template import Context, Template
 from django.test import RequestFactory
 
@@ -55,7 +57,7 @@ def test_href(self):
     # The tag name, a value of "list_item" would be the equivalent of "{% list_item %}".
     tag = ""
 
-    def assertContext(self, args: dict = {}) -> any:
+    def assertContext(self, args: dict | None = None) -> Any:
         """
         Asserts that a context is returned by the inclusion tag.
 
@@ -64,11 +66,12 @@ def assertContext(self, args: dict = {}) -> any:
 
         Returns: The return value of the tag's function.
         """
+        args = args or {}
         context = self.call_function(args)
         self.assertTrue(context)
         return context
 
-    def assertRender(self, args: dict = {}, data={}) -> str:
+    def assertRender(self, args: dict | None = None, data: dict | None = None) -> str:
         """
         Asserts that something is rendered by the tag.
 
@@ -79,12 +82,14 @@ def assertRender(self, args: dict = {}, data={}) -> str:
 
         Returns: The str rendered by the tag.
         """
+        data = data or {}
+        args = args or {}
         html = self.render(args, data)
         self.assertTrue(html)
         return html
 
     def assertSelector(
-        self, selector: str, args: dict = {}, data: dict = {}
+        self, selector: str, args: dict | None = None, data: dict | None = None
     ) -> ResultSet:
         """
         Asserts that an HTML tag matching `selector` is present in the tag's rendered output.
@@ -97,12 +102,14 @@ def assertSelector(
 
         Returns: bs4.element.ResultSet
         """
+        data = data or {}
+        args = args or {}
         nodes = self.select(selector, args, data)
         self.assertTrue(nodes, msg=f"Did not find selector {selector}")
         return nodes
 
     def assertNotSelector(
-        self, selector: str, args: dict = {}, data: dict = {}
+        self, selector: str, args: dict | None = None, data: dict | None = None
     ) -> ResultSet:
         """
         Asserts that an HTML tag matching `selector` is not present in the tag's rendered output.
@@ -115,12 +122,18 @@ def assertNotSelector(
 
         Returns: bs4.element.ResultSet
         """
+        data = data or {}
+        args = args or {}
         nodes = self.select(selector, args, data)
         self.assertFalse(nodes)
         return nodes
 
     def assertTextContent(
-        self, selector: str, text: str, args: dict = {}, data: dict = {}
+        self,
+        selector: str,
+        text: str,
+        args: dict | None = None,
+        data: dict | None = None,
     ) -> str:
         """
         Asserts that an HTML tag matching `selector` has textual content matching `text`.
@@ -134,11 +147,13 @@ def assertTextContent(
 
         Returns: bs4.element.ResultSet
         """
+        data = data or {}
+        args = args or {}
         node = self.select_one(selector, args, data)
         self.assertEqual(str(text).strip(), node.text.strip())
         return node.text
 
-    def render(self, args={}, data={}):
+    def render(self, args: dict | None = None, data: dict | None = None):
         """
         Renders the template tag with arguments (and optionally passing `data` to RequestFactory's query string).
 
@@ -149,6 +164,7 @@ def render(self, args={}, data={}):
 
         Returns: The str rendered by the tag.
         """
+        data = data or {}
         args = args or {}
         template_context = self.get_template_context(args)
         context = Context(
@@ -157,7 +173,9 @@ def render(self, args={}, data={}):
         template = self.get_template(args)
         return template.render(context)
 
-    def select_one(self, selector: str, args: dict = {}, data: dict = {}) -> Tag:
+    def select_one(
+        self, selector: str, args: dict | None = None, data: dict | None = None
+    ) -> Tag | None:
         """
         Returns a bs4.element.Tag for HTML tag matching `selector` within the str rendered by the tag.
 
@@ -169,11 +187,15 @@ def select_one(self, selector: str, args: dict = {}, data: dict = {}) -> Tag:
 
         Returns: bs4.element.Tag
         """
+        data = data or {}
+        args = args or {}
         html = self.render(args, data)
         soup = BeautifulSoup(html, features="lxml")
         return soup.select_one(selector)
 
-    def select(self, selector: str, args: dict = {}, data: dict = {}) -> ResultSet:
+    def select(
+        self, selector: str, args: dict | None = None, data: dict | None = None
+    ) -> ResultSet:
         """
         Returns a bs4.element.ResultSet for HTML tags matching `selector` within the str rendered by the tag.
 
@@ -185,11 +207,13 @@ def select(self, selector: str, args: dict = {}, data: dict = {}) -> ResultSet:
 
         Returns: bs4.element.ResultSet
         """
+        data = data or {}
+        args = args or {}
         html = self.render(args, data)
         soup = BeautifulSoup(html, features="lxml")
         return soup.select(selector)
 
-    def call_function(self, args: dict = {}) -> any:
+    def call_function(self, args: dict | None = None) -> Any:
         """
         Calls the tag's function directly.
 
@@ -198,13 +222,15 @@ def call_function(self, args: dict = {}) -> any:
 
         Returns: The return value of the tag's function.
         """
+        if args is None:
+            args = {}
         template = self.get_template(args)
         nodelist = template.compile_nodelist()
         inclusion_node = nodelist[1]
         function = inclusion_node.func
         return function(**args)
 
-    def get_template(self, args={}):
+    def get_template(self, args: dict | None = None):
         """
         Returns the (Django) Template instance (in order to render the tag).
         A templates str is constructed and then passed to a django.template.Template, the resulting instance is
@@ -215,6 +241,8 @@ def get_template(self, args={}):
 
         Returns: django.template.Template
         """
+        if args is None:
+            args = {}
         args = self.get_args(args)
         template = (
             "{% load " + self.library + " %}{% " + self.tag + " " + args + " " + " %}"
@@ -315,7 +343,9 @@ def test_contents(self):
     # A value of "{% list_item %}" would be the equivalent of "{% render_list %}{% list_item %}{% endrender_list %}".
     contents = ""
 
-    def assertContents(self, args={}, data={}, contents_context={}) -> str:
+    def assertContents(
+        self, args: dict | None = None, data: dict | None = None, contents_context=None
+    ) -> str:
         """
         Asserts that rendered HTML of contents is present in the tag's rendered output.
 
@@ -327,13 +357,16 @@ def assertContents(self, args={}, data={}, contents_context={}) -> str:
 
         Returns: The contents html.
         """
+        contents_context = contents_context or {}
+        data = data or {}
+        args = args or {}
         html = self.render(args, data)
         context = Context(contents_context)
         contents_html = self.get_contents(context)
         self.assertIn(contents_html, html)
         return contents_html
 
-    def get_contents(self, context: Context | dict = {}) -> str:
+    def get_contents(self, context: Context | dict | None = None) -> str:
         """
         Renders contents HTML.
 
@@ -342,11 +375,13 @@ def get_contents(self, context: Context | dict = {}) -> str:
 
         Returns: The contents html.
         """
+        if context is None:
+            context = {}
         return Template("{% load " + self.library + " %}" + self.contents).render(
             context
         )
 
-    def get_template(self, args={}):
+    def get_template(self, args: dict | None = None):
         """
         Returns the (Django) Template instance (in order to render the tag).
         A templates str is constructed and then passed to a django.template.Template, the resulting instance is
@@ -357,6 +392,8 @@ def get_template(self, args={}):
 
         Returns: django.template.Template
         """
+        if args is None:
+            args = {}
         args = self.get_args(args)
         template = (
             "{% load "

src/open_inwoner/configurations/admin.py

@@ -109,13 +109,13 @@ def clean_redirect_to(self):
                 try:
                     resolve(redirect_to)
                 except Resolver404:
-                    raise ValidationError(_("The entered path is invalid."))
+                    raise ValidationError(_("The entered path is invalid.")) from None
             else:
                 validate_url = URLValidator()
                 try:
                     validate_url(redirect_to)
                 except exceptions.ValidationError:
-                    raise ValidationError(_("The entered url is invalid."))
+                    raise ValidationError(_("The entered url is invalid.")) from None
 
         return redirect_to
 

src/open_inwoner/configurations/bootstrap/auth.py

@@ -428,10 +428,10 @@ def configure(self):
 
         try:
             form.save()
-        except ValidationError as e:
+        except ValidationError as exc:
             raise ConfigurationRunFailed(
                 "Something went wrong while saving configuration"
-            ) from e
+            ) from exc
 
     def test_configuration(self):
         """

src/open_inwoner/configurations/bootstrap/utils.py

@@ -28,5 +28,5 @@ def get_service(slug: str) -> Service:
     """
     try:
         return Service.objects.get(slug=slug)
-    except Service.DoesNotExist as e:
-        raise Service.DoesNotExist(f"{str(e)} (identifier = {slug})")
+    except Service.DoesNotExist as exc:
+        raise Service.DoesNotExist(f"{str(exc)} (identifier = {slug})") from exc

src/open_inwoner/configurations/bootstrap/zgw.py

@@ -85,7 +85,7 @@ def execute(self, model: OpenZaakConfigurationModel):
                 raise ConfigurationRunFailed(
                     "You must first ensure all the ZGW Services referenced in this "
                     f"step have been created:\n{str(exc)}"
-                )
+                ) from exc
 
             ZGWApiGroupConfig.objects.get_or_create(
                 open_zaak_config=config,

src/open_inwoner/mail/verification.py

@@ -46,8 +46,8 @@ def decode_email_verification_token(token: str) -> Payload:
     signer = signing.TimestampSigner(salt=VERIFY_SALT)
     try:
         payload: Payload = signer.unsign_object(token, max_age=VERIFY_MAX_AGE)
-    except signing.BadSignature:
-        raise BadToken("invalid signature")
+    except signing.BadSignature as exc:
+        raise BadToken("invalid signature") from exc
     else:
         return payload
 

src/open_inwoner/openklant/tests/mocks.py

@@ -12,14 +12,14 @@ def __init__(self):
     def get_fetch_parameters(self, request=None, user=None, use_vestigingsnummer=False):
         return {"user_bsn": "123456789"}
 
-    def get_or_create_partij_for_user(self, fetch_params={}, user=None):
+    def get_or_create_partij_for_user(self, fetch_params=None, user=None):
         return {"uuid": "0d150ff9-0924-46f6-8ef9-17fee9e54d23"}, False
 
-    def list_questions(self, fetch_params={}, user=None):
+    def list_questions(self, fetch_params=None, user=None):
         return [self.retrieve_question()[0]]
 
     def retrieve_question(
-        self, fetch_params={}, question_uuid="", user=None, new_answer_available=False
+        self, fetch_params=None, question_uuid="", user=None, new_answer_available=False
     ):
         return (
             {

src/open_inwoner/openklant/views/utils.py

@@ -5,8 +5,9 @@
 
 def generate_question_answer_pair(
     range_: tuple[int, int] = (1, 10),
-    operators: list[str] = ["+", "-"],
+    operators: list[str] | None = None,
 ) -> tuple[str, int]:
+    operators = operators or ["+", "-"]
     lower, upper = range_
     num1 = secrets.choice(range(lower, upper))
     num2 = secrets.choice(range(lower, upper))

src/open_inwoner/openzaak/auth.py

@@ -40,8 +40,8 @@ def get_valid_subscription_from_jwt(jwt_string: str) -> Subscription:
             },
         )
         client_id = decoded_unverified.get("client_id")
-    except InvalidTokenError:
-        raise InvalidAuth(f"cannot decode token: {jwt_string}")
+    except InvalidTokenError as exc:
+        raise InvalidAuth(f"cannot decode token: {jwt_string}") from exc
 
     if not client_id:
         raise InvalidAuth(f"missing 'client_id' in token: {jwt_string}")