Merge pull request #6 from eadwinCode/mypy_fix

MyPy Upgrade

Author: eadwinCode

.github/workflows/test_full.yml

@@ -42,9 +42,7 @@ jobs:
         run: flit install --symlink
       - name: Black
         run: black --check ellar_django tests
-      - name: isort
-        run: isort --check ellar_django tests
-      - name: Flake8
-        run: flake8 ellar_django tests
+      - name: Ruff Linting Check
+        run: ruff check ellar_django tests
       - name: mypy
         run: mypy ellar_django

Makefile

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

README.md

@@ -1,15 +1,17 @@
 <p align="center">
   <a href="#" target="blank"><img src="https://eadwincode.github.io/ellar/img/EllarLogoB.png" width="200" alt="Ellar Logo" /></a>
 </p>
-
-A simple way to use Django ORM with Ellar
+<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-django-module/actions/workflows/test_full.yml/badge.svg)
 ![Coverage](https://img.shields.io/codecov/c/github/eadwinCode/ellar-django-module)
 [![PyPI version](https://badge.fury.io/py/ellar-django-module.svg)](https://badge.fury.io/py/ellar-django-module)
 [![PyPI version](https://img.shields.io/pypi/v/ellar-django-module.svg)](https://pypi.python.org/pypi/ellar-django-module)
 [![PyPI version](https://img.shields.io/pypi/pyversions/ellar-django-module.svg)](https://pypi.python.org/pypi/ellar-django-module)
 
+## Introduction
+A simple way to add use Django ORM with Ellar
+
 ## Installation
 ```shell
 pip install ellar-django-module

ellar_django/commands.py

@@ -14,7 +14,7 @@
 
 @command(
     name="django",
-    context_settings=dict(ignore_unknown_options=True, allow_extra_args=True),
+    context_settings={"ignore_unknown_options": True, "allow_extra_args": True},
     help=HELP_MESSAGE,
 )
 def django_command_wrapper() -> None:

ellar_django/module.py

@@ -27,4 +27,4 @@ def setup(cls, settings_module: str, path_prefix: str = "/dj") -> "DynamicModule
         mount = Mount(
             path_prefix, routes=[_router, Mount("/", app=get_asgi_application())]
         )
-        return DynamicModule(cls, routers=[mount], commands=[django_command_wrapper])  # type: ignore
+        return DynamicModule(cls, routers=[mount], commands=[django_command_wrapper])

mypy.ini

@@ -1,5 +1,5 @@
 [mypy]
-python_version = 3.6
+python_version = 3.8
 
 show_column_numbers = True
 

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-django-module"
 classifiers = [
@@ -62,13 +62,33 @@ test = [
     "pytest >= 7.1.3,<8.0.0",
     "pytest-django",
     "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", "Django"]

tests/example_app/root_module.py

@@ -23,7 +23,7 @@
 class ApplicationModule(ModuleBase):
     @exception_handler(404)
     def exception_404_handler(cls, ctx: IExecutionContext, exc: Exception) -> Response:
-        return JSONResponse(dict(detail="Resource not found."))
+        return JSONResponse({"detail": "Resource not found."})
 
     def register_services(self, container: Container) -> None:
         from .services.event_repository import EventRepository

tests/example_app/services/event_repository.py

@@ -9,11 +9,11 @@
 
 @injectable
 class EventRepository(IEventRepository):
-    _dummy_data = dict(
-        title="TestEvent1Title",
-        start_date=str(datetime.now().date()),
-        end_date=str((datetime.now() + timedelta(days=5)).date()),
-    )
+    _dummy_data = {
+        "title": "TestEvent1Title",
+        "start_date": str(datetime.now().date()),
+        "end_date": str((datetime.now() + timedelta(days=5)).date()),
+    }
 
     def create_dummy_events(self):
         for i in range(3):

tests/test_event_controller.py

@@ -11,11 +11,11 @@ class TestEventController:
     def test_create_event_works(self, client):
         response = client.post(
             "/event/",
-            json=dict(
-                title="TestEvent1Title",
-                start_date=str(datetime.now().date()),
-                end_date=str((datetime.now() + timedelta(days=5)).date()),
-            ),
+            json={
+                "title": "TestEvent1Title",
+                "start_date": str(datetime.now().date()),
+                "end_date": str((datetime.now() + timedelta(days=5)).date()),
+            },
         )
         assert response.status_code == 201
         data = response.json()