From 5ec0dcf2067b9487c3f4498080c7f832bd9e7dad Mon Sep 17 00:00:00 2001 From: Lebaud Antoine Date: Thu, 7 Mar 2024 10:57:05 +0100 Subject: [PATCH] =?UTF-8?q?=F0=9F=9A=A8(backend)=20follow=20Ruff=202024.2?= =?UTF-8?q?=20style=20introduced=20in=20v0.3.0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit We recently updated Ruff from 0.2.2 to v0.3, which introduced Ruff 2024.2 style. This new style updated Ruff formatter's behavior, making our make lint command fails. Ruff 2024.2 style add a blank line after the module docstring. Please take a look at Ruff ChangeLog to get more info. --- src/backend/core/admin.py | 1 + src/backend/core/api/__init__.py | 1 + src/backend/core/api/permissions.py | 1 + src/backend/core/api/serializers.py | 1 + src/backend/core/api/viewsets.py | 1 + src/backend/core/authentication.py | 1 + src/backend/core/enums.py | 1 + src/backend/core/factories.py | 1 + src/backend/core/models.py | 1 + src/backend/core/tests/swagger/test_openapi_schema.py | 1 + .../tests/team_accesses/test_api_team_accesses_create.py | 1 + .../tests/team_accesses/test_api_team_accesses_delete.py | 1 + .../tests/team_accesses/test_api_team_accesses_list.py | 1 + .../team_accesses/test_api_team_accesses_retrieve.py | 1 + .../tests/team_accesses/test_api_team_accesses_update.py | 1 + .../core/tests/teams/test_core_api_teams_create.py | 1 + .../core/tests/teams/test_core_api_teams_delete.py | 1 + src/backend/core/tests/teams/test_core_api_teams_list.py | 1 + .../core/tests/teams/test_core_api_teams_retrieve.py | 1 + .../core/tests/teams/test_core_api_teams_update.py | 1 + src/backend/core/tests/test_api_contacts.py | 1 + src/backend/core/tests/test_api_users.py | 1 + .../core/tests/test_authentication_get_or_create_user.py | 9 ++++++--- src/backend/core/tests/test_models_contacts.py | 1 + src/backend/core/tests/test_models_identities.py | 1 + src/backend/core/tests/test_models_invitations.py | 1 + src/backend/core/tests/test_models_team_accesses.py | 1 + src/backend/core/tests/test_models_teams.py | 1 + src/backend/core/tests/test_models_users.py | 1 + src/backend/core/tests/test_throttle.py | 1 + src/backend/demo/management/commands/createsuperuser.py | 1 + src/backend/demo/tests/test_commands_create_demo.py | 1 + src/backend/manage.py | 1 + src/backend/people/api_urls.py | 1 + src/backend/people/celery_app.py | 1 + src/backend/people/settings.py | 1 + 36 files changed, 41 insertions(+), 3 deletions(-) diff --git a/src/backend/core/admin.py b/src/backend/core/admin.py index a8dc61f93..566d7285b 100644 --- a/src/backend/core/admin.py +++ b/src/backend/core/admin.py @@ -1,4 +1,5 @@ """Admin classes and registrations for People's core app.""" + from django import forms from django.contrib import admin from django.contrib.auth import admin as auth_admin diff --git a/src/backend/core/api/__init__.py b/src/backend/core/api/__init__.py index d1a9f0580..b72c847ed 100644 --- a/src/backend/core/api/__init__.py +++ b/src/backend/core/api/__init__.py @@ -1,4 +1,5 @@ """People core API endpoints""" + from django.conf import settings from django.core.exceptions import ValidationError diff --git a/src/backend/core/api/permissions.py b/src/backend/core/api/permissions.py index 5dba3ead6..09f5fdbcc 100644 --- a/src/backend/core/api/permissions.py +++ b/src/backend/core/api/permissions.py @@ -1,4 +1,5 @@ """Permission handlers for the People core app.""" + from django.core import exceptions from rest_framework import permissions diff --git a/src/backend/core/api/serializers.py b/src/backend/core/api/serializers.py index 5e190825e..8392e5fe0 100644 --- a/src/backend/core/api/serializers.py +++ b/src/backend/core/api/serializers.py @@ -1,4 +1,5 @@ """Client serializers for the People core app.""" + from rest_framework import exceptions, serializers from timezone_field.rest_framework import TimeZoneSerializerField diff --git a/src/backend/core/api/viewsets.py b/src/backend/core/api/viewsets.py index 9d32a74ff..c71ea27d7 100644 --- a/src/backend/core/api/viewsets.py +++ b/src/backend/core/api/viewsets.py @@ -1,4 +1,5 @@ """API endpoints""" + from django.contrib.postgres.search import TrigramSimilarity from django.db.models import Func, Max, OuterRef, Prefetch, Q, Subquery, Value diff --git a/src/backend/core/authentication.py b/src/backend/core/authentication.py index b868b32f5..2a45d9f05 100644 --- a/src/backend/core/authentication.py +++ b/src/backend/core/authentication.py @@ -1,4 +1,5 @@ """Authentication for the People core app.""" + from django.conf import settings from django.core.exceptions import SuspiciousOperation from django.db import models diff --git a/src/backend/core/enums.py b/src/backend/core/enums.py index f4e0e11a8..e67d7b5b5 100644 --- a/src/backend/core/enums.py +++ b/src/backend/core/enums.py @@ -1,6 +1,7 @@ """ Core application enums declaration """ + from django.conf import global_settings, settings from django.utils.translation import gettext_lazy as _ diff --git a/src/backend/core/factories.py b/src/backend/core/factories.py index 33ca2a731..131196de0 100644 --- a/src/backend/core/factories.py +++ b/src/backend/core/factories.py @@ -2,6 +2,7 @@ """ Core application factories """ + from django.conf import settings from django.contrib.auth.hashers import make_password diff --git a/src/backend/core/models.py b/src/backend/core/models.py index e73fff309..8131f45dc 100644 --- a/src/backend/core/models.py +++ b/src/backend/core/models.py @@ -1,6 +1,7 @@ """ Declare and configure the models for the People core application """ + import json import os import uuid diff --git a/src/backend/core/tests/swagger/test_openapi_schema.py b/src/backend/core/tests/swagger/test_openapi_schema.py index 5fa079e50..48a2b2a84 100644 --- a/src/backend/core/tests/swagger/test_openapi_schema.py +++ b/src/backend/core/tests/swagger/test_openapi_schema.py @@ -1,6 +1,7 @@ """ Test suite for generated openapi schema. """ + import json from io import StringIO diff --git a/src/backend/core/tests/team_accesses/test_api_team_accesses_create.py b/src/backend/core/tests/team_accesses/test_api_team_accesses_create.py index 5343cf85d..c867464ee 100644 --- a/src/backend/core/tests/team_accesses/test_api_team_accesses_create.py +++ b/src/backend/core/tests/team_accesses/test_api_team_accesses_create.py @@ -1,6 +1,7 @@ """ Test for team accesses API endpoints in People's core app : create """ + import random import pytest diff --git a/src/backend/core/tests/team_accesses/test_api_team_accesses_delete.py b/src/backend/core/tests/team_accesses/test_api_team_accesses_delete.py index 767bb81e2..429953ad0 100644 --- a/src/backend/core/tests/team_accesses/test_api_team_accesses_delete.py +++ b/src/backend/core/tests/team_accesses/test_api_team_accesses_delete.py @@ -1,6 +1,7 @@ """ Test for team accesses API endpoints in People's core app : delete """ + import random import pytest diff --git a/src/backend/core/tests/team_accesses/test_api_team_accesses_list.py b/src/backend/core/tests/team_accesses/test_api_team_accesses_list.py index 0ffea9baa..bb623cebd 100644 --- a/src/backend/core/tests/team_accesses/test_api_team_accesses_list.py +++ b/src/backend/core/tests/team_accesses/test_api_team_accesses_list.py @@ -1,6 +1,7 @@ """ Test for team accesses API endpoints in People's core app : list """ + import pytest from rest_framework.test import APIClient diff --git a/src/backend/core/tests/team_accesses/test_api_team_accesses_retrieve.py b/src/backend/core/tests/team_accesses/test_api_team_accesses_retrieve.py index 21f628d1a..3c28fb0bc 100644 --- a/src/backend/core/tests/team_accesses/test_api_team_accesses_retrieve.py +++ b/src/backend/core/tests/team_accesses/test_api_team_accesses_retrieve.py @@ -1,6 +1,7 @@ """ Test for team accesses API endpoints in People's core app : retrieve """ + import pytest from rest_framework.test import APIClient diff --git a/src/backend/core/tests/team_accesses/test_api_team_accesses_update.py b/src/backend/core/tests/team_accesses/test_api_team_accesses_update.py index b955ba976..3001bf660 100644 --- a/src/backend/core/tests/team_accesses/test_api_team_accesses_update.py +++ b/src/backend/core/tests/team_accesses/test_api_team_accesses_update.py @@ -1,6 +1,7 @@ """ Test for team accesses API endpoints in People's core app : update """ + import random from uuid import uuid4 diff --git a/src/backend/core/tests/teams/test_core_api_teams_create.py b/src/backend/core/tests/teams/test_core_api_teams_create.py index a9d99f6f9..a9bf2c73b 100644 --- a/src/backend/core/tests/teams/test_core_api_teams_create.py +++ b/src/backend/core/tests/teams/test_core_api_teams_create.py @@ -1,6 +1,7 @@ """ Tests for Teams API endpoint in People's core app: create """ + import pytest from rest_framework.status import ( HTTP_201_CREATED, diff --git a/src/backend/core/tests/teams/test_core_api_teams_delete.py b/src/backend/core/tests/teams/test_core_api_teams_delete.py index f700a7fab..901750952 100644 --- a/src/backend/core/tests/teams/test_core_api_teams_delete.py +++ b/src/backend/core/tests/teams/test_core_api_teams_delete.py @@ -1,6 +1,7 @@ """ Tests for Teams API endpoint in People's core app: delete """ + import pytest from rest_framework.status import ( HTTP_204_NO_CONTENT, diff --git a/src/backend/core/tests/teams/test_core_api_teams_list.py b/src/backend/core/tests/teams/test_core_api_teams_list.py index 4f8f72887..f7a9309dd 100644 --- a/src/backend/core/tests/teams/test_core_api_teams_list.py +++ b/src/backend/core/tests/teams/test_core_api_teams_list.py @@ -1,6 +1,7 @@ """ Tests for Teams API endpoint in People's core app: list """ + from unittest import mock import pytest diff --git a/src/backend/core/tests/teams/test_core_api_teams_retrieve.py b/src/backend/core/tests/teams/test_core_api_teams_retrieve.py index 3fa624310..36eedeae3 100644 --- a/src/backend/core/tests/teams/test_core_api_teams_retrieve.py +++ b/src/backend/core/tests/teams/test_core_api_teams_retrieve.py @@ -1,6 +1,7 @@ """ Tests for Teams API endpoint in People's core app: retrieve """ + import pytest from rest_framework.status import HTTP_200_OK, HTTP_401_UNAUTHORIZED, HTTP_404_NOT_FOUND from rest_framework.test import APIClient diff --git a/src/backend/core/tests/teams/test_core_api_teams_update.py b/src/backend/core/tests/teams/test_core_api_teams_update.py index 01fa5b247..64f0d5548 100644 --- a/src/backend/core/tests/teams/test_core_api_teams_update.py +++ b/src/backend/core/tests/teams/test_core_api_teams_update.py @@ -1,6 +1,7 @@ """ Tests for Teams API endpoint in People's core app: update """ + import random import pytest diff --git a/src/backend/core/tests/test_api_contacts.py b/src/backend/core/tests/test_api_contacts.py index 5cb79cb44..d6688dba5 100644 --- a/src/backend/core/tests/test_api_contacts.py +++ b/src/backend/core/tests/test_api_contacts.py @@ -1,6 +1,7 @@ """ Test contacts API endpoints in People's core app. """ + from django.test.utils import override_settings import pytest diff --git a/src/backend/core/tests/test_api_users.py b/src/backend/core/tests/test_api_users.py index 21b48fe26..521138782 100644 --- a/src/backend/core/tests/test_api_users.py +++ b/src/backend/core/tests/test_api_users.py @@ -1,6 +1,7 @@ """ Test users API endpoints in the People core app. """ + from unittest import mock import pytest diff --git a/src/backend/core/tests/test_authentication_get_or_create_user.py b/src/backend/core/tests/test_authentication_get_or_create_user.py index 2d30e25a5..2c771c5dc 100644 --- a/src/backend/core/tests/test_authentication_get_or_create_user.py +++ b/src/backend/core/tests/test_authentication_get_or_create_user.py @@ -192,9 +192,12 @@ def test_models_oidc_user_getter_invalid_token(django_assert_num_queries, monkey monkeypatch.setattr(OIDCAuthenticationBackend, "get_userinfo", get_userinfo_mocked) - with django_assert_num_queries(0), pytest.raises( - SuspiciousOperation, - match="User info contained no recognizable user identification", + with ( + django_assert_num_queries(0), + pytest.raises( + SuspiciousOperation, + match="User info contained no recognizable user identification", + ), ): klass.get_or_create_user(access_token="test-token", id_token=None, payload=None) diff --git a/src/backend/core/tests/test_models_contacts.py b/src/backend/core/tests/test_models_contacts.py index 85d98605a..34c9b58a8 100644 --- a/src/backend/core/tests/test_models_contacts.py +++ b/src/backend/core/tests/test_models_contacts.py @@ -1,6 +1,7 @@ """ Unit tests for the Contact model """ + from django.core.exceptions import ValidationError import pytest diff --git a/src/backend/core/tests/test_models_identities.py b/src/backend/core/tests/test_models_identities.py index 4d8c8b74e..f6aae77bb 100644 --- a/src/backend/core/tests/test_models_identities.py +++ b/src/backend/core/tests/test_models_identities.py @@ -1,6 +1,7 @@ """ Unit tests for the Identity model """ + from django.core.exceptions import ValidationError import pytest diff --git a/src/backend/core/tests/test_models_invitations.py b/src/backend/core/tests/test_models_invitations.py index 959dec9d0..4d10b9e1b 100644 --- a/src/backend/core/tests/test_models_invitations.py +++ b/src/backend/core/tests/test_models_invitations.py @@ -1,6 +1,7 @@ """ Unit tests for the Invitation model """ + from django.core.exceptions import ValidationError import pytest diff --git a/src/backend/core/tests/test_models_team_accesses.py b/src/backend/core/tests/test_models_team_accesses.py index 97ff4d601..bdd500523 100644 --- a/src/backend/core/tests/test_models_team_accesses.py +++ b/src/backend/core/tests/test_models_team_accesses.py @@ -1,6 +1,7 @@ """ Unit tests for the TeamAccess model """ + from django.contrib.auth.models import AnonymousUser from django.core.exceptions import ValidationError diff --git a/src/backend/core/tests/test_models_teams.py b/src/backend/core/tests/test_models_teams.py index e22ef8d0a..dfc6008f7 100644 --- a/src/backend/core/tests/test_models_teams.py +++ b/src/backend/core/tests/test_models_teams.py @@ -1,6 +1,7 @@ """ Unit tests for the Team model """ + from django.contrib.auth.models import AnonymousUser from django.core.exceptions import ValidationError diff --git a/src/backend/core/tests/test_models_users.py b/src/backend/core/tests/test_models_users.py index 0f1ca14b7..a965e7837 100644 --- a/src/backend/core/tests/test_models_users.py +++ b/src/backend/core/tests/test_models_users.py @@ -1,6 +1,7 @@ """ Unit tests for the User model """ + from unittest import mock from django.core.exceptions import ValidationError diff --git a/src/backend/core/tests/test_throttle.py b/src/backend/core/tests/test_throttle.py index d1c4500f3..9752b5945 100644 --- a/src/backend/core/tests/test_throttle.py +++ b/src/backend/core/tests/test_throttle.py @@ -1,6 +1,7 @@ """ Test Throttle in People's app. """ + import pytest from rest_framework.test import APIClient diff --git a/src/backend/demo/management/commands/createsuperuser.py b/src/backend/demo/management/commands/createsuperuser.py index 30652f923..ad73aa777 100644 --- a/src/backend/demo/management/commands/createsuperuser.py +++ b/src/backend/demo/management/commands/createsuperuser.py @@ -2,6 +2,7 @@ Management command overriding the "createsuperuser" command to allow creating users with their email and no username. """ + from django.contrib.auth import get_user_model from django.core.management.base import BaseCommand diff --git a/src/backend/demo/tests/test_commands_create_demo.py b/src/backend/demo/tests/test_commands_create_demo.py index 1bd6bd9ee..0c37f6fd5 100644 --- a/src/backend/demo/tests/test_commands_create_demo.py +++ b/src/backend/demo/tests/test_commands_create_demo.py @@ -1,4 +1,5 @@ """Test the `create_demo` management command""" + from unittest import mock from django.core.management import call_command diff --git a/src/backend/manage.py b/src/backend/manage.py index 0b5b150db..fc791ffbc 100644 --- a/src/backend/manage.py +++ b/src/backend/manage.py @@ -2,6 +2,7 @@ """ People's sandbox management script. """ + import os import sys diff --git a/src/backend/people/api_urls.py b/src/backend/people/api_urls.py index 6077092c3..af463fc24 100644 --- a/src/backend/people/api_urls.py +++ b/src/backend/people/api_urls.py @@ -1,4 +1,5 @@ """API URL Configuration""" + from django.conf import settings from django.urls import include, path, re_path diff --git a/src/backend/people/celery_app.py b/src/backend/people/celery_app.py index 420588a08..31550d93a 100644 --- a/src/backend/people/celery_app.py +++ b/src/backend/people/celery_app.py @@ -1,4 +1,5 @@ """People celery configuration file.""" + import os from celery import Celery diff --git a/src/backend/people/settings.py b/src/backend/people/settings.py index 69d2fd79e..1580c2691 100755 --- a/src/backend/people/settings.py +++ b/src/backend/people/settings.py @@ -9,6 +9,7 @@ https://docs.djangoproject.com/en/3.1/topics/settings/ For the full list of settings and their values, see https://docs.djangoproject.com/en/3.1/ref/settings/ """ + import json import os