Merge pull request #9 from eadwinCode/linting_with_ruff

Linting with ruff

Author: eadwinCode

.github/workflows/test_full.yml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.7', '3.8', '3.9', '3.10', '3.11']
+        python-version: ['3.8', '3.9', '3.10', '3.11']
 
     steps:
       - uses: actions/checkout@v3
@@ -39,9 +39,7 @@ jobs:
         run: flit install --symlink
       - name: Black
         run: black --check ellar_throttler tests
-      - name: isort
-        run: isort --check ellar_throttler tests
-      - name: Flake8
-        run: flake8 ellar_throttler tests
+      - name: Ruff Lint Check
+        run: ruff check ellar_throttler tests
       - name: mypy
         run: mypy ellar_throttler

Makefile

@@ -19,14 +19,12 @@ install-full: ## Install dependencies
 
 lint: ## Run code linters
 	black --check ellar_throttler tests
-	isort --check ellar_throttler tests
-	autoflake --remove-unused-variables --remove-unused-variables -r ellar_throttler tests
-	flake8 ellar_throttler tests
+	ruff check ellar_throttler tests
 	mypy ellar_throttler
 
 fmt format: ## Run code formatters
 	black ellar_throttler tests
-	isort ellar_throttler tests
+	ruff check --fix ellar_throttler tests
 
 test: ## Run tests
 	pytest tests

README.md

@@ -1,8 +1,8 @@
 <p align="center">
-  <a href="#" target="blank"><img src="docs/img/EllarLogoIconOnly.png" width="200" alt="Ellar Logo" /></a>
+  <a href="#" target="blank"><img src="https://eadwincode.github.io/ellar/img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
 </p>
 
-<p align="center">A rate limiting module for Ellar</p>
+<p align="center">Ellar - Python ASGI web framework for building fast, efficient and scalable RESTful APIs and server-side application.</p>
 
 ![Test](https://github.com/eadwinCode/ellar-throttler/actions/workflows/test_full.yml/badge.svg)
 ![Coverage](https://img.shields.io/codecov/c/github/eadwinCode/ellar-throttler)

ellar_throttler/exception.py

@@ -11,7 +11,9 @@ class ThrottledException(APIException):
     extra_detail_singular = "Expected available in {wait} second."
     extra_detail_plural = "Expected available in {wait} seconds."
 
-    def __init__(self, wait: float = None, detail: t.Any = None) -> None:
+    def __init__(
+        self, wait: t.Optional[float] = None, detail: t.Optional[t.Any] = None
+    ) -> None:
         if detail is None:
             detail = self.default_detail
         if wait is not None:

ellar_throttler/module.py

@@ -16,8 +16,8 @@ def setup(
         cls,
         ttl: int,
         limit: int,
-        storage: t.Union[t.Type, t.Any] = None,
-        skip_if: t.Callable[[IExecutionContext], bool] = None,
+        storage: t.Union[t.Type, t.Any, None] = None,
+        skip_if: t.Optional[t.Callable[[IExecutionContext], bool]] = None,
     ) -> DynamicModule:
         if storage and isinstance(storage, IThrottlerStorage):
             _provider = ProviderConfig(IThrottlerStorage, use_value=storage)
@@ -28,7 +28,7 @@ def setup(
                 IThrottlerStorage, use_class=ThrottlerStorageService
             )
 
-        return DynamicModule(  # type:ignore
+        return DynamicModule(
             cls,
             providers=[
                 _provider,

ellar_throttler/throttler_service.py

@@ -84,7 +84,7 @@ def storage(self) -> t.Any:  # pragma: no cover
         return self._cache_service.get_backend()
 
     async def get_expiration_time(self, key: str) -> int:
-        result = await self._cache_service.get_async(f"{key}-ttl")
+        result: int = await self._cache_service.get_async(f"{key}-ttl")
         return math.floor(result - time.time()) if result else -1
 
     async def increment(self, key: str, ttl: int) -> ThrottlerStorageRecord:

pyproject.toml

@@ -12,7 +12,7 @@ authors = [
    {name = "Ezeudoh Tochukwu", email = "[email protected]"},
 ]
 dynamic = ["version", "description"]
-requires-python = ">=3.7"
+requires-python = ">=3.8"
 readme = "README.md"
 home-page = "https://github.com/eadwinCode/ellar-throttler"
 classifiers = [
@@ -29,7 +29,6 @@ classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.7",
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
@@ -54,13 +53,33 @@ Homepage = "https://eadwincode.github.io/ellar-throttler/"
 test = [
     "pytest >= 7.1.3,<8.0.0",
     "pytest-cov >= 2.12.0,<5.0.0",
-    "mypy == 0.971",
-    "flake8 >= 3.8.3,<7.0.0",
+    "mypy == 1.4.1",
+    "ruff ==0.0.275",
     "black ==22.8.0",
-    "isort >=5.0.6,<6.0.0",
     "pytest-asyncio",
     "autoflake",
 ]
 dev = [
     "pre-commit"
 ]
+
+[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 = ["ellar",]

tests/test_throttler.py

@@ -94,7 +94,7 @@ def test_skip_configure(self):
         )
 
         _client = test_module.get_test_client()
-        for i in range(15):
+        for _i in range(15):
             res = _client.get("/")
 
             assert res.status_code == 200
@@ -115,7 +115,7 @@ class TestThrottlerStorageServiceConfiguration:
             ControllerModule,
         ),
         global_guards=[ThrottlerGuard],
-        config_module=dict(CACHES={"default": LocalMemCacheBackend()}),
+        config_module={"CACHES": {"default": LocalMemCacheBackend()}},
     )
 
     test_module_use_value = Test.create_test_module(