batchfetch 1.3.7__tar.gz → 1.3.8__tar.gz

{batchfetch-1.3.7 → batchfetch-1.3.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: batchfetch
-Version: 1.3.7
+Version: 1.3.8
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -80,7 +80,7 @@ tasks:
     delete: true
 ```
 
-Execute the `batchfetch` command from the same directory as `batchfetch.yml` to make it clone or update the local copies of the repositories above.
+Execute the `batchfetch` command from the same directory as `batchfetch.yaml` to make it clone or update the local copies of the repositories above.
 
 ## Command-line options
 
@@ -94,7 +94,7 @@ Efficiently clone/pull multiple Git repositories in parallel.
 positional arguments:
   target                This is a target path that batchfetch is supposed to
                         handle. When no target is specified, execute the tasks
-                        of all target paths defined in the batchfetch.yml list
+                        of all target paths defined in the batchfetch.yaml list
                         of tasks.
 
 options:
@@ -173,20 +173,6 @@ tasks:
     revision: b9c6d9b6134b4981760893254f804a371ffbc899
 ```
 
-### How to configure additional Git remotes?
-
-You can define additional remotes for a Git repository using the `remote` option. Pass a list of key-value pairs where the key is the remote name and the value is the corresponding URL. Batchfetch will automatically ensure these remotes are present and point to the correct URLs.
-
-```yaml
----
-tasks:
-  - git: https://github.com/jamescherti/easysession.el
-    path: emacs/easysession
-    remote:
-      upstream: https://github.com/name/repo
-      upstream2: https://github.com/name/repo2
-```
-
 ### How to customize Git clone, merge, and update strategies?
 
 Batchfetch allows you to define advanced options for interacting with Git repositories. These parameters can be declared globally under the `options` block to apply to all tasks, or individually within a specific task to override the global defaults.
@@ -219,6 +205,20 @@ tasks:
 
 ```
 
+### How to configure additional Git remotes?
+
+You can define additional remotes for a Git repository using the `remote` option. Pass a list of key-value pairs where the key is the remote name and the value is the corresponding URL. Batchfetch will automatically ensure these remotes are present and point to the correct URLs.
+
+```yaml
+---
+tasks:
+  - git: https://github.com/jamescherti/easysession.el
+    path: emacs/easysession
+    remote:
+      upstream: https://github.com/name/repo
+      upstream2: https://github.com/name/repo2
+```
+
 ### How to execute a command before and after a task?
 
 To execute a command both before and after a specific task, you can define the `exec_before` and `exec_after` directives within the task configuration. These directives specify commands to be executed at the respective stages of the task lifecycle.
@@ -236,9 +236,9 @@ tasks:
 
 ### How to make batchfetch handle only one path?
 
-To configure `batchfetch` to handle a specific path, you can define your tasks in a `batchfetch.yml` file and pass the desired path as an argument to the `batchfetch` command.
+To configure `batchfetch` to handle a specific path, you can define your tasks in a `batchfetch.yaml` file and pass the desired path as an argument to the `batchfetch` command.
 
-#### Example `batchfetch.yml` file:
+#### Example `batchfetch.yaml` file:
 
 In the following example, the `easysession` task clones two Git repositories:
 
@@ -258,7 +258,7 @@ To make `batchfetch` clone only `easysession`, pass its path as an argument:
 batchfetch easysession
 ```
 
-This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yml` file.
+This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yaml` file.
 
 ### How can I configure batchfetch to load a file other than batchfetch.yaml?
 

{batchfetch-1.3.7 → batchfetch-1.3.8}/README.md

@@ -46,7 +46,7 @@ tasks:
     delete: true
 ```
 
-Execute the `batchfetch` command from the same directory as `batchfetch.yml` to make it clone or update the local copies of the repositories above.
+Execute the `batchfetch` command from the same directory as `batchfetch.yaml` to make it clone or update the local copies of the repositories above.
 
 ## Command-line options
 
@@ -60,7 +60,7 @@ Efficiently clone/pull multiple Git repositories in parallel.
 positional arguments:
   target                This is a target path that batchfetch is supposed to
                         handle. When no target is specified, execute the tasks
-                        of all target paths defined in the batchfetch.yml list
+                        of all target paths defined in the batchfetch.yaml list
                         of tasks.
 
 options:
@@ -139,20 +139,6 @@ tasks:
     revision: b9c6d9b6134b4981760893254f804a371ffbc899
 ```
 
-### How to configure additional Git remotes?
-
-You can define additional remotes for a Git repository using the `remote` option. Pass a list of key-value pairs where the key is the remote name and the value is the corresponding URL. Batchfetch will automatically ensure these remotes are present and point to the correct URLs.
-
-```yaml
----
-tasks:
-  - git: https://github.com/jamescherti/easysession.el
-    path: emacs/easysession
-    remote:
-      upstream: https://github.com/name/repo
-      upstream2: https://github.com/name/repo2
-```
-
 ### How to customize Git clone, merge, and update strategies?
 
 Batchfetch allows you to define advanced options for interacting with Git repositories. These parameters can be declared globally under the `options` block to apply to all tasks, or individually within a specific task to override the global defaults.
@@ -185,6 +171,20 @@ tasks:
 
 ```
 
+### How to configure additional Git remotes?
+
+You can define additional remotes for a Git repository using the `remote` option. Pass a list of key-value pairs where the key is the remote name and the value is the corresponding URL. Batchfetch will automatically ensure these remotes are present and point to the correct URLs.
+
+```yaml
+---
+tasks:
+  - git: https://github.com/jamescherti/easysession.el
+    path: emacs/easysession
+    remote:
+      upstream: https://github.com/name/repo
+      upstream2: https://github.com/name/repo2
+```
+
 ### How to execute a command before and after a task?
 
 To execute a command both before and after a specific task, you can define the `exec_before` and `exec_after` directives within the task configuration. These directives specify commands to be executed at the respective stages of the task lifecycle.
@@ -202,9 +202,9 @@ tasks:
 
 ### How to make batchfetch handle only one path?
 
-To configure `batchfetch` to handle a specific path, you can define your tasks in a `batchfetch.yml` file and pass the desired path as an argument to the `batchfetch` command.
+To configure `batchfetch` to handle a specific path, you can define your tasks in a `batchfetch.yaml` file and pass the desired path as an argument to the `batchfetch` command.
 
-#### Example `batchfetch.yml` file:
+#### Example `batchfetch.yaml` file:
 
 In the following example, the `easysession` task clones two Git repositories:
 
@@ -224,7 +224,7 @@ To make `batchfetch` clone only `easysession`, pass its path as an argument:
 batchfetch easysession
 ```
 
-This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yml` file.
+This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yaml` file.
 
 ### How can I configure batchfetch to load a file other than batchfetch.yaml?
 

{batchfetch-1.3.7 → batchfetch-1.3.8}/batchfetch/batchfetch_base.py

@@ -31,7 +31,7 @@ from .helpers import run_indent_str
 
 
 class BatchFetchError(Exception):
-    """Exception raised by Downloader()."""
+    """Exception raised by batchfetch functions."""
 
 
 class DataAlreadyInitialized(Exception):
@@ -39,7 +39,10 @@ class DataAlreadyInitialized(Exception):
 
 
 class TaskBase:
+    """Base class representing a general task to be executed."""
+
     def __init__(self, data: dict[str, Any], options: dict[str, Any]) -> None:
+        """Initialize the task with specific data and options."""
         self.global_options_schema: dict[Any, Any] = {}
         self.global_options_values: dict[str, Any] = options
 
@@ -54,6 +57,7 @@ class TaskBase:
         self._values_initialized = False
 
     def _initialize_data(self) -> None:
+        """Initialize the options and data values for the task."""
         if self._values_initialized:
             raise DataAlreadyInitialized
 
@@ -79,9 +83,11 @@ class TaskBase:
         }
 
     def validate_schema(self) -> None:
