fast-dev-cli 0.7.1__tar.gz → 0.7.3__tar.gz

{fast_dev_cli-0.7.1 → fast_dev_cli-0.7.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fast-dev-cli
-Version: 0.7.1
+Version: 0.7.3
 Summary: 
 Author: Waket Zheng
 Author-email: waketzheng@gmail.com
@@ -54,7 +54,7 @@ Description-Content-Type: text/markdown
 
 ## Requirements
 
-Python 3.11+
+Python 3.10+
 
 ## Installation
 
@@ -94,4 +94,8 @@ fast sync
 ```bash
 fast upgrade
 ```
+- Start a fastapi server in development mode
+```
+fast dev
+```
 

{fast_dev_cli-0.7.1 → fast_dev_cli-0.7.3}/README.md

@@ -31,7 +31,7 @@
 
 ## Requirements
 
-Python 3.11+
+Python 3.10+
 
 ## Installation
 
@@ -71,3 +71,7 @@ fast sync
 ```bash
 fast upgrade
 ```
+- Start a fastapi server in development mode
+```
+fast dev
+```

{fast_dev_cli-0.7.1 → fast_dev_cli-0.7.3}/fast_dev_cli/cli.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import importlib.metadata
 import os
 import re
@@ -6,7 +8,7 @@ import sys
 from functools import cached_property
 from pathlib import Path
 from subprocess import CompletedProcess
-from typing import Type
+from typing import TYPE_CHECKING, Optional, Type
 
 if sys.version_info >= (3, 11):
     from enum import StrEnum
@@ -15,6 +17,9 @@ else:  # pragma: no cover
     from strenum import StrEnum  # type:ignore[no-redef,assignment]
     from typing_extensions import Self
 
+if TYPE_CHECKING:  # pragma: no cover
+    from typer.models import OptionInfo
+
 
 __version__ = importlib.metadata.version(Path(__file__).parent.name)
 
@@ -37,7 +42,7 @@ except ModuleNotFoundError:
     from click.core import Group as _Group
     from click.exceptions import Exit
 
-    def Option(default, *shortcuts, help=None):  # type:ignore[no-redef]
+    def Option(default, *shortcuts, **kw):  # type:ignore[no-redef]
         return default
 
     def _command(self, *args, **kwargs):
@@ -93,6 +98,7 @@ def _run_shell(cmd: str, **kw) -> CompletedProcess:
 
 
 def run_and_echo(cmd: str, *, dry=False, verbose=True, **kw) -> int:
+    """Run shell command with subprocess and print it"""
     if verbose:
         echo(f"--> {cmd}")
     if dry:
@@ -115,16 +121,21 @@ def capture_cmd_output(command: list[str] | str, **kw) -> str:
 def get_current_version(verbose=False) -> str:
     cmd = ["poetry", "version", "-s"]
     if verbose:
-        command = " ".join(cmd)
-        echo(f"--> {command}")
+        echo(f"--> {' '.join(cmd)}")
     return capture_cmd_output(cmd)
 
 
+def _ensure_bool(value: bool | "OptionInfo") -> bool:
+    if not isinstance(value, bool):
+        value = getattr(value, "default", False)
+    return value
+
+
 def exit_if_run_failed(
     cmd: str, env=None, _exit=False, dry=False, **kw
 ) -> CompletedProcess:
     run_and_echo(cmd, dry=True)
-    if dry:
+    if _ensure_bool(dry):
         return CompletedProcess("", 0)
     if env is not None:
         env = {**os.environ, **env}
@@ -220,7 +231,7 @@ def bump_version(
     dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
 ) -> None:
     """Bump up version string in pyproject.toml"""
-    return BumpUp(commit, part.value, dry=dry).run()
+    return BumpUp(_ensure_bool(commit), getattr(part, "value", part), dry=dry).run()
 
 
 def bump() -> None:
@@ -235,7 +246,8 @@ def bump() -> None:
     return BumpUp(commit, part, dry="--dry" in args).run()
 
 
-class EnvError(Exception): ...
+class EnvError(Exception):
+    """Raise this when the project is expected to be managed by poetry, but toml file not found."""
 
 
 class Project:
@@ -447,7 +459,8 @@ class GitTag(DryRun):
         self.message = message
         super().__init__(dry=dry)
 
-    def has_v_prefix(self: Self) -> bool:
+    @staticmethod
+    def has_v_prefix() -> bool:
         return "v" in capture_cmd_output("git tag")
 
     def should_push(self: Self) -> bool:
@@ -530,6 +543,8 @@ class LintCode(DryRun):
 def lint(files=None, dry=False) -> None:
     if files is None:
         files = parse_files(sys.argv[1:])
+    if files and files[0] == "lint":
+        files = files[1:]
     LintCode(files, dry=dry).run()
 
 
@@ -546,7 +561,7 @@ def make_style(
     """Run: ruff check/format to reformat code and then mypy to check"""
     if isinstance(files, str):
         files = [files]
-    if check_only:
+    if _ensure_bool(check_only):
         check(files, dry=dry)
     else:
         lint(files, dry=dry)
@@ -601,18 +616,11 @@ def _should_run_test_script(path: Path) -> bool:
     return path.exists()
 
 
-@cli.command()
-def test(
-    dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
-    ignore_script: bool = Option(False, "--ignore-script", "-i"),
-) -> None:
-    """Run unittest by pytest and report coverage"""
+def test(dry: bool, ignore_script=False) -> None:
     cwd = Path.cwd()
     root = Project.get_work_dir(cwd=cwd, allow_cwd=True)
     test_script = root / "scripts" / "test.sh"
-    if not isinstance(ignore_script, bool):
-        ignore_script = getattr(ignore_script, "default", False)
-    if not ignore_script and _should_run_test_script(test_script):
+    if not _ensure_bool(ignore_script) and _should_run_test_script(test_script):
         cmd = f"sh {test_script.relative_to(root)}"
         if cwd != root:
             cmd = f"cd {root} && " + cmd
@@ -624,6 +632,15 @@ def test(
     exit_if_run_failed(cmd, dry=dry)
 
 
+@cli.command(name="test")
+def coverage_test(
+    dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
+    ignore_script: bool = Option(False, "--ignore-script", "-i"),
+) -> None:
+    """Run unittest by pytest and report coverage"""
+    return test(dry, ignore_script)
+
+
 @cli.command()
 def upload(
     dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
@@ -633,5 +650,29 @@ def upload(
     exit_if_run_failed(cmd, dry=dry)
 
 
-if __name__ == "__main__":
-    cli()  # pragma: no cover
+def dev(
+    port: int | None | "OptionInfo", host: str | None | "OptionInfo", dry=False
+) -> None:
+    cmd = "fastapi dev"
+    if (port := getattr(port, "default", port)) and port != 8000:
+        cmd += f" --port={port}"
+    if (host := getattr(host, "default", host)) and host not in (
+        "localhost",
+        "127.0.0.1",
+    ):
+        cmd += f" --host={host}"
+    exit_if_run_failed(cmd, dry=dry)
+
+
+@cli.command(name="dev")
+def runserver(
+    port: Optional[int] = Option(None, "-p", "--port"),
+    host: Optional[str] = Option(None, "-h", "--host"),
+    dry: bool = Option(False, "--dry", help="Only print, not really run shell command"),
+) -> None:
+    """Start a fastapi server(only for fastapi>=0.111.0)"""
+    dev(port, host, dry=dry)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    cli()

{fast_dev_cli-0.7.1 → fast_dev_cli-0.7.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fast-dev-cli"
-version = "0.7.1"
+version = "0.7.3"
 description = ""
 authors = ["Waket Zheng <waketzheng@gmail.com>"]
 readme = "README.md"