git-env 0.3.0__tar.gz → 0.5.0__tar.gz

{git_env-0.3.0 → git_env-0.5.0}/PKG-INFO

@@ -1,28 +1,25 @@
 Metadata-Version: 2.4
 Name: git-env
-Version: 0.3.0
+Version: 0.5.0
 Summary: Sync environment files across linked git worktrees
 Author: Alex Ward
 Author-email: Alex Ward <alxwrd@googlemail.com>
 License-Expression: MIT
 License-File: LICENCE
-Requires-Dist: arguably>=1.2.2
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 
 <div align="center">
     <h1><code>git-env</code></h1>
     <p align="center"><i>
-        Environment file syncronisation to your linked git worktrees
+        Copies untracked env files to your worktrees
     </i></p>
     <img width="256px" src="https://github.com/alxwrd/git-env/raw/main/.github/assets/man-reading-the-mail-768.png">
     <div align="center">
-        <a href="https://github.com/alxwrd/git-env/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/alxwrd/git-env/test.yml?branch=main&label=main"></a>
-        <a href="https://pypi.python.org/pypi/git-env"><img src="https://img.shields.io/pypi/v/git-env.svg"></a>
-        <a href="https://github.com/alxwrd/git-env/blob/main/LICENCE"><img src="https://img.shields.io/pypi/l/git-env.svg?"></a>
+        <a href="https://github.com/alxwrd/git-env/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/alxwrd/git-env/ci.yml?branch=main&label=main"></a>
+        <a href="https://pypi.python.org/pypi/git-env"><img src="https://img.shields.io/pypi/v/git-env"></a>
+        <a href="https://github.com/alxwrd/git-env/blob/main/LICENCE"><img src="https://img.shields.io/pypi/l/git-env"></a>
     </div>
-
-Copies untracked env files to your worktrees.
 </div>
 
 
@@ -37,10 +34,8 @@ git env sync                                 # copies .env from the primary
 
 ```plain
 $ git env sync
-
-copied  .env
-
-1 file synced.
+synced  .env
+2 files synced, 0 unchanged, 0 conflicts skipped
 ```
 
 Run it again later to pick up any changes made in the primary. By default,

{git_env-0.3.0 → git_env-0.5.0}/README.md

@@ -1,16 +1,14 @@
 <div align="center">
     <h1><code>git-env</code></h1>
     <p align="center"><i>
-        Environment file syncronisation to your linked git worktrees
+        Copies untracked env files to your worktrees
     </i></p>
     <img width="256px" src="https://github.com/alxwrd/git-env/raw/main/.github/assets/man-reading-the-mail-768.png">
     <div align="center">
-        <a href="https://github.com/alxwrd/git-env/actions/workflows/test.yml"><img src="https://img.shields.io/github/actions/workflow/status/alxwrd/git-env/test.yml?branch=main&label=main"></a>
-        <a href="https://pypi.python.org/pypi/git-env"><img src="https://img.shields.io/pypi/v/git-env.svg"></a>
-        <a href="https://github.com/alxwrd/git-env/blob/main/LICENCE"><img src="https://img.shields.io/pypi/l/git-env.svg?"></a>
+        <a href="https://github.com/alxwrd/git-env/actions/workflows/ci.yml"><img src="https://img.shields.io/github/actions/workflow/status/alxwrd/git-env/ci.yml?branch=main&label=main"></a>
+        <a href="https://pypi.python.org/pypi/git-env"><img src="https://img.shields.io/pypi/v/git-env"></a>
+        <a href="https://github.com/alxwrd/git-env/blob/main/LICENCE"><img src="https://img.shields.io/pypi/l/git-env"></a>
     </div>
-
-Copies untracked env files to your worktrees.
 </div>
 
 
@@ -25,10 +23,8 @@ git env sync                                 # copies .env from the primary
 
 ```plain
 $ git env sync
-
-copied  .env
-
-1 file synced.
+synced  .env
+2 files synced, 0 unchanged, 0 conflicts skipped
 ```
 
 Run it again later to pick up any changes made in the primary. By default,