+        """Validate the schema of the task data and options."""
         self._initialize_data()
 
     def __getitem__(self, key: str) -> Any:
+        """Retrieve an item from the task values or options."""
         self._initialize_data()
 
         if key in self.values:
@@ -90,13 +96,14 @@ class TaskBase:
         if key in self.options:
             return self.options[key]
 
-        raise KeyError(f"The item '{key}' was not found in '{self.values}")
+        raise KeyError(f"The item '{key}' was not found in '{self.values}'")
 
 
 class TaskBatchFetch(TaskBase):
     """Plugin downloader base class."""
 
     def __init__(self, data: dict[str, Any], options: dict[str, Any]) -> None:
+        """Initialize the batchfetch task plugin."""
         new_options: dict[str, Any] = {"exec_before": [],
                                        "exec_after": [],
                                        "ignore_untracked": []}
@@ -132,6 +139,7 @@ class TaskBatchFetch(TaskBase):
         }
 
     def _initialize_data(self) -> None:
+        """Safely initialize data for the batchfetch task."""
         try:
             super()._initialize_data()
         except DataAlreadyInitialized:
@@ -141,6 +149,7 @@ class TaskBatchFetch(TaskBase):
         self._values_initialized = True
 
     def _local_task_exec(self, *args: Any, **kwargs: Any) -> None:
