added ruff for lintering

eadwinCode · eadwinCode · commit 3efcc48ba6f3 · 2023-08-08T16:13:27.000+01:00
diff --git a/.github/workflows/test_full.yml b/.github/workflows/test_full.yml
@@ -39,9 +39,7 @@ jobs:
         run: flit install --symlink
       - name: Black
         run: black --check ellar_cli tests
-      - name: isort
-        run: isort --check ellar_cli tests
-      - name: Flake8
-        run: flake8 ellar_cli tests
+      - name: Ruff linting check
+        run: ruff check ellar_cli tests
       - name: mypy
         run: mypy ellar_cli
diff --git a/Makefile b/Makefile
@@ -19,14 +19,12 @@ install-full: ## Install dependencies
 
 lint: ## Run code linters
 	black --check ellar_cli tests
-	isort --check ellar_cli tests
-	autoflake --remove-unused-variables --remove-unused-variables -r ellar_cli tests
-	flake8 ellar_cli tests
+	ruff check ellar_cli tests
 	mypy ellar_cli
 
 fmt format: ## Run code formatters
 	black ellar_cli tests
-	isort ellar_cli tests
+	ruff check --fix ellar_cli tests
 
 test: ## Run tests
 	pytest tests
diff --git a/ellar_cli/file_scaffolding.py b/ellar_cli/file_scaffolding.py
@@ -25,7 +25,7 @@ def __init__(
         working_project_name: str,
         working_directory: str,
         scaffold_ellar_template_root_path: str,
-        specified_directory: str = None,
+        specified_directory: t.Optional[str] = None,
     ) -> None:
         self._specified_directory = specified_directory
         self._schema = schema