{git_env-0.3.0 → git_env-0.5.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "git-env"
-version = "0.3.0"
+version = "0.5.0"
 description = "Sync environment files across linked git worktrees"
 readme = "README.md"
 authors = [
@@ -9,9 +9,7 @@ authors = [
 license = "MIT"
 license-files = ["LICENCE"]
 requires-python = ">=3.10"
-dependencies = [
-    "arguably>=1.2.2",
-]
+dependencies = []
 
 [project.scripts]
 git-env = "git_env:main"

git_env-0.5.0/src/git_env/_argparser.py

@@ -0,0 +1,84 @@
+from __future__ import annotations
+
+import argparse
+from importlib.metadata import version
+
+from .shell_completions import SUPPORTED_SHELLS
+
+
+class GitEnvExit(Exception):
+    """Raised by command bodies to request a specific process exit code."""
+
+    def __init__(self, code: int) -> None:
+        super().__init__(code)
+        self.code = code
+
+
+def rewrite_help_subcommand(argv: list[str]) -> list[str]:
+    """Translate `git env help [subcommand]` into `git env [subcommand] --help`."""
+    if argv and argv[0] == "help":
+        return [*argv[1:], "--help"]
+    return argv
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="git env",
+        description="sync environment files across linked git worktrees",
+    )
+
+    parser.add_argument(
+        "--version", action="version", version=f"%(prog)s {version('git-env')}"
+    )
+    parser.add_argument(
+        "--porcelain",
+        action="store_true",
+        help="reserved for a future machine-readable output mode (not yet supported)",
+    )
+    parser.add_argument(
+        "--install-completions",
+        choices=SUPPORTED_SHELLS,
+        metavar="{" + "|".join(SUPPORTED_SHELLS) + "}",
+        help="print a completion snippet for the given shell; combine with --write to install",
+    )
+    parser.add_argument(
+        "--write",
+        action="store_true",
+        help="used with --install-completions: write the file instead of printing",
+    )
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        action="store_true",
+        help="print every file considered, including skips",
+    )
+    parser.add_argument(
+        "-q", "--quiet", action="store_true", help="suppress non-error output"
+    )
+
+    sub = parser.add_subparsers(dest="command")
+
+    p_sync = sub.add_parser(
+        "sync",
+        help="copy env files from primary worktree into current linked worktree",
+    )
+    p_sync.add_argument(
+        "-n", "--dry-run", action="store_true", help="print actions, change nothing"
+    )
+    p_sync.add_argument(
+        "-f",
+        "--force",
+        action="store_true",
+        help="overwrite local files even when they differ from primary",
+    )
+    p_sync.add_argument(
+        "--pattern",
+        action="append",
+        metavar="GLOB",
+        help="glob to sync, repeatable; overrides configured patterns",
+    )
+    p_sync.add_argument(
+        "--path", metavar="PATH", help="restrict to a subdirectory of the worktree"
+    )
+
+    return parser

git_env-0.5.0/src/git_env/cli.py

@@ -0,0 +1,120 @@
+"""Top-level CLI: dispatches `git env <subcommand>` via argparse.
+
+Exit codes are part of the spec's contract (see spec.md):
+  0 success, 1 sync conflicts skipped, 2 refused to run, 3 usage error, 4 I/O error.
+argparse itself always raises `SystemExit(2)` for usage errors (bad flag, unknown
+subcommand), which collides with our "refused to run" code. `GitEnvExit` lets
+command bodies signal an intentional exit code; any other `SystemExit(2)` reaching
+`main()` therefore came from argparse and is remapped to 3.
+"""
+
+from __future__ import annotations
+
+import sys
+
+from ._argparser import GitEnvExit, build_parser, rewrite_help_subcommand
+from .config import ConfigError, load_config
+from .output import Reporter
+from .repo import RepoError, check_primary_clean, detect_repository
+from .shell_completions import install_completions as render_completions_install
+from .sync import SyncIOError, run_sync
+
+
+def sync(
+    *,
+    pattern: list[str] | None = None,
+    path: str | None = None,
+    dry_run: bool = False,
+    force: bool = False,
+    reporter: Reporter,
+) -> None:
+    try:
+        repo = detect_repository()
+    except RepoError as exc:
+        reporter.error(str(exc))
+        raise GitEnvExit(2) from None
+
+    try:
+        config = load_config(repo.primary_root)
+    except ConfigError as exc:
+        reporter.error(str(exc))
+        raise GitEnvExit(3) from None
+
+    if pattern:
+        config = type(config)(**{**config.__dict__, "patterns": tuple(pattern)})
+
+    if not force:
+        dirty = check_primary_clean(repo.primary_root, config.patterns, config.exclude)
+        if dirty:
+            reporter.error(
+                "primary worktree has uncommitted changes to tracked env files: "
+                f"{', '.join(dirty)} (use --force to override)"
+            )
+            raise GitEnvExit(2)
+
+    try:
+        result = run_sync(
+            repo,
+            config,
+            dry_run=dry_run,
+            force=force,
+            path=path,
+            reporter=reporter,
+        )
+    except SyncIOError as exc:
+        reporter.error(str(exc))
+        raise GitEnvExit(4) from None
+
+    if dry_run:
+        raise GitEnvExit(1 if result.would_change or result.conflicts else 0)
+    raise GitEnvExit(result.exit_code)
+
+
+def main() -> None:
+    argv = rewrite_help_subcommand(sys.argv[1:])
+    try:
+        parser = build_parser()
+        args = parser.parse_args(argv)
+
+        if args.porcelain:
+            print(
+                "git env: --porcelain is reserved for a future version and is not yet"
+                " supported",
+                file=sys.stderr,
+            )
+            raise GitEnvExit(3)
+        if args.install_completions is not None:
+            print(
+                render_completions_install(args.install_completions, write=args.write)
+            )
+            raise GitEnvExit(0)
+        if args.write:
+            print("git env: --write requires --install-completions", file=sys.stderr)
+            raise GitEnvExit(3)
+        if args.verbose and args.quiet:
+            print(
+                "git env: --verbose and --quiet are mutually exclusive", file=sys.stderr
+            )
+            raise GitEnvExit(3)
+
+        reporter = Reporter(verbose=args.verbose, quiet=args.quiet)
+
+        match args.command:
+            case None:
+                parser.error("a subcommand is required, try 'git env --help'")
+            case "sync":
+                sync(
+                    pattern=args.pattern,
+                    path=args.path,
+                    dry_run=args.dry_run,
+                    force=args.force,
+                    reporter=reporter,
+                )
+
+    except GitEnvExit as exc:
+        sys.exit(exc.code)
+    except SystemExit as exc:
+        code = exc.code if isinstance(exc.code, int) else 1
+        if code == 2:
+            sys.exit(3)
+        raise

{git_env-0.3.0 → git_env-0.5.0}/src/git_env/discovery.py

@@ -102,10 +102,6 @@ class _IgnoreMatcher:
                 ignored = not negate
         return ignored
 
-    @property
-    def empty(self) -> bool:
-        return not self._rules
-
 
 def _load_ignore_matcher(primary_root: Path) -> _IgnoreMatcher:
     ignore_file = primary_root / ".envsyncignore"
@@ -148,7 +144,7 @@ def discover_env_files(
                 continue
             if child.is_symlink() and not config.follow_symlinks:
                 continue
-            if not ignore.empty and ignore.matches(rel_child_posix, is_dir=True):
+            if ignore.matches(rel_child_posix, is_dir=True):
                 continue
             kept_dirnames.append(dirname)
         dirnames[:] = kept_dirnames
@@ -162,7 +158,7 @@ def discover_env_files(
                 continue
             if _matches_any(filename, config.exclude):
                 continue
-            if not ignore.empty and ignore.matches(rel_posix, is_dir=False):
+            if ignore.matches(rel_posix, is_dir=False):
                 continue
 
             is_symlink = abs_path.is_symlink()

{git_env-0.3.0 → git_env-0.5.0}/src/git_env/repo.py

@@ -91,7 +91,7 @@ def detect_repository(cwd: Path | None = None) -> Repository:
         _git("rev-parse", "--path-format=absolute", "--show-toplevel", cwd=cwd).out
     ).resolve()
 
-    _check_pwd_within_worktree(worktree_root)
+    _check_pwd_within_worktree(cwd)
 
     return Repository(
         git_dir=git_dir.resolve(),
@@ -101,11 +101,11 @@ def detect_repository(cwd: Path | None = None) -> Repository:
     )
 
 
-def _check_pwd_within_worktree(worktree_root: Path) -> None:
+def _check_pwd_within_worktree(cwd: Path) -> None:
     """Paranoid check (spec: "Safety rails") that the shell-reported `$PWD`
-    is actually inside the worktree we just resolved. Catches weird
-    invocations (e.g. a symlinked directory pointing somewhere else) where
-    the shell's notion of cwd has diverged from the real one.
+    is actually the directory we resolved everything else from. Catches
+    weird invocations (e.g. a symlinked directory pointing somewhere else)
+    where the shell's notion of cwd has diverged from the real one.
 
     Skipped if `$PWD` isn't set, since not every caller sets it.
     """
@@ -113,10 +113,8 @@ def _check_pwd_within_worktree(worktree_root: Path) -> None:
     if not pwd:
         return
     resolved_pwd = Path(pwd).resolve()
-    if resolved_pwd != worktree_root and worktree_root not in resolved_pwd.parents:
-        raise RepoError(
-            f"$PWD ({pwd}) is not within the current worktree at {worktree_root}"
-        )
+    if resolved_pwd != cwd:
+        raise RepoError(f"$PWD ({pwd}) is not within the current worktree at {cwd}")
 
 
 def check_primary_clean(

{git_env-0.3.0 → git_env-0.5.0}/src/git_env/sync.py

@@ -48,12 +48,6 @@ class SyncResult:
         return 0
 
 
-def _filter_path(files: list[DiscoveredFile], path: str | None) -> list[DiscoveredFile]:
-    if path is None:
-        return files
-    prefix = Path(path)
-    return [f for f in files if prefix in (f.relative_path, *f.relative_path.parents)]
-
 
 def _resolve_dest(worktree_root: Path, relative_path: Path) -> Path:
     """Resolve `relative_path` against `worktree_root`, refusing escapes.
@@ -122,6 +116,22 @@ def _atomic_copy(src: Path, dest: Path) -> None:
         raise SyncIOError(f"failed to copy {src} -> {dest}: {exc}") from exc
 
 
+def _exclude_can_ever_match(config: SyncConfig) -> bool:
+    """Whether any filename could possibly satisfy both `config.patterns` and
+    `config.exclude` (both are fnmatch globs).
+
+    Exclude entries are almost always literal filenames (e.g. ".env.example"),
+    so testing each one against every include pattern is a cheap, correct
+    way to rule out the common case (e.g. patterns=(".env",) can never match
+    ".env.example") without walking the filesystem to find out.
+    """
+    return any(
+        fnmatch.fnmatch(exclude, pattern)
+        for pattern in config.patterns
+        for exclude in config.exclude
+    )
+
+
 def _cleanup_excluded_in_linked(
     worktree_root: Path,
     config: SyncConfig,
@@ -135,6 +145,9 @@ def _cleanup_excluded_in_linked(
     Excluded patterns are for committed templates (e.g. .env.example) that git
     checks out into linked worktrees but that sync should never treat as env files.
     """
+    if not _exclude_can_ever_match(config):
+        return 0
+
     root = worktree_root
     search_root = (root / path) if path else root
     if not search_root.is_dir():
@@ -173,7 +186,9 @@ def run_sync(
 ) -> SyncResult:
     """Sync env files from `repo.primary_root` into `repo.worktree_root`."""
     files, warnings = discover_env_files(repo.primary_root, config)
-    files = _filter_path(files, path)
+    if path is not None:
+        prefix = Path(path)
+        files = [f for f in files if prefix in (f.relative_path, *f.relative_path.parents)]
 
     for warning in warnings:
         reporter.warn(f"{warning.relative_path}: {warning.message}")

git_env-0.3.0/src/git_env/cli.py

@@ -1,183 +0,0 @@
-"""Top-level CLI: dispatches `git env <subcommand>` via arguably.
-
-Exit codes are part of the spec's contract (see spec.md):
-  0 success, 1 sync conflicts skipped, 2 refused to run, 3 usage error, 4 I/O error.
-argparse itself always raises `SystemExit(2)` for usage errors (bad flag, unknown
-subcommand), which collides with our "refused to run" code. `GitEnvExit` lets
-command bodies signal an intentional exit code; any other `SystemExit(2)` reaching
-`main()` therefore came from argparse and is remapped to 3.
-"""
-
-from __future__ import annotations
-
-import sys
-
-import arguably
-
-from .config import ConfigError, load_config
-from .output import Reporter
-from .repo import RepoError, check_primary_clean, detect_repository
-from .shell_completions import SUPPORTED_SHELLS
-from .shell_completions import install_completions as render_completions_install
-from .sync import SyncIOError, run_sync
-
-#: Names set aside for future official subcommands (see spec.md Extensibility).
-RESERVED_SUBCOMMANDS = frozenset({"push", "diff", "status", "list", "edit", "check"})
-
-
-class GitEnvExit(Exception):
-    """Raised by command bodies to request a specific process exit code."""
-
-    def __init__(self, code: int) -> None:
-        super().__init__(code)
-        self.code = code
-
-
-@arguably.command
-def __root__(
-    *, porcelain: bool = False, install_completions: str | None = None, write: bool = False
-) -> None:
-    """
-    git env: sync environment files across linked git worktrees.
-
-    Args:
-        porcelain: reserved for a future machine-readable output mode (not yet supported)
-        install_completions: print a completion snippet for [bash|zsh|fish]; combine with
-            --write to install the completion file instead of printing it
-        write: used with --install-completions, write the completion file to its standard
-            location instead of printing a snippet
-    """
-    if porcelain:
-        print(
-            "git env: --porcelain is reserved for a future version and is not yet"
-            " supported",
-            file=sys.stderr,
-        )
-        raise GitEnvExit(3)
-    if install_completions is not None:
-        if install_completions not in SUPPORTED_SHELLS:
-            print(
-                "git env: --install-completions expects one of "
-                f"{', '.join(SUPPORTED_SHELLS)}, got {install_completions!r}",
-                file=sys.stderr,
-            )
-            raise GitEnvExit(3)
-        print(render_completions_install(install_completions, write=write))
-        raise GitEnvExit(0)
-    if write:
-        print("git env: --write requires --install-completions", file=sys.stderr)
-        raise GitEnvExit(3)
-    if arguably.is_target():
-        arguably.error("a subcommand is required, try 'git env --help'")
-
-
-@arguably.command
-def sync(
-    *,
-    dry_run: bool = False,
-    force: bool = False,
-    verbose: bool = False,
-    quiet: bool = False,
-    pattern: list[str] | None = None,
-    path: str | None = None,
-) -> None:
-    """
-    Copy env files from the primary worktree into the current linked worktree.
-
-    Args:
-        dry_run: [-n] print actions, change nothing
-        force: [-f] overwrite local files even when they differ from the primary
-        verbose: [-v] print every file considered, including skips
-        quiet: [-q] suppress non-error output
-        pattern: glob to sync, repeatable; overrides configured patterns for this run
-        path: restrict to a subdirectory of the worktree
-    """
-    if verbose and quiet:
-        print("git env sync: --verbose and --quiet are mutually exclusive", file=sys.stderr)
-        raise GitEnvExit(3)
-
-    reporter = Reporter(verbose=verbose, quiet=quiet)
-
-    try:
-        repo = detect_repository()
-    except RepoError as exc:
-        reporter.error(str(exc))
-        raise GitEnvExit(2) from None
-
-    try:
-        config = load_config(repo.primary_root)
-    except ConfigError as exc:
-        reporter.error(str(exc))
-        raise GitEnvExit(3) from None
-
-    if pattern:
-        config = type(config)(**{**config.__dict__, "patterns": tuple(pattern)})
-
-    if not force:
-        dirty = check_primary_clean(repo.primary_root, config.patterns, config.exclude)
-        if dirty:
-            reporter.error(
-                "primary worktree has uncommitted changes to tracked env files: "
-                f"{', '.join(dirty)} (use --force to override)"
-            )
-            raise GitEnvExit(2)
-
-    try:
-        result = run_sync(
-            repo,
-            config,
-            dry_run=dry_run,
-            force=force,
-            path=path,
-            reporter=reporter,
-        )
-    except SyncIOError as exc:
-        reporter.error(str(exc))
-        raise GitEnvExit(4) from None
-
-    if dry_run:
-        raise GitEnvExit(1 if result.would_change or result.conflicts else 0)
-    raise GitEnvExit(result.exit_code)
-
-
-def _rewrite_help_subcommand(argv: list[str]) -> list[str]:
-    """Translate `git env help [subcommand]` into `git env [subcommand] --help`."""
-    if argv and argv[0] == "help":
-        rest = argv[1:]
-        return [*rest, "--help"]
-    return argv
-
-
-def _reject_reserved_subcommand(argv: list[str]) -> None:
-    """Give a clearer error than argparse's "invalid choice" for reserved names."""
-    for token in argv:
-        if token == "--":
-            return
-        if token.startswith("-"):
-            continue
-        if token in RESERVED_SUBCOMMANDS:
-            print(
-                f"git env: '{token}' is reserved for future use and is not yet"
-                " implemented",
-                file=sys.stderr,
-            )
-            raise GitEnvExit(3)
-        return
-
-
-def main() -> None:
-    argv = _rewrite_help_subcommand(sys.argv[1:])
-    sys.argv = [sys.argv[0], *argv]
-    try:
-        _reject_reserved_subcommand(argv)
-        arguably.run(
-            name="git env",
-            version_flag=True,
-        )
-    except GitEnvExit as exc:
-        sys.exit(exc.code)
-    except SystemExit as exc:
-        code = exc.code if isinstance(exc.code, int) else 1
-        if code == 2:
-            sys.exit(3)
-        raise