+        """Execute a local task command and capture its output."""
         stdout = run_indent_str(env=self.env, spaces=self.indent,
                                 *args, **kwargs)
         if not stdout.endswith("\n"):
@@ -148,6 +157,7 @@ class TaskBatchFetch(TaskBase):
         self.add_output(stdout)
 
     def _exec_before(self, cwd: os.PathLike = Path(".")) -> None:
+        """Execute pre-task commands defined in options and task items."""
         self._initialize_data()
         if self["delete"]:
             return
@@ -165,6 +175,7 @@ class TaskBatchFetch(TaskBase):
             self._local_task_exec(cmd, cwd=str(cwd))
 
     def _exec_after(self, cwd: os.PathLike = Path(".")) -> None:
+        """Execute post-task commands if the task was changed successfully."""
         self._initialize_data()
         if self["delete"] or self.is_error() or not self.is_changed():
             return
@@ -182,32 +193,39 @@ class TaskBatchFetch(TaskBase):
             self._local_task_exec(cmd, cwd=str(cwd))
 
     def is_changed(self) -> bool:
+        """Return True if the task execution resulted in changes."""
         self._initialize_data()
         return bool(self.values["result"]["changed"])
 
     def set_changed(self, changed: bool) -> None:
+        """Set the changed status of the task."""
         self._initialize_data()
         self.values["result"]["changed"] = changed
 
     def get_changed(self) -> bool:
+        """Return the changed status of the task without initializing data."""
         try:
             return bool(self.values["result"]["changed"])
         except KeyError:
             return False
 
     def is_error(self) -> bool:
+        """Return True if the task encountered an error."""
         self._initialize_data()
         return bool(self.values["result"]["error"])
 
     def set_error(self, error: bool) -> None:
+        """Set the error status of the task."""
         self._initialize_data()
         self.values["result"]["error"] = error
 
     def set_output(self, output: str) -> None:
+        """Set the output string of the task."""
         self._initialize_data()
         self.values["result"]["output"] = output
 
     def add_output(self, output: str) -> None:
+        """Append a string to the output of the task."""
         self._initialize_data()
         self.values["result"]["output"] += output
 
@@ -217,5 +235,6 @@ class TaskBatchFetch(TaskBase):
         return str(self.values["result"]["output"])
 
     def update(self) -> dict[str, Any]:
+        """Update the task data and return the current values."""
         self._initialize_data()
         return self.values

{batchfetch-1.3.7 → batchfetch-1.3.8}/batchfetch/batchfetch_cli.py

@@ -47,11 +47,12 @@ class BatchFetchCli:
     # pylint: disable=too-many-positional-arguments
     def __init__(self, max_workers: int, verbose: bool, check_untracked: bool,
                  targets: list[str], cwd: os.PathLike) -> None:
+        """Initialize the batchfetch command-line interface."""
         os.chdir(cwd)
         self._cwd = cwd
         self._logger = logging.getLogger(self.__class__.__name__)
         self.targets = {Path(item).absolute() for item in targets}
