fast-dev-cli 0.10.0__tar.gz → 0.10.1__tar.gz

{fast_dev_cli-0.10.0 → fast_dev_cli-0.10.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: fast-dev-cli
-Version: 0.10.0
+Version: 0.10.1
 Summary: Python project development tool.
 Author-Email: Waket Zheng <waketzheng@gmail.com>>
 Classifier: Development Status :: 4 - Beta
@@ -78,9 +78,9 @@ Python 3.10+
 <div class="termy">
 
 ```bash
-pip install "fast-dev-cli"
+pip install fast-dev-cli
 ```
-*Will install: fast-dev-cli typer ruff mypy bumpversion pytest coverage*
+*Will install: fast-dev-cli emoji typer ruff mypy bumpversion2 pytest coverage*
 
 </div>
 

{fast_dev_cli-0.10.0 → fast_dev_cli-0.10.1}/README.md

@@ -43,9 +43,9 @@ Python 3.10+
 <div class="termy">
 
 ```bash
-pip install "fast-dev-cli"
+pip install fast-dev-cli
 ```
-*Will install: fast-dev-cli typer ruff mypy bumpversion pytest coverage*
+*Will install: fast-dev-cli emoji typer ruff mypy bumpversion2 pytest coverage*
 
 </div>
 

fast_dev_cli-0.10.1/fast_dev_cli/__init__.py

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

fast_dev_cli-0.10.1/fast_dev_cli/__main__.py

@@ -0,0 +1,3 @@
+from fast_dev_cli.cli import main
+
+main()

{fast_dev_cli-0.10.0 → fast_dev_cli-0.10.1}/fast_dev_cli/cli.py

@@ -592,6 +592,15 @@ class LintCode(DryRun):
             and not load_bool("NO_DMYPY")
         )
 
+    @staticmethod
+    def get_package_name() -> str:
+        root = Project.get_work_dir(allow_cwd=True)
+        package_maybe = (root.name.replace("-", "_"), "src")
+        for name in package_maybe:
+            if root.joinpath(name).is_dir():
+                return name
+        return "."
+
     @classmethod
     def to_cmd(cls: Type[Self], paths=".", check_only=False, bandit=False) -> str:
         cmd = ""
@@ -611,7 +620,7 @@ class LintCode(DryRun):
         if is_venv():
             if not cls.check_lint_tool_installed():
                 should_run_by_tool = True
-                if check_call("python -c 'import fast_dev_cli'"):
+                if check_call('python -c "import fast_dev_cli"'):
                     command = 'python -m pip install -U "fast_dev_cli"'
                     tip = "You may need to run following command to install lint tools:"
                     secho(f"{tip}\n\n  {command}\n", fg="yellow")
@@ -625,15 +634,7 @@ class LintCode(DryRun):
         if bandit or load_bool("FASTDEVCLI_BANDIT"):
             command = prefix + "bandit"
             if paths == ".":  # fast check --bandit
-                command += " -r"
-                root = Project.get_work_dir(allow_cwd=True)
-                package_maybe = (root.name.replace("-", "_"), "src")
-                for name in package_maybe:
-                    if root.joinpath(name).is_dir():
-                        command += " " + name
-                        break
-                else:
-                    command += " ."
+                command += " -r " + cls.get_package_name()
                 cmd += " && " + command
         return cmd
 
