Merge pull request #6 from code-yeongyu/feature/improve-package

Author: code-yeongyu

.vscode/settings.json

@@ -22,19 +22,12 @@
     "python.linting.mypyArgs": [
         "--config-file ${workspaceFolder}/pyproject.toml"
     ],
-    "isort.path": [
-        "${workspaceFolder}/.venv/bin/isort"
-    ],
     "python.testing.pytestEnabled": true,
     "python.testing.pytestArgs": [
         "."
     ],
     "emeraldwalk.runonsave": {
         "commands": [
-            {
-                "match": "\\.py$",
-                "cmd": "${workspaceFolder}/.venv/bin/unify --in-place ${file}"
-            },
             {
                 "match": "\\.py$",
                 "cmd": "${workspaceFolder}/.venv/bin/pautoflake --in-place ${file}"

aishell/models/__init__.py

@@ -1 +1 @@
-from .open_ai_response_model import OpenAIResponseModel as OpenAIResponseModel
+from .open_ai_response_model import OpenAIResponseModel as OpenAIResponseModel

aishell/query_clients/gpt3_client.py

@@ -19,8 +19,7 @@ def _construct_prompt(self, text: str) -> str:
 
     def query(self, prompt: str) -> str:
         prompt = self._construct_prompt(prompt)
-
-        completion: OpenAIResponseModel = cast(
+        completion: OpenAIResponseModel = cast(  # type: ignore [no-any-unimported]
             OpenAIResponseModel,
             openai.Completion.create(
                 engine='text-davinci-003',

aishell/tests/sample_test.py

@@ -1,2 +1,4 @@
 def test_one_plus_one():
-    assert 1 + 1 == 2
+    one = 1
+    two = 2
+    assert one + one == two

aishell/utils/__init__.py

@@ -1 +1 @@
-from .make_executable_command import make_executable_command as make_executable_command
+from .make_executable_command import make_executable_command as make_executable_command

aishell/utils/make_executable_command.py

@@ -1,6 +1,4 @@
 def make_executable_command(command: str) -> str:
-    # starting '\n' or trailing '\n' should be replaced as ''
-    # starting ' ' or trailing ' ' should be replaced as ''
     if command.startswith('\n'):
         command = command[1:]
     if command.endswith('\n'):

monkey_patch_invoke.py

@@ -9,13 +9,13 @@
 def monkey_patch_invoke() -> None:
 
     def _patched_argspec(
-        self: Any,    # pylint: disable=unused-argument
+        self: Any,  # pylint: disable=unused-argument
         body: Union[Callable[[Context], None], Context],
     ) -> Tuple[List[str], Dict[str, object]]:
-        """
+        '''
         A monkey patching code for supporting python3
         from: https://github.com/pyinvoke/invoke/issues/357#issuecomment-1250744013
-        """
+        '''
         signature: inspect.Signature = inspect.Signature()
         if isinstance(body, types.FunctionType):
             signature = inspect.signature(body)
@@ -37,7 +37,7 @@ def _patched_argspec(
         del argument_specs[context_arg]
         return parameter_names, argument_specs
 
-    Task.argspec = _patched_argspec
+    Task.argspec = _patched_argspec  # type: ignore
 
 
 monkey_patch_invoke()

poetry.lock

@@ -10,7 +10,7 @@ authors = []
 readme = "README.md"
 
 [tool.mypy]
-strict = true
+strict = false
 show_error_codes = true
 show_column_numbers = true
 warn_unused_ignores = true
@@ -20,8 +20,8 @@ namespace_packages = true
 allow_redefinition = true
 implicit_reexport = false
 no_implicit_optional = true
-warn_return_any = true
-disallow_any_expr = true
+warn_return_any = false
+disallow_any_expr = false
 disallow_any_unimported = true
 check_untyped_defs = true
 allow_incomplete_defs = true
@@ -48,7 +48,7 @@ reportUnknownMemberType = false
 
 [tool.yapf]
 based_on_style = "pep8"
-spaces_before_comment = 4
+spaces_before_comment = 2
 split_before_logical_operator = true
 column_limit = 119
 allow_split_before_dict_value = false
@@ -86,14 +86,12 @@ multiline-quotes = "single"
 [tool.poetry.group.dev.dependencies]
 toml = "^0.10.2"
 yapf = "^0.32.0"
-unify = "^0.5"
 pytest = "^7.2.0"
 pytest-cov = "^4.0.0"
 mypy = "^0.991"
-pyright = "^1.1.285"
-colorama = "^0.4.6"
 invoke = "^1.7.3"
 ruff = "^0.0.199"
 pyproject-autoflake = "^1.0.2"
 types-invoke = "^1.7.3.16"
 types-toml = "^0.10.8.1"
+pyright = "^1.1.294"

pyproject.toml

@@ -1,11 +1,14 @@
+# type: ignore
 import shutil
+import subprocess
 
 import toml
-from colorama import Fore
-from colorama import init as init_colorama
 from invoke import Context, task
+from rich.console import Console
 
-import monkey_patch_invoke as _    # noqa
+import monkey_patch_invoke as _  # noqa: F401
+
+console = Console()
 
 
 def get_pep8_compliant_name(project_name: str) -> str:
@@ -19,6 +22,14 @@ def get_project_path():
         return project_name
 
 
+def execute_command(command: str) -> dict[str, str]:
+    with subprocess.Popen(command, shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE) as process:
+        stdout, stderr = process.communicate()
+        if process.returncode != 0:
+            raise Exception(stderr.decode())
+        return {'command': command, 'result': stdout.decode()}
+
+
 @task
 def run(context: Context):
     context.run(f'python {get_project_path()}/main.py', pty=True)
@@ -30,20 +41,23 @@ def test(context: Context):
 
 
 @task
-def format_code(context: Context) -> None:
-    init_colorama()
-
-    print(f'{Fore.MAGENTA}==========Remove unused imports with `autoflake`=========={Fore.RESET}')
-    context.run(f'pautoflake {get_project_path()}', pty=True)
-
-    print(f'{Fore.MAGENTA}==========Sort imports with `isort`=========={Fore.RESET}')
-    context.run(f'isort {get_project_path()}', pty=True)
+def format_code(context: Context, verbose: bool = False) -> None:
+    commands = [
+        f'pautoflake {get_project_path()}',
+        f'ruff --fix {get_project_path()}',
+        f'yapf --in-place --recursive --parallel {get_project_path()}',
+    ]
+    results: list[dict[str, str]] = []
+    with console.status('[bold green] Formatting code...'):
+        for command in commands:
+            results.append(execute_command(command))
 
-    print(f'{Fore.MAGENTA}==========Unifying quotes with `unify`=========={Fore.RESET}')
-    context.run(f'unify --in-place -r {get_project_path()}')
+    if verbose:
+        for result in results:
+            console.print(f'$ {result["command"]}')
+            console.print(result['result'])
 
-    print(f'{Fore.MAGENTA}==========Format code with `yapf`=========={Fore.RESET}')
-    context.run(f'yapf --in-place --recursive --parallel {get_project_path()}', pty=True)
+    console.print('[bold green]Success[/bold green]')
 
 
 @task
@@ -54,32 +68,18 @@ def check(context: Context):
 
 @task
 def check_code_style(context: Context):
-    init_colorama()
+    commands = [
+        f'pautoflake {get_project_path()} --check',
+        f'ruff {get_project_path()}',
+        f'yapf --diff --recursive --parallel {get_project_path()}',
+    ]
 
-    print(f'{Fore.MAGENTA}==========Check Code Styles with `autoflake`=========={Fore.GREEN}')
-    context.run(f'pautoflake {get_project_path()} --check', pty=True)
-
-    print(f'{Fore.MAGENTA}==========Check Code Styles with `isort`=========={Fore.GREEN}')
-    context.run(f'isort {get_project_path()} --check --diff', pty=True)
-    print(f'{Fore.GREEN}isort: Success{Fore.RESET}')
-
-    print(f'{Fore.MAGENTA}==========Check Code Styles with `pylint`=========={Fore.GREEN}')
-    context.run(f'pylint {get_project_path()}', pty=True)
-
-    print(f'{Fore.MAGENTA}==========Check Code Styles with `yapf`=========={Fore.RESET}')
-    context.run(f'yapf --diff --recursive --parallel {get_project_path()}', pty=True)
-    print(f'{Fore.GREEN}yapf: Success{Fore.RESET}')
+    for command in commands:
+        context.run(command, pty=True)
 
 
 @task
 def check_types(context: Context):
-    """Check types with `pyright` and `mypy`."""
-    init_colorama()
-
-    print(f'{Fore.CYAN}==========Check typings with `pyright`=========={Fore.RESET}')
-    context.run(f'pyright {get_project_path()}', pty=True)
-
-    print(f'\n{Fore.CYAN}==========Check typings with `mypy`=========={Fore.RESET}')
     context.run(f'mypy {get_project_path()}', pty=True)