-        self.cfg: dict = {}
+        self.cfg: dict[str, Any] = {}
         self.check_untracked = check_untracked
         self.tracked_paths: dict[Path, set[str]] = {}
         self.ignore_untracked: set[Path] = set()
@@ -66,6 +67,7 @@ class BatchFetchCli:
         self._plugin_add("git", BatchFetchGit)
 
     def _plugin_add(self, keyword: str, batchfetch_class: Any) -> None:
+        """Register a plugin class and its schema."""
         batchfetch_instance = batchfetch_class(data={},
                                                options={})
         batchfetch_instance.validate_schema()
@@ -81,6 +83,7 @@ class BatchFetchCli:
         }
 
     def _plugin_get(self, raw_data: dict[str, Any]) -> str:
+        """Retrieve the correct plugin keyword based on raw data."""
         keyword_found = None
         for keyword in self.batchfetch_classes:
             if keyword in raw_data:
@@ -99,10 +102,12 @@ class BatchFetchCli:
         return keyword_found
 
     def load(self, path: Path) -> None:
+        """Load and parse the batchfetch YAML configuration file."""
         # pylint: disable=too-many-try-statements
         try:
             with open(path, "r", encoding="utf-8") as fhandler:
-                yaml_dict = yaml.load(fhandler, Loader=yaml.FullLoader)
+                yaml_dict: Any = \
+                    yaml.load(fhandler, Loader=yaml.FullLoader)
                 if not isinstance(yaml_dict, dict):
                     print(f"Error: Invalid format: {yaml_dict}.",
                           file=sys.stderr)
@@ -142,6 +147,7 @@ class BatchFetchCli:
             raise BatchFetchError(str(err)) from err
 
     def _loads(self, data: dict[str, Any]) -> None:
+        """Validate and load the configuration data dictionary."""
         schema = Schema(self.cfg_schema)
         try:
             schema.validate(data)
@@ -160,6 +166,7 @@ class BatchFetchCli:
         self._loads_tasks(data)
 
     def _loads_tasks(self, data: dict[str, Any]) -> None:
+        """Load and validate tasks from the configuration data."""
         if "tasks" not in data:
             return
 
@@ -191,6 +198,7 @@ class BatchFetchCli:
     # pylint: disable=too-many-branches
     # pylint: disable=too-many-statements
     def run_tasks(self) -> bool:
+        """Execute all configured tasks in parallel using a thread pool."""
         failed = []
         error = False
         threads = []
@@ -279,7 +287,7 @@ class BatchFetchCli:
 
             return False
         else:
-            if self.check_untracked:
+            if self.check_untracked and not self.targets:
                 self._find_untracked_paths()
 
             if num_success == 0:
@@ -358,7 +366,7 @@ def parse_args() -> argparse.Namespace:
         "targets", metavar="target", type=str, nargs="*",
         help=("This is a target path that batchfetch is supposed to handle. "
               "When no target is specified, execute the tasks of all target "
-              "paths defined in the batchfetch.yml list of tasks."),
+              "paths defined in the batchfetch.yaml list of tasks."),
     )
 
     parser.add_argument(
@@ -421,7 +429,7 @@ def parse_args() -> argparse.Namespace:
 
 
 def command_line_interface() -> None:
-    """Command line interface."""
+    """Entry point for the command line interface."""
     # pylint: disable=too-many-try-statements
     try:
         errno = 0
@@ -459,7 +467,7 @@ def command_line_interface() -> None:
         except KeyboardInterrupt:
             print("Interrupted.", file=sys.stderr)
             errno = 1
-        except (yaml.parser.MarkedYAMLError, BatchFetchError) as err:
+        except (yaml.error.MarkedYAMLError, BatchFetchError) as err:
             print(f"Error: {err}.", file=sys.stderr)
             errno = 1
 

{batchfetch-1.3.7 → batchfetch-1.3.8}/batchfetch/batchfetch_git.py

@@ -20,6 +20,7 @@
 
 from __future__ import annotations
 
+import logging
 import os
 import shutil
 import subprocess
@@ -45,9 +46,10 @@ class BatchFetchGit(TaskBatchFetch):
     """Clone or update a Git repository."""
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
+        """Initialize the Git batchfetch task."""
         self._git_fetch_origin_done = False
 
-        self.branch_commit_ref = None
+        self.branch_commit_ref: str | None = None
         self.is_branch = False
 
         super().__init__(*args, **kwargs)
@@ -90,10 +92,11 @@ class BatchFetchGit(TaskBatchFetch):
         })
 
         self.git_local_dir = Path(self["path"])