@@ -721,16 +722,21 @@ def sync(
     Sync(filename, extras, save, dry=dry).run()
 
 
-def _should_run_test_script(path: Path = Path("scripts/test.sh")) -> bool:
-    return path.exists()
+def _should_run_test_script(path: Path = Path("scripts")) -> Path | None:
+    for name in ("test.sh", "test.py"):
+        if (file := path / name).exists():
+            return file
+    return None
 
 
 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 _ensure_bool(ignore_script) and _should_run_test_script(test_script):
-        cmd = f"sh {os.path.relpath(test_script, root)}"
+    script_dir = root / "scripts"
+    if not _ensure_bool(ignore_script) and (
+        test_script := _should_run_test_script(script_dir)
+    ):
+        cmd = f"{os.path.relpath(test_script, root)}"
         if cwd != root:
             cmd = f"cd {root} && " + cmd
     else:

{fast_dev_cli-0.10.0 → fast_dev_cli-0.10.1}/pyproject.toml

@@ -40,7 +40,7 @@ dependencies = [
     "bumpversion2 >=1.4.2,<2",
     "pytest >=8.2.0,<9",
 ]
-version = "0.10.0"
+version = "0.10.1"
 
 [project.urls]
 Homepage = "https://github.com/waketzheng/fast-dev-cli"

fast_dev_cli-0.10.1/scripts/check.py

@@ -0,0 +1,19 @@
+#!/usr/bin/env python
+import os
+import sys
+
+parent = os.path.abspath(os.path.dirname(__file__))
+work_dir = os.path.dirname(parent)
+if os.getcwd() != work_dir:
+    os.chdir(work_dir)
+
+if os.system("pdm run fast check") != 0:
+    print("\033[1m Please run './scripts/format.py' to auto-fix style issues \033[0m")
+    sys.exit(1)
+
+package_name = os.path.basename(work_dir).replace("-", "_")
+cmd = "pdm run bandit -r {}".format(package_name)
+print("-->", cmd)
+if os.system(cmd) != 0:
+    sys.exit(1)
+print("Done.")

fast_dev_cli-0.10.1/scripts/format.py

@@ -0,0 +1,14 @@
+#!/usr/bin/env python
+import os
+import shlex
+import subprocess
+import sys
+from pathlib import Path
+
+work_dir = Path(__file__).parent.resolve().parent
+if Path.cwd() != work_dir:
+    os.chdir(str(work_dir))
+
+cmd = "pdm run fast lint"
+r = subprocess.run(shlex.split(cmd), env=dict(os.environ, SKIP_MYPY="1"))
+sys.exit(None if r.returncode == 0 else 1)

fast_dev_cli-0.10.1/scripts/test.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+import os
+import shlex
+import subprocess
+import sys
+import time
+from pathlib import Path
+
+work_dir = Path(__file__).parent.resolve().parent
+if Path.cwd() != work_dir:
+    os.chdir(str(work_dir))
+
+CMD = "pdm run coverage run -m pytest"
+COMBINE = "pdm run coverage combine .coverage*"
+REPORT = "pdm run coverage report -m"
+
+
+def remove_outdate_files(start_time: float) -> None:
+    for file in work_dir.glob(".coverage*"):
+        if file.stat().st_mtime < start_time:
+            file.unlink()
+            print(f"Removed outdate file: {file}")
+
+
+def run_command(cmd: str, shell=False) -> None:
+    print("-->", cmd, flush=True)
+    r = subprocess.run(cmd if shell else shlex.split(cmd), shell=shell)
+    r.returncode and sys.exit(1)
+
+
+def combine_result_files(shell=COMBINE) -> None:
+    to_be_combine = [i.name for i in work_dir.glob(".coverage.*")]
+    if to_be_combine:
+        if sys.platform == "win32":
+            if work_dir.joinpath(".coverage").exists():
+                shell = shell.replace("*", " ")
+            else:
+                shell = shell.replace(".coverage*", "")
+            shell += " ".join(to_be_combine)
+        run_command(shell, True)
+
+
+started_at = time.time()
+run_command(CMD)
+remove_outdate_files(started_at)
+combine_result_files()
+run_command(REPORT)

{fast_dev_cli-0.10.0 → fast_dev_cli-0.10.1}/tests/test_fast_test.py

@@ -1,5 +1,8 @@
+import os
 import pathlib
+from typing import Generator
 
+import pytest
 from pytest_mock import MockerFixture
 
 from fast_dev_cli.cli import (
@@ -10,6 +13,15 @@ from fast_dev_cli.cli import (
 )
 from fast_dev_cli.cli import test as unitcase
 
+TEST_SCRIPT = os.path.join("scripts", "test.py")
+
+
+@pytest.fixture
+def script_path() -> Generator[pathlib.Path, None, None]:
+    parent = pathlib.Path(__file__).parent
+    test_script = parent.resolve().parent / "scripts" / "test.py"
+    yield test_script
+
 
 def test_cli_test(mocker, capsys):
     output = capture_cmd_output("python fast_dev_cli/cli.py test --dry --ignore-script")
@@ -19,7 +31,7 @@ def test_cli_test(mocker, capsys):
     )
 
     mocker.patch("fast_dev_cli.cli.is_venv", return_value=True)
-    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=False)
+    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=None)
     unitcase(dry=True)
     assert (
         'coverage run -m pytest -s && coverage report --omit="tests/*" -m'
@@ -29,7 +41,7 @@ def test_cli_test(mocker, capsys):
 
 def test_test_with_pdm_run(mocker: MockerFixture, capsys):
     mocker.patch("fast_dev_cli.cli.check_call", return_value=False)
-    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=False)
+    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=None)
     unitcase(dry=True)
     assert (
         '--> pdm run coverage run -m pytest -s && pdm run coverage report --omit="tests/*" -m'
@@ -39,7 +51,7 @@ def test_test_with_pdm_run(mocker: MockerFixture, capsys):
 
 def test_test_with_poetry_or_pdm_run(mocker: MockerFixture, capsys):
     mocker.patch("fast_dev_cli.cli.check_call", return_value=False)
-    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=False)
+    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=None)
     mocker.patch("fast_dev_cli.cli.Project.manage_by_poetry", return_value=True)
     unitcase(dry=True)
     command = "coverage"
