code linting with ruff (#29)

eadwinCode · web-flow · commit 28b3571545ab · 2023-08-09T21:26:50.000+01:00
diff --git a/.github/workflows/test_full.yml b/.github/workflows/test_full.yml
@@ -41,9 +41,5 @@ jobs:
         run: flit install --symlink
       - name: Black
         run: black --check ninja_jwt tests
-      - name: isort
-        run: isort --check ninja_jwt tests
-      - name: Flake8
-        run: flake8 ninja_jwt tests
-#      - name: mypy
-#        run: mypy ninja_jwt
+      - name: Ruff Linting Check
+        run: ruff check ninja_jwt tests
diff --git a/Makefile b/Makefile
@@ -18,14 +18,13 @@ install: ## Install dependencies
 lint: ## Run code linters
 	make clean
 	black --check ninja_jwt tests
-	isort --check ninja_jwt tests
-	flake8 ninja_jwt tests
+	ruff check ninja_jwt tests
 # 	mypy  ninja_jwt
 
 fmt format: ## Run code formatters
 	make clean
 	black ninja_jwt tests
-	isort ninja_jwt tests
+	ruff check --fix ninja_jwt tests
 
 test: ## Run tests
 	make clean
diff --git a/mypy.ini b/mypy.ini
@@ -1,5 +1,5 @@
 [mypy]
-python_version = 3.6
+python_version = 3.8
 
 show_column_numbers = True
 
@@ -21,4 +21,4 @@ no_implicit_reexport = True
 [mypy-ninja_jwt.token_blacklist.*]
 ignore_errors = True
 [mypy-ninja_jwt.controller]
-ignore_errors = True
+ignore_errors = True
diff --git a/ninja_jwt/authentication.py b/ninja_jwt/authentication.py
@@ -49,13 +49,15 @@ def get_user(self, validated_token) -> Type[AbstractUser]:
         """
         try:
             user_id = validated_token[api_settings.USER_ID_CLAIM]
-        except KeyError:
-            raise InvalidToken(_("Token contained no recognizable user identification"))
+        except KeyError as e:
+            raise InvalidToken(
+                _("Token contained no recognizable user identification")
+            ) from e
 
         try:
             user = self.user_model.objects.get(**{api_settings.USER_ID_FIELD: user_id})
-        except self.user_model.DoesNotExist:
-            raise AuthenticationFailed(_("User not found"))
+        except self.user_model.DoesNotExist as e:
+            raise AuthenticationFailed(_("User not found")) from e
 
         if not user.is_active:
             raise AuthenticationFailed(_("User is inactive"))
diff --git a/ninja_jwt/schema.py b/ninja_jwt/schema.py
@@ -39,7 +39,6 @@ def to_response_schema(self):
 
 
 class TokenInputSchemaMixin(InputSchemaMixin):
-
     _user: Optional[AbstractUser] = None
 
     _default_error_messages = {
diff --git a/ninja_jwt/settings.py b/ninja_jwt/settings.py
@@ -13,11 +13,11 @@ def __init__(self, data: dict) -> None:
         self.__dict__ = data
 
 
-NinjaJWT_SETTINGS_DEFAULTS = dict(
-    USER_AUTHENTICATION_RULE="ninja_jwt.authentication.default_user_authentication_rule",
-    AUTH_TOKEN_CLASSES=["ninja_jwt.tokens.AccessToken"],
-    TOKEN_USER_CLASS="ninja_jwt.models.TokenUser",
-)
+NinjaJWT_SETTINGS_DEFAULTS = {
+    "USER_AUTHENTICATION_RULE": "ninja_jwt.authentication.default_user_authentication_rule",
+    "AUTH_TOKEN_CLASSES": ["ninja_jwt.tokens.AccessToken"],
+    "TOKEN_USER_CLASS": "ninja_jwt.models.TokenUser",
+}
 
 USER_SETTINGS = NinjaJWTUserDefinedSettingsMapper(
     getattr(
diff --git a/ninja_jwt/token_blacklist/migrations/0001_initial.py b/ninja_jwt/token_blacklist/migrations/0001_initial.py
@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     initial = True
 
     dependencies = [
diff --git a/ninja_jwt/token_blacklist/migrations/0002_outstandingtoken_jti_hex.py b/ninja_jwt/token_blacklist/migrations/0002_outstandingtoken_jti_hex.py
@@ -2,7 +2,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("token_blacklist", "0001_initial"),
     ]
diff --git a/ninja_jwt/token_blacklist/migrations/0003_auto_20171017_2007.py b/ninja_jwt/token_blacklist/migrations/0003_auto_20171017_2007.py
@@ -22,7 +22,6 @@ def reverse_populate_jti_hex(apps, schema_editor):  # pragma: no cover
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("token_blacklist", "0002_outstandingtoken_jti_hex"),
     ]
diff --git a/ninja_jwt/token_blacklist/migrations/0004_auto_20171017_2013.py b/ninja_jwt/token_blacklist/migrations/0004_auto_20171017_2013.py
@@ -2,7 +2,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("token_blacklist", "0003_auto_20171017_2007"),
     ]
diff --git a/ninja_jwt/token_blacklist/migrations/0005_remove_outstandingtoken_jti.py b/ninja_jwt/token_blacklist/migrations/0005_remove_outstandingtoken_jti.py
@@ -2,7 +2,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("token_blacklist", "0004_auto_20171017_2013"),
     ]
diff --git a/ninja_jwt/token_blacklist/migrations/0006_auto_20171017_2113.py b/ninja_jwt/token_blacklist/migrations/0006_auto_20171017_2113.py
@@ -2,7 +2,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("token_blacklist", "0005_remove_outstandingtoken_jti"),
     ]
diff --git a/ninja_jwt/token_blacklist/migrations/0007_auto_20171017_2214.py b/ninja_jwt/token_blacklist/migrations/0007_auto_20171017_2214.py
@@ -4,7 +4,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("token_blacklist", "0006_auto_20171017_2113"),
     ]
diff --git a/ninja_jwt/token_blacklist/migrations/0008_migrate_to_bigautofield.py b/ninja_jwt/token_blacklist/migrations/0008_migrate_to_bigautofield.py
@@ -2,7 +2,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("token_blacklist", "0007_auto_20171017_2214"),
     ]
diff --git a/ninja_jwt/token_blacklist/migrations/0010_fix_migrate_to_bigautofield.py b/ninja_jwt/token_blacklist/migrations/0010_fix_migrate_to_bigautofield.py
@@ -8,7 +8,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         ("token_blacklist", "0008_migrate_to_bigautofield"),
     ]
diff --git a/ninja_jwt/token_blacklist/migrations/0012_alter_outstandingtoken_user.py b/ninja_jwt/token_blacklist/migrations/0012_alter_outstandingtoken_user.py
@@ -6,7 +6,6 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
         migrations.swappable_dependency(settings.AUTH_USER_MODEL),
         ("token_blacklist", "0011_linearizes_history"),
diff --git a/ninja_jwt/tokens.py b/ninja_jwt/tokens.py
@@ -42,8 +42,8 @@ def __init__(self, token: Optional[Any] = None, verify: bool = True) -> None:
             # Decode token
             try:
                 self.payload = token_backend.decode(token, verify=verify)
-            except TokenBackendError:
-                raise TokenError(_("Token is invalid or expired"))
+            except TokenBackendError as e:
+                raise TokenError(_("Token is invalid or expired")) from e
 
             if verify:
                 self.verify()
@@ -112,8 +112,8 @@ def verify_token_type(self) -> Any:
         """
         try:
             token_type = self.payload[api_settings.TOKEN_TYPE_CLAIM]
-        except KeyError:
-            raise TokenError(_("Token has no type"))
+        except KeyError as e:
+            raise TokenError(_("Token has no type")) from e
 
         if self.token_type != token_type:
             raise TokenError(_("Token has wrong type"))
@@ -172,8 +172,8 @@ def check_exp(self, claim: str = "exp", current_time: Optional[datetime] = None)
 
         try:
             claim_value = self.payload[claim]
-        except KeyError:
-            raise TokenError(format_lazy(_("Token has no '{}' claim"), claim))
+        except KeyError as e:
+            raise TokenError(format_lazy(_("Token has no '{}' claim"), claim)) from e
 
         claim_time = datetime_from_epoch(claim_value)
         leeway = self.get_token_backend().get_leeway()
diff --git a/ninja_jwt/utils.py b/ninja_jwt/utils.py
@@ -20,7 +20,7 @@ def _wrap(*args, **kwargs):
         try:
             return func(*args, **kwargs)
         except exceptions.TokenError as tex:
-            raise exceptions.InvalidToken(str(tex))
+            raise exceptions.InvalidToken(str(tex)) from tex
         except Exception as ex:
             logger.error(f"{func} raised exception: {str(ex)}")
             raise ex
@@ -29,7 +29,7 @@ def _wrap(*args, **kwargs):
 
 
 def import_callable(path_or_callable):
-    if hasattr(path_or_callable, "__call__"):
+    if callable(path_or_callable):
         return path_or_callable
     else:
         assert isinstance(path_or_callable, string_types)
diff --git a/pyproject.toml b/pyproject.toml
@@ -67,9 +67,8 @@ test = [
     "pytest-cov",
     "pytest-django",
     "pytest-asyncio",
-    "black==21.12b0",
-    "isort >=5.0.6,<6.0.0",
-    "flake8 >=3.8.3,<7.0.0",
+    "ruff ==0.0.275",
+    "black == 23.7.0",
     "django-stubs",
     "python-jose==3.3.0",
     "click==8.0.4"
@@ -91,3 +90,25 @@ doc = [
 "mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0",
 "mkdocstrings"
 ]
+
+
+[tool.ruff]
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "B008",  # do not perform function calls in argument defaults
+    "C901",  # too complex
+]
+
+[tool.ruff.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.isort]
+known-third-party = ["django-ninja-extra",]
diff --git a/tests/test_backends.py b/tests/test_backends.py
@@ -6,7 +6,8 @@
 
 import jwt
 import pytest
-from jwt import PyJWS, __version__ as jwt_version, algorithms
+from jwt import PyJWS, algorithms
+from jwt import __version__ as jwt_version
 
 from ninja_jwt.backends import JWK_CLIENT_AVAILABLE, TokenBackend
 from ninja_jwt.exceptions import TokenBackendError
diff --git a/tests/test_custom_schema.py b/tests/test_custom_schema.py
@@ -1,6 +1,6 @@
 import importlib
 from datetime import timedelta
-from typing import Dict, Type
+from typing import Dict
 from unittest.mock import patch
 
 import pytest
@@ -62,7 +62,6 @@ class MyNewObtainTokenSlidingSchemaInput(TokenObtainSlidingInputSchema):
     my_extra_field: str
 
     def check_user_authentication_rule(self) -> bool:
-        my_extra_field = self.my_extra_field
         return api_settings.USER_AUTHENTICATION_RULE(self._user)
 
     @classmethod
@@ -73,7 +72,7 @@ def to_response_schema(self):
         return MyNewObtainTokenSlidingSchemaOutput(
             first_name=self._user.first_name,
             last_name=self._user.last_name,
-            **self.dict(exclude={"password"})
+            **self.dict(exclude={"password"}),
         )
 
 
diff --git a/tests/test_models.py b/tests/test_models.py
@@ -1,5 +1,4 @@
 import pytest
-from django.test import TestCase
 
 from ninja_jwt.models import TokenUser
 from ninja_jwt.settings import api_settings
diff --git a/tests/test_token_blacklist.py b/tests/test_token_blacklist.py
@@ -5,7 +5,7 @@
 from django.core.management import call_command
 from django.db.models import BigAutoField
 
-from ninja_jwt.exceptions import TokenError
+from ninja_jwt.exceptions import TokenError, ValidationError
 from ninja_jwt.schema import TokenVerifyInputSchema
 from ninja_jwt.settings import api_settings
 from ninja_jwt.token_blacklist.models import BlacklistedToken, OutstandingToken
@@ -220,7 +220,7 @@ def test_token_verify_serializer_should_honour_blacklist_if_blacklisting_enabled
             refresh_token = RefreshToken.for_user(self.user)
             refresh_token.blacklist()
 
-            with pytest.raises(Exception):
+            with pytest.raises(ValidationError):
                 TokenVerifyInputSchema(token=str(refresh_token))
 
     def test_token_verify_serializer_should_not_honour_blacklist_if_blacklisting_not_enabled(
diff --git a/tests/utils.py b/tests/utils.py
@@ -13,8 +13,8 @@ def wrapper_method(self, *args, url=None, **kwargs):
         if not url and self.view_name is None:
             raise ValueError("Must give value for `view_name` property")
 
-        reverse_args = kwargs.pop("reverse_args", tuple())
-        reverse_kwargs = kwargs.pop("reverse_kwargs", dict())
+        reverse_args = kwargs.pop("reverse_args", ())
+        reverse_kwargs = kwargs.pop("reverse_kwargs", {})
         query_string = kwargs.pop("query_string", None)
 
         if self.header:
@@ -28,7 +28,7 @@ def wrapper_method(self, *args, url=None, **kwargs):
         response = getattr(self.client, action)(_url, *args, **kwargs)
         try:
             response.data = json.loads(response.content)
-        except (Exception,):
+        except Exception:
             pass
         return response
 
@@ -37,7 +37,7 @@ def wrapper_method(self, *args, url=None, **kwargs):
 
 class APIViewTestCase:
     client_class = Client
-    header = dict()
+    header = {}
 
     def setUp(self):
         self.client = self.client_class()
@@ -46,7 +46,7 @@ def authenticate_with_token(self, type, token):
         """
         Authenticates requests with the given token.
         """
-        self.header = dict(HTTP_AUTHORIZATION="{} {}".format(type, token))
+        self.header = {"HTTP_AUTHORIZATION": "{} {}".format(type, token)}
 
     view_name = None
 

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`
`3`	`3`
`4`	`4`	`class Migration(migrations.Migration):`
`5`		`-`
`6`	`5`	`dependencies = [`
`7`	`6`	`("token_blacklist", "0001_initial"),`
`8`	`7`	`]`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,6 @@ def reverse_populate_jti_hex(apps, schema_editor): # pragma: no cover`
`22`	`22`
`23`	`23`
`24`	`24`	`class Migration(migrations.Migration):`
`25`		`-`
`26`	`25`	`dependencies = [`
`27`	`26`	`("token_blacklist", "0002_outstandingtoken_jti_hex"),`
`28`	`27`	`]`