-        self.current_branch = None
-        self.current_commit_ref = None
+        self.current_branch: str | None = None
+        self.current_commit_ref: str | None = None
 
     def _initialize_data(self) -> None:
+        """Initialize and parse the repository path data."""
         super()._initialize_data()
 
         self.values[self.main_key] = \
@@ -149,8 +152,15 @@ class BatchFetchGit(TaskBatchFetch):
                 self._exec_before(cwd=self.git_local_dir)
 
                 if not self["revision"]:
-                    self.values["revision"] = self._run_get_firstline(
-                        "git symbolic-ref --short HEAD")
+                    # Attempt to read the default branch from local origin/HEAD
+                    sym_ref = self._run_get_firstline(
+                        ["git", "symbolic-ref", "--short",
+                         "refs/remotes/origin/HEAD"]
+                    ).strip()
+                    if sym_ref.startswith("origin/"):
+                        self.values["revision"] = \
+                            sym_ref.split("origin/", 1)[1]
+
                     if not self["revision"]:
                         raise BatchFetchError(
                             "Unable to determine the default origin branch"
@@ -187,6 +197,7 @@ class BatchFetchGit(TaskBatchFetch):
         return self.values
 
     def _run_get_firstline(self, *args: Any, **kwargs: Any) -> str:
+        """Run a command and return the first line of standard output."""
         stdout, _ = self._run(*args, **kwargs)
         try:
             return stdout[0]
@@ -194,8 +205,8 @@ class BatchFetchGit(TaskBatchFetch):
             return ""
 
     def _run(self, cmd: Union[list[str], str],
-             cwd: Union[None, os.PathLike] = None,
-             env: Union[None, dict] = None,
+             cwd: Union[None, os.PathLike, str] = None,
+             env: Union[None, dict[str, str]] = None,
              **kwargs: Any) -> tuple[list[str], list[str]]:
         """Execute a command and return stdout and stderr.
 
@@ -214,6 +225,33 @@ class BatchFetchGit(TaskBatchFetch):
             env = self.env
         return run_simple(cmd=cmd, env=env, cwd=cwd, **kwargs)
 
+    def _get_upstream_branch(self) -> str:
+        """Return the upstream tracking branch for the current branch."""
+        if not self.current_branch:
+            raise BatchFetchError(
+                "Not currently on any branch. Cannot determine upstream."
+            )
+
+        try:
+            stdout, _ = self._run(
+                ["git", "rev-parse", "--abbrev-ref",
+                 f"{self.current_branch}@{{upstream}}"]
+            )
+            # TODO: Don't repeat strip 2 times
+            if stdout and stdout[0].strip():
+                return stdout[0].strip()
+        except subprocess.CalledProcessError as err:
+            raise BatchFetchError(
+                "No upstream tracking branch found "
+                f"for '{self.current_branch}'. "
+                "Please configure an upstream branch before updating."
+            ) from err
+
+        raise BatchFetchError(
+            "Failed to parse upstream tracking "
+            f"branch for '{self.current_branch}'."
+        )
+
     def _git_ref(self, cwd: Union[None, Path] = None) -> str:
         """Get the commit revision of HEAD.
 
@@ -228,6 +266,7 @@ class BatchFetchGit(TaskBatchFetch):
         return output
 
     def _update_current_branch_name(self) -> None:
+        """Update instance variables with the current branch and commit."""
         try:
             # This returns the branch name
             stdout, _ = self._run(["git", "symbolic-ref", "--short", "HEAD"])
@@ -250,6 +289,7 @@ class BatchFetchGit(TaskBatchFetch):
                 pass
 
     def _repo_delete(self) -> None:
+        """Delete the local Git repository directory safely."""
         if not self.git_local_dir.exists():
             self.add_output(self.indent_spaces + "[INFO] Already deleted\n")
         elif not self.git_local_dir.joinpath(".git").is_dir():
@@ -266,6 +306,7 @@ class BatchFetchGit(TaskBatchFetch):
             self.set_changed(True)
 
     def _repo_clone(self) -> None:
+        """Execute git clone for the task repository."""
         git_clone_args = self["git_clone_args"]
         # git_clone_args += ["--recurse-submodules"]
 
@@ -275,14 +316,16 @@ class BatchFetchGit(TaskBatchFetch):
         self.set_changed(True)
 
     def _repo_fetch(self) -> bool:
+        """Fetch the remote repository and determine if an update is needed."""
         # Merge
         do_git_fetch = self["git_pull"]
-        do_git_fetch = False
 
         try:
             # Check if the revision such as
             _, _ = self._run(["git", "cat-file", "-e", self["revision"]])
-        except subprocess.CalledProcessError:
+        except subprocess.CalledProcessError as err:
+            logging.debug("Ignoring subprocess error checking cat-file: %s",
+                          err)
             do_git_fetch = True
             self.add_output(
                 self.indent_spaces
@@ -303,8 +346,11 @@ class BatchFetchGit(TaskBatchFetch):
                     + f"{self['revision']} is a branch, not a tag"
                     + "\n")
                 do_git_fetch = True
-            except subprocess.CalledProcessError:
-                pass
+            except subprocess.CalledProcessError as err:
+                logging.debug(
+                    "Ignoring subprocess error checking show-ref: %s",
+                    err,
+                )
 
         if not do_git_fetch:
             self.add_output(self.indent_spaces + "[INFO] git fetch ignored\n")
@@ -323,6 +369,7 @@ class BatchFetchGit(TaskBatchFetch):
             return False
 
     def _git_apply_update_strategy(self) -> bool:
+        """Merge, rebase, or reset local branches according to the strategy."""
         git_updated = False
 
         # Merge, Rebase, or Reset
@@ -343,34 +390,44 @@ class BatchFetchGit(TaskBatchFetch):
                         "prevent data loss."
                     )
 