@@ -52,7 +64,7 @@ def test_test_with_poetry_or_pdm_run(mocker: MockerFixture, capsys):
 
 
 def test_test_not_in_venv(mocker: MockerFixture, capsys):
-    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=False)
+    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=None)
     mocker.patch("fast_dev_cli.cli.is_venv", return_value=False)
     unitcase(dry=True)
     command = "coverage"
@@ -64,26 +76,26 @@ def test_test_not_in_venv(mocker: MockerFixture, capsys):
     )
 
 
-def test_run_script(mocker: MockerFixture, capsys):
+def test_run_script(mocker: MockerFixture, capsys, script_path):
     assert _should_run_test_script()
-    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=True)
+    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=script_path)
     unitcase(dry=True)
-    assert "sh scripts/test.sh" in capsys.readouterr().out
+    assert TEST_SCRIPT in capsys.readouterr().out
+    assert _should_run_test_script(pathlib.Path("not-exist")) is None
 
 
-def test_ignore_script(mocker: MockerFixture, capsys):
-    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=True)
+def test_ignore_script(mocker: MockerFixture, capsys, script_path):
+    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=script_path)
     unitcase(dry=True, ignore_script=True)
-    assert "sh scripts/test.sh" not in capsys.readouterr().out
+    assert TEST_SCRIPT not in capsys.readouterr().out
 
 
-def test_run_script_in_sub_directory(mocker: MockerFixture, capsys):
-    parent = pathlib.Path(__file__).parent
-    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=True)
-    mocker.patch("pathlib.Path.cwd", return_value=parent)
+def test_run_script_in_sub_directory(mocker: MockerFixture, capsys, script_path):
+    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=script_path)
+    mocker.patch("pathlib.Path.cwd", return_value=script_path.parent)
     unitcase(dry=True)
     out = capsys.readouterr().out
-    assert f"cd {parent.parent} && sh scripts/test.sh" in out
+    assert f"cd {script_path.parent.parent} && {TEST_SCRIPT}" in out
 
 
 def test_fast_test(mocker, capsys):
@@ -94,7 +106,7 @@ def test_fast_test(mocker, capsys):
     )
 
     mocker.patch("fast_dev_cli.cli.is_venv", return_value=True)
