fast-dev-cli 0.18.0__tar.gz → 0.18.2__tar.gz

{fast_dev_cli-0.18.0 → fast_dev_cli-0.18.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fast-dev-cli
-Version: 0.18.0
+Version: 0.18.2
 Summary: Python project development tool.
 Author-Email: Waket Zheng <waketzheng@gmail.com>>
 Classifier: Development Status :: 4 - Beta

fast_dev_cli-0.18.2/fast_dev_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.18.2"

{fast_dev_cli-0.18.0 → fast_dev_cli-0.18.2}/fast_dev_cli/cli.py

@@ -6,6 +6,7 @@ import importlib.metadata as importlib_metadata
 import os
 import re
 import shlex
+import shutil
 import subprocess  # nosec:B404
 import sys
 from functools import cached_property
@@ -61,10 +62,20 @@ ToolOption = Option(
 )
 
 
-class FastDevCliError(Exception): ...
+class FastDevCliError(Exception):
+    """Basic exception of this library, all custom exceptions inherit from it"""
 
 
-class ShellCommandError(FastDevCliError): ...
+class ShellCommandError(FastDevCliError):
+    """Raise if cmd command returncode is not zero"""
+
+
+class ParseError(FastDevCliError):
+    """Raise this if parse dependence line error"""
+
+
+class EnvError(FastDevCliError):
+    """Raise when expected to be managed by poetry, but toml file not found."""
 
 
 def poetry_module_name(name: str) -> str:
@@ -259,7 +270,7 @@ def _ensure_bool(value: bool | OptionInfo) -> bool:
     return value
 
 
-def _ensure_str(value: str | OptionInfo) -> str:
+def _ensure_str(value: str | OptionInfo | None) -> str:
     if not isinstance(value, str):
         value = getattr(value, "default", "")
     return value
@@ -535,10 +546,6 @@ def bump() -> None:
     return BumpUp(commit, part, no_sync="--no-sync" in args, dry="--dry" in args).run()
 
 
-class EnvError(Exception):
-    """Raise when expected to be managed by poetry, but toml file not found."""
-
-
 class Project:
     path_depth = 5
     _tool: ToolName | None = None
@@ -590,30 +597,33 @@ class Project:
         try:
             text = cls.load_toml_text()
         except EnvError:
-            pass
-        else:
-            with contextlib.suppress(KeyError, tomllib.TOMLDecodeError):
-                doc = tomllib.loads(text)
-                backend = doc["build-system"]["build-backend"]
-                if "poetry" in backend:
-                    cls._tool = "poetry"
-                    return cls._tool
-                elif "pdm" in backend:
-                    cls._tool = "pdm"
-                    work_dir = cls.get_work_dir(allow_cwd=True)
-                    if not Path(work_dir, "pdm.lock").exists() and (
-                        "[tool.uv]" in text or Path(work_dir, "uv.lock").exists()
-                    ):
-                        cls._tool = "uv"
-                    return cls._tool
-            for name in get_args(ToolName):
-                if f"[tool.{name}]" in text:
-                    cls._tool = cast(ToolName, name)
-                    return cls._tool
-            # Poetry 2.0 default to not include the '[tool.poetry]' section
-            if cls.is_poetry_v2(text):
+            return None
+        with contextlib.suppress(KeyError, tomllib.TOMLDecodeError):
+            doc = tomllib.loads(text)
+            backend = doc["build-system"]["build-backend"]
+            if "poetry" in backend:
                 cls._tool = "poetry"
                 return cls._tool
+            work_dir = cls.get_work_dir(allow_cwd=True)
+            uv_lock_exists = Path(work_dir, "uv.lock").exists()
+            if "pdm" in backend:
+                cls._tool = "pdm"
+                if not Path(work_dir, "pdm.lock").exists() and (
+                    uv_lock_exists or "[tool.uv]" in text
+                ):
+                    cls._tool = "uv"
+                return cls._tool
+            elif uv_lock_exists:
+                cls._tool = "uv"
+                return cls._tool
+        for name in get_args(ToolName):
+            if f"[tool.{name}]" in text:
+                cls._tool = cast(ToolName, name)
+                return cls._tool
+        # Poetry 2.0 default to not include the '[tool.poetry]' section
+        if cls.is_poetry_v2(text):
+            cls._tool = "poetry"
+            return cls._tool
         return None
 
     @staticmethod
@@ -664,12 +674,6 @@ class Project:
             run_and_echo(cmd)
 
 
-class ParseError(Exception):
-    """Raise this if parse dependence line error"""
-
-    pass
-
-
 class UpgradeDependencies(Project, DryRun):
     def __init__(
         self, _exit: bool = False, dry: bool = False, tool: ToolName = "poetry"
@@ -943,6 +947,10 @@ class LintCode(DryRun):
     def check_lint_tool_installed() -> bool:
         return check_call("ruff --version")
 
+    @staticmethod
+    def missing_mypy_exec() -> bool:
+        return shutil.which("mypy") is None
+
     @staticmethod
     def prefer_dmypy(paths: str, tools: list[str], use_dmypy: bool = False) -> bool:
         return (
@@ -1006,6 +1014,16 @@ class LintCode(DryRun):
                 ".local/bin"
             ):
                 if not ruff_exists:
+                    should_run_by_tool = True
+                    command = "pipx install ruff"
+                    if shutil.which("pipx") is None:
+                        ensure_pipx = "pip install --user pipx\n  pipx ensurepath\n  "
+                        command = ensure_pipx + command
+                    yellow_warn(
+                        "You may need to run the following command"
+                        f" to install ruff:\n\n  {command}\n"
+                    )
+                elif "mypy" in str(tools) and cls.missing_mypy_exec():
                     should_run_by_tool = True
                     if check_call('python -c "import fast_dev_cli"'):
                         command = 'python -m pip install -U "fast-dev-cli"'
@@ -1129,18 +1147,11 @@ def make_style(
     bandit = _ensure_bool(bandit)
     prefix = _ensure_bool(prefix)
     tool = _ensure_str(tool)
+    kwargs = {"dry": dry, "skip_mypy": skip, "dmypy": dmypy, "bandit": bandit}
     if _ensure_bool(check_only):
-        check(files, dry=dry, skip_mypy=skip, dmypy=dmypy, bandit=bandit, tool=tool)
+        check(files, tool=tool, **kwargs)
     else:
-        lint(
-            files,
-            dry=dry,
-            skip_mypy=skip,
-            dmypy=dmypy,
-            bandit=bandit,
-            tool=tool,
-            prefix=prefix,
-        )
+        lint(files, prefix=prefix, tool=tool, **kwargs)
 
 
 @cli.command(name="check")
@@ -1463,12 +1474,13 @@ class UvPypi(DryRun):
 
 @cli.command()
 def pypi(
+    file: Optional[str] = typer.Argument(default=None),
     dry: bool = DryOption,
     verbose: bool = False,
     quiet: bool = False,
 ) -> None:
     """Change registry of uv.lock to be pypi.org"""
-    if not (p := Path("uv.lock")).exists() and not (
+    if not (p := Path(_ensure_str(file) or "uv.lock")).exists() and not (
         (p := Project.get_work_dir() / p.name).exists()
     ):
         yellow_warn(f"{p.name!r} not found!")
@@ -1492,8 +1504,7 @@ def common(
         is_eager=True,
         help="Show the version of this tool",
     ),
-) -> None:
-    pass
+) -> None: ...
 
 
 def main() -> None:

{fast_dev_cli-0.18.0 → fast_dev_cli-0.18.2}/pyproject.toml

@@ -42,7 +42,7 @@ dependencies = [
     "bumpversion2 >=1.4.3",
     "pytest >=8.2.0",
 ]
-version = "0.18.0"
+version = "0.18.2"
 
 [project.urls]
 Homepage = "https://github.com/waketzheng/fast-dev-cli"

{fast_dev_cli-0.18.0 → fast_dev_cli-0.18.2}/tests/test_lint.py

@@ -245,6 +245,19 @@ def test_lint_without_ruff_installed(mocker, mock_no_dmypy):
     with capture_stdout() as stream:
         lint(".", dry=True)
     output = stream.getvalue()
+    cmd = "pipx install ruff"
+    assert cmd in output
+    tip = "You may need to run the following command to install ruff"
+    assert tip in output
+    assert f"{tip}:\n\n  {cmd}" in output
+
+
+def test_lint_without_mypy_installed(mocker, mock_no_dmypy):
+    mocker.patch("fast_dev_cli.cli.is_venv", return_value=True)
+    mocker.patch("fast_dev_cli.cli.LintCode.missing_mypy_exec", return_value=True)
+    with capture_stdout() as stream:
+        lint(".", dry=True)
+    output = stream.getvalue()
     cmd = 'python -m pip install -U "fast-dev-cli"'
     assert cmd in output
     tip = "You may need to run the following command to install lint tools"

{fast_dev_cli-0.18.0 → fast_dev_cli-0.18.2}/tests/test_pypi.py

@@ -23,7 +23,7 @@ def test_pypi(tmp_work_dir, capsys):
     assert new_text != text
     assert "tsinghua" in text and "pypi.org" not in text
     assert "tsinghua" not in new_text and "pypi.org" in new_text
-    shutil.copy(uv_qh, ".")
+    lock_file.write_text(text, encoding="utf-8")
     pypi(quiet=True)
     assert new_text == lock_file.read_text("utf-8")
     pypi()
@@ -37,7 +37,20 @@ def test_pypi(tmp_work_dir, capsys):
     assert new_text != text
     assert "tencent" in text and "pypi.org" not in text
     assert "tencent" not in new_text and "pypi.org" in new_text
+    lock_file.write_text(text, encoding="utf-8")
     pypi(quiet=True)
     assert new_text == lock_file.read_text("utf-8")
     pypi()
     assert new_text == lock_file.read_text("utf-8")
+
+    lock_file = Path(uv_tx.name)
+    shutil.copy(uv_tx, ".")
+    text = lock_file.read_text("utf-8")
+    with pytest.raises(Exit):
+        pypi(uv_tx.name)
+    new_text = lock_file.read_text("utf-8")
+    shutil.copy(uv_tx, ".")
+    pypi(uv_tx.name, quiet=True)
+    assert new_text == lock_file.read_text("utf-8")
+    pypi(uv_tx.name)
+    assert new_text == lock_file.read_text("utf-8")

fast_dev_cli-0.18.0/fast_dev_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.18.0"