+            # Retrieve upstream branch or raise exception if not found
+            upstream_branch = self._get_upstream_branch()
+
             self.add_output(
                 self.indent_spaces
                 + f"[INFO] Applying update strategy: {strategy} from "
-                f"origin/{self.current_branch}\n"
+                f"{upstream_branch}\n"
             )
 
             if strategy == "rebase":
-                self._run(["git", "rebase"] +
-                          [f"origin/{self.current_branch}"])
+                self._run(["git", "rebase"] + [upstream_branch])
             elif strategy == "reset":
-                self._run(["git", "reset", "--hard",
-                           f"origin/{self.current_branch}"])
+                self._run(["git", "reset", "--hard", upstream_branch])
             else:
                 self._run(["git", "merge"] + self["git_merge_args"] +
-                          [f"origin/{self.current_branch}"])
+                          [upstream_branch])
 
             git_ref_after_update = self._git_ref(cwd=self.git_local_dir)
             if commit_ref_head != git_ref_after_update:
                 git_updated = True
                 self.set_changed(True)
-                self._run(["git", "log",
-                           '--pretty=format:"%h %ad %s [%cn]"',
-                           "--decorate", "--date=short",
-                           f"{commit_ref_head}..{git_ref_after_update}"])
+                stdout, _ = self._run([
+                    "git", "log",
+                    "--pretty=format:%h %ad %s [%cn]",
+                    "--decorate", "--date=short",
+                    f"{commit_ref_head}..{git_ref_after_update}"
+                ])
+                if stdout:
+                    self.add_output(self.indent_spaces +
+                                    "[INFO] Updated commits:\n")
+                    for line in stdout:
+                        self.add_output(self.indent_spaces +
+                                        "  " + line + "\n")
 
         return git_updated
 
     def _git_get_remote_url(self, remote_name: str = "origin") -> str:
