[LINT] black & isort & mypy compatable update

bnbong · bnbong · commit 0d4d0bc2f1f8 · 2025-01-14T15:01:39.000+09:00
diff --git a/pyproject.toml b/pyproject.toml
@@ -53,6 +53,9 @@ dev = [
 testpaths = ["test"]
 python_files = "test_*.py"
 
+[tool.isort]
+profile = "black"
+
 [tool.mypy]
 strict = true
 
diff --git a/scripts/format.sh b/scripts/format.sh
@@ -5,4 +5,4 @@ set -x
 base_dir=$(dirname $(dirname $0))
 
 black --config "${base_dir}/pyproject.toml" --check .
-black .
+black --config "${base_dir}/pyproject.toml" .
diff --git a/scripts/lint.sh b/scripts/lint.sh
@@ -5,6 +5,7 @@ set -x
 base_dir=$(dirname $(dirname $0))
 
 isort --sp "${base_dir}/pyproject.toml" --check .
+isort --sp "${base_dir}/pyproject.toml" .
 
 black --config "${base_dir}/pyproject.toml" --check .
 
diff --git a/src/fastapi_fastkit/__init__.py b/src/fastapi_fastkit/__init__.py
@@ -1 +1,10 @@
 __version__ = "0.0.1"
+
+import os
+
+from rich.console import Console
+
+if "PYTEST_CURRENT_TEST" in os.environ:
+    console = Console(no_color=True)
+else:
+    console = Console()
diff --git a/src/fastapi_fastkit/backend.py b/src/fastapi_fastkit/backend.py
@@ -3,27 +3,22 @@
 #
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
-import re
 import os
-import click
-
+import re
+from logging import getLogger
 from typing import Any
 
-from logging import getLogger
+import click
 from click.core import Context
 from rich.panel import Panel
-from rich.console import Console
-from rich.text import Text
 from rich.table import Table
+from rich.text import Text
 
 from fastapi_fastkit.core.exceptions import TemplateExceptions
 
-logger = getLogger(__name__)
+from . import console
 
-if "PYTEST_CURRENT_TEST" in os.environ:
-    console = Console(no_color=True)
-else:
-    console = Console()
+logger = getLogger(__name__)
 
 REGEX = r"\b[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Z|a-z]{2,7}\b"
 
diff --git a/src/fastapi_fastkit/cli.py b/src/fastapi_fastkit/cli.py
@@ -4,40 +4,34 @@
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
 import os
-import click
-import subprocess
 import shutil
-
-from typing import Union
-
+import subprocess
 from logging import getLogger
+from typing import Union
 
+import click
 from click.core import BaseCommand, Context
-
 from rich import print
 from rich.panel import Panel
-from rich.console import Console
 
-from . import __version__
+from fastapi_fastkit.core.exceptions import CLIExceptions
+from fastapi_fastkit.core.settings import FastkitConfig
+from fastapi_fastkit.utils.inspector import delete_project
+from fastapi_fastkit.utils.logging import setup_logging
+from fastapi_fastkit.utils.transducer import copy_and_convert_template
+
+from . import __version__, console
 from .backend import (
-    validate_email,
+    create_info_table,
     inject_project_metadata,
     print_error,
     print_success,
     print_warning,
-    create_info_table,
+    validate_email,
 )
-from fastapi_fastkit.utils.logging import setup_logging
-from fastapi_fastkit.core.settings import FastkitConfig
-from fastapi_fastkit.core.exceptions import CLIExceptions
-from fastapi_fastkit.utils.transducer import copy_and_convert_template
-from fastapi_fastkit.utils.inspector import delete_project
-
 
 logger = getLogger(__name__)
 
-console = Console()
-
 
 @click.group()
 @click.option("--debug/--no-debug", default=False)
@@ -401,7 +395,7 @@ def runserver(
 ) -> None:
     """
     Run the FastAPI server for the current project.
-    [TODO] Alternative Point : using FastAPI-fastkit's 'fastapi dev' command
+    [1.1.0 update TODO] Alternative Point : using FastAPI-fastkit's 'fastapi dev' command
 
     :param ctx: Click context object
     :param host: Host address to bind the server to
diff --git a/src/fastapi_fastkit/core/settings.py b/src/fastapi_fastkit/core/settings.py
@@ -4,7 +4,6 @@
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
 import os
-
 from pathlib import Path
 
 from .exceptions import BackendExceptions
@@ -37,7 +36,7 @@ def __get_fastapi_fastkit_root() -> Path:
         For installed package: returns the package installation directory
         """
         try:
-            import fastapi_fastkit  # pylint: disable=import-outside-toplevel
+            import fastapi_fastkit
 
             package_root = Path(fastapi_fastkit.__file__).parent.parent
             if package_root.name == "site-packages":
@@ -55,7 +54,7 @@ def __get_template_root() -> Path:
         For installed package: returns the package template directory
         """
         try:
-            import fastapi_fastkit  # pylint: disable=import-outside-toplevel
+            import fastapi_fastkit
 
             package_root = Path(fastapi_fastkit.__file__).parent
             template_dir = package_root / "fastapi_project_template"
diff --git a/src/fastapi_fastkit/utils/logging.py b/src/fastapi_fastkit/utils/logging.py
@@ -4,7 +4,6 @@
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
 import logging
-
 from typing import Union
 
 from rich.console import Console
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -5,13 +5,15 @@
 # --------------------------------------------------------------------------
 import os
 import shutil
+from typing import Generator
+
 import pytest
 
 from fastapi_fastkit.core.settings import FastkitConfig
 
 
 @pytest.fixture(autouse=True, scope="session")
-def temp_dir():
+def temp_dir() -> Generator[str, None, None]:
     """
     Fixture that creates a temporary directory for test cases and yields its path.
     After tests are done, the directory is removed.
diff --git a/tests/test_backends/test_configure.py b/tests/test_backends/test_configure.py
@@ -4,7 +4,6 @@
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
 import os
-
 from pathlib import Path
 
 from click.testing import CliRunner
diff --git a/tests/test_cli_operations/test_cli.py b/tests/test_cli_operations/test_cli.py
@@ -5,9 +5,10 @@
 # @author bnbong bbbong9@gmail.com
 # --------------------------------------------------------------------------
 import os
+from pathlib import Path
+from typing import Any
 
 from click.testing import CliRunner
-from pathlib import Path
 
 from fastapi_fastkit.cli import fastkit_cli
 
@@ -17,14 +18,14 @@ def setup_method(self) -> None:
         self.runner = CliRunner()
         self.current_workspace = os.getcwd()
 
-    def teardown_method(self, console) -> None:
+    def teardown_method(self, console: Any) -> None:
         os.chdir(self.current_workspace)
 
     def test_echo(self) -> None:
         # given
 
         # when
-        result = self.runner.invoke(fastkit_cli, ["echo"])  # type: ignore
+        result = self.runner.invoke(fastkit_cli, ["echo"])
 
         # then
         assert "About FastAPI-fastkit" in result.output
@@ -33,13 +34,13 @@ def test_echo(self) -> None:
         assert "Project Maintainer : bnbong(JunHyeok Lee)" in result.output
         assert "Github : https://github.com/bnbong/FastAPI-fastkit" in result.output
 
-    def test_startup(self, temp_dir) -> None:
+    def test_startup(self, temp_dir: str) -> None:
         # given
         os.chdir(temp_dir)
 
         # when
         result = self.runner.invoke(
-            fastkit_cli,  # type: ignore
+            fastkit_cli,
             ["startup", "fastapi-default"],
             input="\n".join(
                 ["test-project", "bnbong", "bbbong9@gmail.com", "test project", "Y"]
@@ -70,12 +71,12 @@ def test_startup(self, temp_dir) -> None:
             assert "bnbong" in setup_py_content
             assert "bbbong9@gmail.com" in setup_py_content
 
-    def test_deleteproject(self, temp_dir) -> None:
+    def test_deleteproject(self, temp_dir: str) -> None:
         # given
         os.chdir(temp_dir)
         project_name = "test-project"
         result = self.runner.invoke(
-            fastkit_cli,  # type: ignore
+            fastkit_cli,
             ["startup", "fastapi-default"],
             input="\n".join(
                 [project_name, "bnbong", "bbbong9@gmail.com", "test project", "Y"]
@@ -87,7 +88,7 @@ def test_deleteproject(self, temp_dir) -> None:
 
         # when
         result = self.runner.invoke(
-            fastkit_cli,  # type: ignore
+            fastkit_cli,
             ["deleteproject", project_name],
             input="Y",
         )
@@ -96,26 +97,26 @@ def test_deleteproject(self, temp_dir) -> None:
         assert "Success" in result.output
         assert not project_path.exists()
 
-    def test_list_templates(self, temp_dir) -> None:
+    def test_list_templates(self, temp_dir: str) -> None:
         # given
         os.chdir(temp_dir)
 
         # when
-        result = self.runner.invoke(fastkit_cli, ["list-templates"])  # type: ignore
+        result = self.runner.invoke(fastkit_cli, ["list-templates"])
 
         # then
         assert "Available Templates" in result.output
         assert "fastapi-default" in result.output
         assert "fastapi-dockerized" in result.output
 
-    def test_startproject_minimal(self, temp_dir) -> None:
+    def test_startproject_minimal(self, temp_dir: str) -> None:
         # given
         os.chdir(temp_dir)
         project_name = "test-minimal"
 
         # when
         result = self.runner.invoke(
-            fastkit_cli,  # type: ignore
+            fastkit_cli,
             ["startproject"],
             input="\n".join([project_name, "minimal"]),
         )
@@ -140,14 +141,14 @@ def test_startproject_minimal(self, temp_dir) -> None:
         venv_path = project_path / "venv"
         assert venv_path.exists() and venv_path.is_dir()
 
-    def test_startproject_full(self, temp_dir) -> None:
+    def test_startproject_full(self, temp_dir: str) -> None:
         # given
         os.chdir(temp_dir)
         project_name = "test-full"
 
         # when
         result = self.runner.invoke(
-            fastkit_cli,  # type: ignore
+            fastkit_cli,
             ["startproject"],
             input="\n".join([project_name, "full"]),
         )
@@ -173,15 +174,15 @@ def test_startproject_full(self, temp_dir) -> None:
         venv_path = project_path / "venv"
         assert venv_path.exists() and venv_path.is_dir()
 
-    def test_startproject_existing_project(self, temp_dir) -> None:
+    def test_startproject_existing_project(self, temp_dir: str) -> None:
         # given
         os.chdir(temp_dir)
         project_name = "test-existing"
         os.makedirs(os.path.join(temp_dir, project_name))
 
         # when
         result = self.runner.invoke(
-            fastkit_cli,  # type: ignore
+            fastkit_cli,
             ["startproject"],
             input="\n".join([project_name, "minimal"]),
         )
@@ -190,14 +191,14 @@ def test_startproject_existing_project(self, temp_dir) -> None:
         assert "❌" in result.output
         assert f"Error: Project '{project_name}' already exists" in result.output
 
-    def test_is_fastkit_project(self, temp_dir) -> None:
+    def test_is_fastkit_project(self, temp_dir: str) -> None:
         # given
         os.chdir(temp_dir)
         project_name = "test-project"
 
         # Create a regular project
         result = self.runner.invoke(
-            fastkit_cli,  # type: ignore
+            fastkit_cli,
             ["startup", "fastapi-default"],
             input="\n".join(
                 [project_name, "bnbong", "bbbong9@gmail.com", "test project", "Y"]
diff --git a/tests/test_rich/__init__.py b/tests/test_rich/__init__.py
diff --git a/tests/test_rich/test_rich.py b/tests/test_rich/test_rich.py
@@ -0,0 +1,27 @@
+# --------------------------------------------------------------------------
+# Testcases of Rich library operations.
+#
+# @author bnbong bbbong9@gmail.com
+# --------------------------------------------------------------------------
+import os
+
+from click.testing import CliRunner
+
+
+class TestCLI:
+    def setup_method(self) -> None:
+        self.runner = CliRunner()
+        self.current_workspace = os.getcwd()
+
+    def teardown_method(self, console) -> None:
+        os.chdir(self.current_workspace)
+
+    def test_echo(self) -> None:
+        # given
+        from src.fastapi_fastkit.backend import print_success
+
+        # when
+        result = self.runner.invoke(print_success(message="this is test"))
+
+        # then
+        print(result)