-    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=False)
+    mocker.patch("fast_dev_cli.cli._should_run_test_script", return_value=None)
     coverage_test(dry=True)
     assert (
         'coverage run -m pytest -s && coverage report --omit="tests/*" -m'

{fast_dev_cli-0.10.0 → fast_dev_cli-0.10.1}/tests/test_lint.py

@@ -1,3 +1,4 @@
+import shutil
 from pathlib import Path
 
 import pytest
@@ -10,6 +11,7 @@ from fast_dev_cli.cli import (
     lint,
     make_style,
     only_check,
+    run_and_echo,
 )
 
 from .utils import capture_stdout, chdir, mock_sys_argv
@@ -56,7 +58,7 @@ LINT_CMD = _CMD.format("", " --fix")
 CHECK_CMD = _CMD.format(" --check", "")
 
 
-def test_check(mock_no_dmypy, monkeypatch):
+def test_check(mock_no_dmypy, monkeypatch, mocker):
     command = capture_cmd_output("fast check --dry")
     for cmd in CHECK_CMD.split(SEP):
         assert cmd in command
@@ -70,6 +72,16 @@ def test_check(mock_no_dmypy, monkeypatch):
     assert command4 == command
 
 
+def test_check_bandit(tmp_path):
+    package_path = tmp_path / "foo"
+    with chdir(tmp_path):
+        run_and_echo(f"poetry new {package_path.name}")
+    shutil.rmtree(package_path / package_path.name)
+    with chdir(package_path):
+        command = capture_cmd_output("fast check --bandit --dry")
+    assert "bandit -r ." in command
+
+
 def test_fast_check():
     _fast_check()
 
@@ -155,7 +167,7 @@ def test_lint_func(mocker, mock_no_dmypy):
     with capture_stdout() as stream:
         lint(["lint"], dry=True)
     assert LINT_CMD in stream.getvalue()
-    assert LINT_CMD in capture_cmd_output("python -m fast_dev_cli lint --dry")
+    assert LINT_CMD in capture_cmd_output("pdm run python -m fast_dev_cli lint --dry")
 
 
 def test_lint_without_ruff_installed(mocker, mock_no_dmypy):

fast_dev_cli-0.10.1/tests/test_poetry_version_plugin.py

@@ -0,0 +1,70 @@
+import os
+import shutil
+import sys
+from contextlib import contextmanager
+from pathlib import Path
+from typing import Generator
+
+import pytest
+
+from fast_dev_cli.cli import (
+    TOML_FILE,
+    BumpUp,
+    ParseError,
+    run_and_echo,
+)
+
+from .utils import chdir
+
+CONF = """
+
+[tool.poetry-version-plugin]
+source = "init"
+"""
+
+
+@contextmanager
+def _prepare_package(
+    package_path: Path, define_include=False
+) -> Generator[Path, None, None]:
+    toml_file = package_path / TOML_FILE
+    package_name = package_path.name.replace(" ", "_")
+    init_file = package_path / package_name / "__init__.py"
+    a, b = 'version = "0.1.0"', 'version = "0"'
+    if define_include:
+        b += '\npackages = [{include = "%s"}]' % package_name
+    with chdir(package_path.parent):
+        run_and_echo(f'poetry new "{package_path.name}"')
+    toml_file.unlink()
+    py_version = "{0}.{1}".format(*sys.version_info)
+    with chdir(package_path):
+        run_and_echo(f'poetry init --python="^{py_version}" --no-interaction')
+        text = toml_file.read_text().replace(a, b)
+        toml_file.write_text(text + CONF)
+        shutil.move(package_path.name, package_name)
+        init_file.write_text('__version__ = "0.0.1"\n')
+        yield init_file
+
+
+def _build_bump_cmd(init_file: Path) -> str:
+    relative_path = os.path.join(init_file.parent.name, init_file.name)
+    return rf'bumpversion --parse "(?P<major>\d+)\.(?P<minor>\d+)\.(?P<patch>\d+)" --current-version="0.0.1" patch {relative_path} --allow-dirty'
+
+
+def test_version_plugin(tmp_path: Path) -> None:
+    with _prepare_package(tmp_path / "helloworld") as init_file:
+        command = _build_bump_cmd(init_file)
+        assert BumpUp(part="patch", commit=False, dry=True).gen() == command
+        run_and_echo("poetry run fast bump patch")
+        assert init_file.read_text() == '__version__ = "0.0.2"\n'
+        init_file.unlink()
+        with pytest.raises(ParseError, match=r"Version file not found!.*"):
+            BumpUp(part="patch", commit=False, dry=True).gen()
+
+
+def test_version_plugin_include_defined(tmp_path: Path) -> None:
+    with _prepare_package(tmp_path / "hello world", True) as init_file:
+        command = _build_bump_cmd(init_file)
+        assert BumpUp(part="patch", commit=False, dry=True).gen() == command
+        run_and_echo("poetry run fast bump patch")
+        assert init_file.read_text() == '__version__ = "0.0.2"\n'

{fast_dev_cli-0.10.0 → fast_dev_cli-0.10.1}/tests/test_tag.py

@@ -1,3 +1,4 @@
+import sys
 from contextlib import contextmanager
 
 from fast_dev_cli.cli import (
@@ -36,7 +37,12 @@ def test_echo_when_not_dry(mocker, capsys):
 
 @contextmanager
 def _clear_tags():
-    run_and_echo("git tag | xargs git tag -d")
+    if sys.platform == "win32":
+        for t in capture_cmd_output("git tag").splitlines():
+            if "v" in (tag := t.strip()):
+                run_and_echo(f"git tag -d {tag}")
+    else:
+        run_and_echo("git tag | xargs git tag -d")
     yield
     run_and_echo("git pull --tags")
 

fast_dev_cli-0.10.0/fast_dev_cli/__init__.py

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

fast_dev_cli-0.10.0/fast_dev_cli/__main__.py

@@ -1,3 +0,0 @@
-from .cli import main
-
-main()

fast_dev_cli-0.10.0/scripts/check.sh

@@ -1,11 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-set -x
-
-[ -f pyproject.toml ] || ([ -f ../pyproject.toml ] && cd ..)
-
-pdm run fast check || \
-  echo -e "\033[1m Please run './scripts/format.sh' to auto-fix style issues \033[0m"
-
-pdm run bandit -r fast_dev_cli/

fast_dev_cli-0.10.0/scripts/format.sh

@@ -1,6 +0,0 @@
-#!/bin/sh -e
-set -x
-
-[ -f pyproject.toml ] || ([ -f ../pyproject.toml ] && cd ..)
-
-SKIP_MYPY=1 pdm run fast lint

fast_dev_cli-0.10.0/scripts/test.sh

@@ -1,6 +0,0 @@
-#!/usr/bin/env bash
-
-set -e
-pdm run coverage run -m pytest
-pdm run coverage combine .coverage*
-pdm run coverage report -m

fast_dev_cli-0.10.0/tests/test_poetry_version_plugin.py

@@ -1,62 +0,0 @@
-from pathlib import Path
-
-import pytest
-
-from fast_dev_cli.cli import (
-    TOML_FILE,
-    BumpUp,
-    ParseError,
-    run_and_echo,
-)
-
-from .utils import chdir
-
-CONF = """
-
-[tool.poetry-version-plugin]
-source = "init"
-"""
-
-
-def test_version_plugin(tmp_path: Path) -> None:
-    package_path = tmp_path / "helloworld"
-    toml_file = package_path / TOML_FILE
-    init_file = package_path / package_path.name / "__init__.py"
-    a, b = 'version = "0.1.0"', 'version = "0"'
-    with chdir(tmp_path):
-        run_and_echo(f"poetry new {package_path.name}")
-    with chdir(package_path):
-        text = toml_file.read_text().replace(a, b)
-        toml_file.write_text(text + CONF)
-        init_file.write_text('__version__ = "0.0.1"\n')
-        assert (
-            BumpUp(part="patch", commit=False, dry=True).gen()
-            == 'bumpversion --parse "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)" --current-version="0.0.1" patch helloworld/__init__.py --allow-dirty'
-        )
-        run_and_echo("poetry run fast bump patch")
-        assert init_file.read_text() == '__version__ = "0.0.2"\n'
-        init_file.unlink()
-        with pytest.raises(ParseError, match=r"Version file not found!.*"):
-            BumpUp(part="patch", commit=False, dry=True).gen()
-
-
-def test_version_plugin_include_defined(tmp_path: Path) -> None:
-    package_path = tmp_path / "hello world"
-    toml_file = package_path / TOML_FILE
-    package_name = package_path.name.replace(" ", "_")
-    init_file = package_path / package_name / "__init__.py"
-    a, b = 'version = "0.1.0"', 'version = "0"'
-    b += '\npackages = [{include = "%s"}]' % package_name
-    with chdir(tmp_path):
-        run_and_echo(f"poetry new '{package_path.name}'")
-    with chdir(package_path):
-        text = toml_file.read_text().replace(a, b)
-        toml_file.write_text(text + CONF)
-        run_and_echo(f"mv '{package_path.name}' {package_name}")
-        init_file.write_text('__version__ = "0.0.1"\n')
-        assert (
-            BumpUp(part="patch", commit=False, dry=True).gen()
-            == f'bumpversion --parse "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)" --current-version="0.0.1" patch {package_name}/__init__.py --allow-dirty'
-        )
-        run_and_echo("poetry run fast bump patch")
-        assert init_file.read_text() == '__version__ = "0.0.2"\n'