+        """Retrieve the configured url for the given remote name."""
         origin_url = ""
         try:
             stdout, _ = self._run(["git", "config",
@@ -384,6 +441,7 @@ class BatchFetchGit(TaskBatchFetch):
 
     def _git_set_remote_url(self, url: str,
                             remote_name: str = "origin") -> str:
+        """Reconfigure or add a Git remote with a new target url."""
         origin_url = ""
         try:
             self._run(["git", "remote", "remove", remote_name])
@@ -418,6 +476,7 @@ class BatchFetchGit(TaskBatchFetch):
         return False
 
     def _git_rev_parse_verify(self, revision: str) -> list[str]:
+        """Verify and return the parsed reference for a git revision."""
         stdout: list[str] = []
         error = False
         try:
@@ -434,6 +493,7 @@ class BatchFetchGit(TaskBatchFetch):
         return stdout
 
     def _repo_fix_branch(self) -> bool:
+        """Check out the correct revision branch if current branch differs."""
         git_ref_after_merge = self._git_ref(cwd=self.git_local_dir)
         branch_changed = False
         if self["revision"]:
@@ -441,24 +501,35 @@ class BatchFetchGit(TaskBatchFetch):
             # returns a different commit revision
             git_tags, _ = self._run(["git", "tag", "--points-at", "HEAD"])
 
+            is_branch = False
             # Also check the commit revision in case
             # branch is a commit revision instead of a tag
             try:
-                # Check if the branch exists
+                # Check if the branch exists remotely
                 git_ref_branch = self._git_rev_parse_verify("origin/"
                                                             + self["revision"]
                                                             + "^{commit}")[0]
+                is_branch = True
             except GitRevisionDoesNotExist:
                 # Check if the commit ref exists
                 try:
                     git_ref_branch = \
                         self._git_rev_parse_verify(self["revision"])[0]
+                    if self._git_is_local_branch(self["revision"]):
+                        is_branch = True
                 except GitRevisionDoesNotExist as err:
                     raise BatchFetchError(f"The branch '{self['revision']}' "
                                           "does not exist.") from err
 
-            if git_ref_after_merge != git_ref_branch and \
-                    self["revision"] not in git_tags:
+            needs_checkout = False
+            if self.current_branch != self["revision"]:
+                if is_branch:
+                    needs_checkout = True
+                elif git_ref_after_merge != git_ref_branch and \
+                        self["revision"] not in git_tags:
+                    needs_checkout = True
+
+            if needs_checkout:
                 # Update the branch
                 self._run(["git", "checkout"] + [self["revision"]])
                 self.add_output(self.indent_spaces
@@ -473,6 +544,7 @@ class BatchFetchGit(TaskBatchFetch):
         return branch_changed
 
     def _git_fetch_origin(self) -> None:
+        """Execute `git fetch origin` if it has not already been done."""
         # Fetch
         if not self._git_fetch_origin_done:
             cmd = ["git", "fetch", "origin"]
@@ -480,6 +552,7 @@ class BatchFetchGit(TaskBatchFetch):
             self._git_fetch_origin_done = True
 
     def _repo_fix_remote_origin(self) -> None:
+        """Ensure remote origin URL matches configuration and upstream sets."""
         correct_origin_url = self[self.main_key]
         update_remote_origin = False
 
@@ -491,6 +564,15 @@ class BatchFetchGit(TaskBatchFetch):
             update_remote_origin = True
 
         if update_remote_origin:
+            # We must fetch the upstream branch BEFORE updating the remote,
+            # because removing the remote drops the tracking configuration.
+            upstream_branch = None
+            if self.current_branch:
+                try:
+                    upstream_branch = self._get_upstream_branch()
+                except BatchFetchError:
+                    pass
+
             # Update remote
             try:
                 self._git_set_remote_url(correct_origin_url)
@@ -501,17 +583,20 @@ class BatchFetchGit(TaskBatchFetch):
             # Get the current branch
             if self.current_branch:
                 try:
+                    target_upstream = (upstream_branch if upstream_branch
+                                       else f"origin/{self.current_branch}")
+
                     self.add_output(
                         self.indent_spaces
                         + "[INFO] Git fetch origin reason: "
                         f"we need to set the upstream "
-                        f"origin to {self.current_branch}"
+                        f"origin to {target_upstream}"
                         "\n"
                     )
                     self._git_fetch_origin()
 
                     cmd = ["git", "branch",
-                           f"--set-upstream-to=origin/{self.current_branch}"]
+                           f"--set-upstream-to={target_upstream}"]
                     _, _ = self._run(cmd)
                     # TODO: handle errors
                 except subprocess.CalledProcessError as err:

{batchfetch-1.3.7 → batchfetch-1.3.8}/batchfetch.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: batchfetch
-Version: 1.3.7
+Version: 1.3.8
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -80,7 +80,7 @@ tasks:
     delete: true
 ```
 
-Execute the `batchfetch` command from the same directory as `batchfetch.yml` to make it clone or update the local copies of the repositories above.
+Execute the `batchfetch` command from the same directory as `batchfetch.yaml` to make it clone or update the local copies of the repositories above.
 
 ## Command-line options
 
@@ -94,7 +94,7 @@ Efficiently clone/pull multiple Git repositories in parallel.
 positional arguments:
   target                This is a target path that batchfetch is supposed to
                         handle. When no target is specified, execute the tasks
-                        of all target paths defined in the batchfetch.yml list
+                        of all target paths defined in the batchfetch.yaml list
                         of tasks.
 
 options:
@@ -173,20 +173,6 @@ tasks:
     revision: b9c6d9b6134b4981760893254f804a371ffbc899
 ```
 
-### How to configure additional Git remotes?
-
-You can define additional remotes for a Git repository using the `remote` option. Pass a list of key-value pairs where the key is the remote name and the value is the corresponding URL. Batchfetch will automatically ensure these remotes are present and point to the correct URLs.
-
-```yaml
----
-tasks:
-  - git: https://github.com/jamescherti/easysession.el
-    path: emacs/easysession
-    remote:
-      upstream: https://github.com/name/repo
-      upstream2: https://github.com/name/repo2
-```
-
 ### How to customize Git clone, merge, and update strategies?
 
 Batchfetch allows you to define advanced options for interacting with Git repositories. These parameters can be declared globally under the `options` block to apply to all tasks, or individually within a specific task to override the global defaults.
@@ -219,6 +205,20 @@ tasks:
 
 ```
 
+### How to configure additional Git remotes?
+
+You can define additional remotes for a Git repository using the `remote` option. Pass a list of key-value pairs where the key is the remote name and the value is the corresponding URL. Batchfetch will automatically ensure these remotes are present and point to the correct URLs.
+
+```yaml
+---
+tasks:
+  - git: https://github.com/jamescherti/easysession.el
+    path: emacs/easysession
+    remote:
+      upstream: https://github.com/name/repo
+      upstream2: https://github.com/name/repo2
+```
+
 ### How to execute a command before and after a task?
 
 To execute a command both before and after a specific task, you can define the `exec_before` and `exec_after` directives within the task configuration. These directives specify commands to be executed at the respective stages of the task lifecycle.
@@ -236,9 +236,9 @@ tasks:
 
 ### How to make batchfetch handle only one path?
 
-To configure `batchfetch` to handle a specific path, you can define your tasks in a `batchfetch.yml` file and pass the desired path as an argument to the `batchfetch` command.
+To configure `batchfetch` to handle a specific path, you can define your tasks in a `batchfetch.yaml` file and pass the desired path as an argument to the `batchfetch` command.
 
-#### Example `batchfetch.yml` file:
+#### Example `batchfetch.yaml` file:
 
 In the following example, the `easysession` task clones two Git repositories:
 
@@ -258,7 +258,7 @@ To make `batchfetch` clone only `easysession`, pass its path as an argument:
 batchfetch easysession
 ```
 
-This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yml` file.
+This will execute only the task corresponding to the `easysession` path, skipping all others in the `batchfetch.yaml` file.
 
 ### How can I configure batchfetch to load a file other than batchfetch.yaml?
 

{batchfetch-1.3.7 → batchfetch-1.3.8}/setup.py

@@ -22,7 +22,7 @@ from setuptools import find_packages, setup
 
 setup(
     name="batchfetch",
-    version="1.3.7",
+    version="1.3.8",
     packages=find_packages(),
     description="Efficiently clone and pull multiple Git repositories.",
     license="GPLv3",