@@ -96,9 +96,9 @@ def create_directory(
         if file.is_directory:
             new_scaffold_dir = os.path.join(working_directory, name)
             os.makedirs(new_scaffold_dir, exist_ok=True)
-            for file in file.files or []:
+            for _file in file.files:
                 self.create_directory(
-                    file=file,
+                    file=_file,
                     working_directory=new_scaffold_dir,
                     scaffold_ellar_template_path=scaffold_template_path,
                 )
diff --git a/ellar_cli/manage_commands/create_module.py b/ellar_cli/manage_commands/create_module.py
@@ -68,7 +68,7 @@ def validate_project_name(self) -> None:
                 sys.path.remove(self._working_directory)
 
     def get_scaffolding_context(self, working_project_name: str) -> t.Dict:
-        template_context = dict(module_name=working_project_name)
+        template_context = {"module_name": working_project_name}
         return template_context
 
 
diff --git a/ellar_cli/manage_commands/create_project.py b/ellar_cli/manage_commands/create_project.py
@@ -27,9 +27,10 @@ def __init__(self, ellar_cli_service: EllarCLIService, **kwargs: t.Any) -> None:
         self.ellar_cli_service = ellar_cli_service
 
     def get_scaffolding_context(self, working_project_name: str) -> t.Dict:
-        template_context = dict(
-            project_name=working_project_name, secret_key=f"ellar_{uuid.uuid4()}"
-        )
+        template_context = {
+            "project_name": working_project_name,
+            "secret_key": f"ellar_{uuid.uuid4()}",
+        }
         return template_context
 
     def validate_project_name(self) -> None:
diff --git a/ellar_cli/manage_commands/new.py b/ellar_cli/manage_commands/new.py
@@ -110,9 +110,10 @@ def validate_project_name(self) -> None:
             raise EllarCLIException(message)
 
     def get_scaffolding_context(self, working_project_name: str) -> t.Dict:
-        template_context = dict(
-            folder_name=working_project_name, project_name=self.get_project_name()
-        )
+        template_context = {
+            "folder_name": working_project_name,
+            "project_name": self.get_project_name(),
+        }
         return template_context
 
     def get_project_name(self) -> str:
diff --git a/ellar_cli/manage_commands/runserver.py b/ellar_cli/manage_commands/runserver.py
@@ -4,7 +4,6 @@
 from pathlib import Path
 
 import typer
-from ellar.common.constants import LOG_LEVELS
 from ellar.common.helper.enums import create_enums_from_list
 from h11._connection import DEFAULT_MAX_INCOMPLETE_EVENT_SIZE
 from uvicorn.config import (
@@ -255,50 +254,50 @@ def runserver(
 
     _log_level = log_level if log_level else _log_level or LOG_LEVELS.info
 
-    init_kwargs = dict(
-        host=host,
-        port=port,
-        uds=uds,
-        fd=fd,
-        loop=loop.value,
-        http=http.value,
-        ws=ws.value,
-        ws_max_size=ws_max_size,
-        ws_ping_interval=ws_ping_interval,
-        ws_ping_timeout=ws_ping_timeout,
-        lifespan=lifespan.value,
-        env_file=env_file,
-        log_config=LOGGING_CONFIG if log_config is None else log_config,
-        log_level=_log_level.value if _log_level.value != "NOT_SET" else None,
-        access_log=access_log,
-        interface=interface.value,
-        reload=reload,
-        reload_dirs=reload_dirs or None,
-        reload_includes=reload_includes or None,
-        reload_excludes=reload_excludes or None,
-        reload_delay=reload_delay,
-        workers=workers,
-        proxy_headers=proxy_headers,
-        server_header=server_header,
-        date_header=date_header,
-        forwarded_allow_ips=forwarded_allow_ips,
-        root_path=root_path,
-        limit_concurrency=limit_concurrency,
-        backlog=backlog,
-        limit_max_requests=limit_max_requests,
-        timeout_keep_alive=timeout_keep_alive,
-        ssl_keyfile=ssl_keyfile,
-        ssl_certfile=ssl_certfile,
-        ssl_keyfile_password=ssl_keyfile_password,
-        ssl_version=ssl_version,
-        ssl_cert_reqs=ssl_cert_reqs,
-        ssl_ca_certs=ssl_ca_certs,
-        ssl_ciphers=ssl_ciphers,
-        headers=[header.split(":", 1) for header in headers],
-        use_colors=use_colors,
-        factory=factory,
-        app_dir=app_dir,
-    )
+    init_kwargs = {
+        "host": host,
+        "port": port,
+        "uds": uds,
+        "fd": fd,
+        "loop": loop.value,
+        "http": http.value,
+        "ws": ws.value,
+        "ws_max_size": ws_max_size,
+        "ws_ping_interval": ws_ping_interval,
+        "ws_ping_timeout": ws_ping_timeout,
+        "lifespan": lifespan.value,
+        "env_file": env_file,
+        "log_config": LOGGING_CONFIG if log_config is None else log_config,
+        "log_level": _log_level.value if _log_level.value != "NOT_SET" else None,
+        "access_log": access_log,
+        "interface": interface.value,
+        "reload": reload,
+        "reload_dirs": reload_dirs or None,
+        "reload_includes": reload_includes or None,
+        "reload_excludes": reload_excludes or None,
+        "reload_delay": reload_delay,
+        "workers": workers,
+        "proxy_headers": proxy_headers,
+        "server_header": server_header,
+        "date_header": date_header,
+        "forwarded_allow_ips": forwarded_allow_ips,
+        "root_path": root_path,
+        "limit_concurrency": limit_concurrency,
+        "backlog": backlog,
+        "limit_max_requests": limit_max_requests,
+        "timeout_keep_alive": timeout_keep_alive,
+        "ssl_keyfile": ssl_keyfile,
+        "ssl_certfile": ssl_certfile,
+        "ssl_keyfile_password": ssl_keyfile_password,
+        "ssl_version": ssl_version,
+        "ssl_cert_reqs": ssl_cert_reqs,
+        "ssl_ca_certs": ssl_ca_certs,
+        "ssl_ciphers": ssl_ciphers,
+        "headers": [header.split(":", 1) for header in headers],
+        "use_colors": use_colors,
+        "factory": factory,
+        "app_dir": app_dir,
+    }
     if sys.version_info >= (3, 7):
         init_kwargs.update(
             h11_max_incomplete_event_size=h11_max_incomplete_event_size,
diff --git a/ellar_cli/scaffolding/scaffolding_json_validator.py b/ellar_cli/scaffolding/scaffolding_json_validator.py
@@ -39,9 +39,9 @@ def _check_directory_file_exist(
                     f"Scaffolding Folder: {file.name} @{scaffold_ellar_template_path} is not a Directory"
                 )
 
-            for file in file.files or []:
+            for _file in file.files:
                 self._check_directory_file_exist(
-                    file=file,
+                    file=_file,
                     scaffold_ellar_template_path=scaffold_template_path,
                 )
         else:
diff --git a/ellar_cli/schema.py b/ellar_cli/schema.py
@@ -15,7 +15,7 @@ class EllarScaffoldList(Serializer):
     name: str
     is_directory: bool = False
     name_in_context: t.Optional[bool] = Field(default=None, alias="name-context")
-    files: t.Optional[t.List["EllarScaffoldList"]]
+    files: t.List["EllarScaffoldList"] = Field(default=[])
 
 
 EllarScaffoldList.update_forward_refs()
@@ -30,14 +30,10 @@ def schema_example(cls) -> "EllarScaffoldSchema":
         return cls(
             context=["project_name"],
             files=[
-                dict(name="sample.ellar", is_directory=False),
-                dict(
-                    name="sample",
-                    files=[
-                        dict(
-                            dict(name="sample.ellar", is_directory=False),
-                        )
-                    ],
-                ),
+                {"name": "sample.ellar", "is_directory": False},
+                {
+                    "name": "sample",
+                    "files": [{"name": "sample.ellar", "is_directory": False}],
+                },
             ],
         )
diff --git a/ellar_cli/service.py b/ellar_cli/service.py
@@ -5,7 +5,9 @@
 from ellar.common.constants import ELLAR_CONFIG_MODULE
 from ellar.common.helper.importer import import_from_string
 from ellar.core import App, Config, ModuleBase
-from tomlkit import dumps as tomlkit_dumps, parse as tomlkit_parse, table
+from tomlkit import dumps as tomlkit_dumps
+from tomlkit import parse as tomlkit_parse
+from tomlkit import table
 from tomlkit.items import Table
 
 from ellar_cli.constants import ELLAR_PY_PROJECT
@@ -21,7 +23,7 @@ class EllarCLIException(ClickException):
 
 
 class EllarPyProject:
-    def __init__(self, ellar: Table = None) -> None:
+    def __init__(self, ellar: t.Optional[Table] = None) -> None:
         self._ellar = ellar if ellar is not None else table()
         self._projects = t.cast(
             Table, self._ellar.setdefault(ELLAR_PROJECTS_KEY, table())
@@ -76,7 +78,7 @@ def __init__(
         py_project_path: str,
         cwd: str,
         app_name: str = "ellar",
-        ellar_py_projects: EllarPyProject = None,
+        ellar_py_projects: t.Optional[EllarPyProject] = None,
     ) -> None:
         self._meta = meta
         self.py_project_path = py_project_path
@@ -171,7 +173,7 @@ def read_py_project(path: str) -> t.Optional[Table]:
         if os.path.exists(path):
             with open(path, mode="r") as fp:
                 table_content = tomlkit_parse(fp.read())
-                return table_content
+                return table_content  # type:ignore[return-value]
         return None
 
     @staticmethod
diff --git a/pyproject.toml b/pyproject.toml
@@ -59,13 +59,33 @@ Homepage = "https://eadwincode.github.io/ellar-cli/"
 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",]
diff --git a/tests/sample_app/example_project/root_module.py b/tests/sample_app/example_project/root_module.py
@@ -9,4 +9,4 @@
 class ApplicationModule(ModuleBase):
     @exception_handler(404)
     def exception_404_handler(cls, request: Request, exc: Exception) -> Response:
-        return JSONResponse(dict(detail="Resource not found."))
+        return JSONResponse({"detail": "Resource not found."})
diff --git a/tests/sample_app/example_project_2/root_module.py b/tests/sample_app/example_project_2/root_module.py
@@ -9,4 +9,4 @@
 class ApplicationModule(ModuleBase):
     @exception_handler(404)
     def exception_404_handler(cls, request: Request, exc: Exception) -> Response:
-        return JSONResponse(dict(detail="Resource not found."))
+        return JSONResponse({"detail": "Resource not found."})
diff --git a/tests/test_file_scaffolding.py b/tests/test_file_scaffolding.py
@@ -18,7 +18,7 @@ def __init__(self, *args, ellar_cli_service: EllarCLIService, **kwargs):
         super(DummyFileScaffolding, self).__init__(*args, **kwargs)
 
     def get_scaffolding_context(self, working_project_name: str):
-        return dict(whatever_name=working_project_name)
+        return {"whatever_name": working_project_name}
 
     def validate_project_name(self) -> None:
         self._validate_project_name_called = True
@@ -54,7 +54,7 @@ def test_validation_executed(tmp_path, write_empty_py_project):
     dummy.scaffold()
     assert dummy._validate_project_name_called
     assert isinstance(dummy._ctx.environment, Environment)
-    assert dummy._ctx == dict(whatever_name="dummy")
+    assert dummy._ctx == {"whatever_name": "dummy"}
 
 
 def test_on_scaffold_completed_on_scaffold_started_and_create_directory_executed(

Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,9 @@ def _check_directory_file_exist(`
`39`	`39`	`f"Scaffolding Folder: {file.name} @{scaffold_ellar_template_path} is not a Directory"`
`40`	`40`	`)`
`41`	`41`
`42`		`- for file in file.files or []:`
	`42`	`+ for _file in file.files:`
`43`	`43`	`self._check_directory_file_exist(`
`44`		`- file=file,`
	`44`	`+ file=_file,`
`45`	`45`	`scaffold_ellar_template_path=scaffold_template_path,`
`46`	`46`	`)`
`47`	`47`	`else:`