batchfetch 1.2.5__tar.gz → 1.2.6__tar.gz

{batchfetch-1.2.5 → batchfetch-1.2.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.2.5
+Version: 1.2.6
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -89,6 +89,31 @@ options:
   -v, --verbose         Enable verbose mode.
 ```
 
+## Frequently Asked Questions
+
+### What are untracked files?
+
+The parent directory of the "path:" value defines the managed directory, where the directory of each path is considered as the managed directory.
+
+For example, if the "path:" value is `file/my-project`, the managed directory will be `file/`. Any file within `file/` that is not managed by batchfetch will be considered an untracked file.
+
+When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked_paths` list, enabling users to manage untracked files effectively.
+
+Here is an example of a *batchfetch.yaml* file that enables *batchfetch* to accept a list of untracked files:
+
+``` yaml
+options:
+  ignore_untracked_paths:
+    - ./test
+    - /absolute/path
+    - ../relative/path
+
+tasks:
+  - git: https://github.com/user/project
+```
+
+By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked_paths* option.
+
 ## License
 
 Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)

{batchfetch-1.2.5 → batchfetch-1.2.6}/README.md

@@ -69,6 +69,31 @@ options:
   -v, --verbose         Enable verbose mode.
 ```
 
+## Frequently Asked Questions
+
+### What are untracked files?
+
+The parent directory of the "path:" value defines the managed directory, where the directory of each path is considered as the managed directory.
+
+For example, if the "path:" value is `file/my-project`, the managed directory will be `file/`. Any file within `file/` that is not managed by batchfetch will be considered an untracked file.
+
+When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked_paths` list, enabling users to manage untracked files effectively.
+
+Here is an example of a *batchfetch.yaml* file that enables *batchfetch* to accept a list of untracked files:
+
+``` yaml
+options:
+  ignore_untracked_paths:
+    - ./test
+    - /absolute/path
+    - ../relative/path
+
+tasks:
+  - git: https://github.com/user/project
+```
+
+By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked_paths* option.
+
 ## License
 
 Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)

{batchfetch-1.2.5 → batchfetch-1.2.6}/batchfetch/batchfetch_base.py

@@ -107,6 +107,7 @@ class TaskBatchFetch(TaskBase):
         self.global_options_schema: Dict[Any, Any] = {
             Optional("exec_before"): Or([str], str),
             Optional("exec_after"): Or([str], str),
+            Optional("ignore_untracked_paths"): Or([str], str),
         }
 
         self.task_schema: Dict[Any, Any] = {
@@ -120,6 +121,7 @@ class TaskBatchFetch(TaskBase):
         self.global_options_values: Dict[str, Any] = {
             "exec_before": [],
             "exec_after": [],
+            "ignore_untracked_paths": [],
         }
 
         self.task_default_values: Dict[str, Any] = {

{batchfetch-1.2.5 → batchfetch-1.2.6}/batchfetch/batchfetch_cli.py

@@ -43,7 +43,8 @@ class BatchFetchCli:
     def __init__(self, max_workers: int, verbose: bool = False):
         self.cfg: dict = {}
         self.folder = Path(".")
-        self.managed_paths: Set[Path] = set()
+        self.tracked_paths: Dict[Path, Set[str]] = {}
+        self.ignore_untracked_paths: Set[Path] = set()
         self.verbose = verbose
         self.max_workers = max_workers
         self._logger = logging.getLogger(self.__class__.__name__)
@@ -97,6 +98,22 @@ class BatchFetchCli:
                           file=sys.stderr)
                     sys.exit(1)
 
+                self.ignore_untracked_paths.add(Path(path).absolute())
+                self.ignore_untracked_paths.add(Path(path).resolve())
+                untracked_paths = None
+                if "options" in yaml_dict:
+                    untracked_paths = \
+                        yaml_dict["options"]["ignore_untracked_paths"]
+
+                if isinstance(untracked_paths, str):
+                    untracked_paths = [untracked_paths]
+
+                if untracked_paths:
+                    for ignore_untracked_path in untracked_paths:
+                        self.ignore_untracked_paths.add(
+                            Path(ignore_untracked_path).absolute()
+                        )
+
                 self._loads(dict(yaml_dict))
         except OSError as err:
             raise BatchFetchError(str(err)) from err
@@ -154,7 +171,7 @@ class BatchFetchCli:
         error = False
         threads = []
         num_success = 0
-        self.managed_paths = set()
+        self.tracked_paths = {}
 
         executor_update = ThreadPoolExecutor(max_workers=self.max_workers)
 
@@ -165,7 +182,15 @@ class BatchFetchCli:
             for task in all_tasks:
                 self.dirs_relative_to_batchfetch.add(str(task["path"]))
                 if not task["delete"]:
-                    self.managed_paths.add(Path(task["path"]).absolute())
+                    full_path = Path(task["path"]).absolute()
+                    base_path = full_path.parent
+                    try:
+                        self.tracked_paths[base_path]
+                    except KeyError:
+                        self.tracked_paths[base_path] = set()
+
+                    self.tracked_paths[base_path].add(full_path.name)
+
                 threads.append(executor_update.submit(task.update))
 
             for future in as_completed(threads):
@@ -207,6 +232,8 @@ class BatchFetchCli:
 
             return False
         else:
+            self._find_untracked_paths()
+
             if num_success == 0:
                 print("Nothing to do.")
             elif not self.verbose:
@@ -214,11 +241,36 @@ class BatchFetchCli:
 
         return True
 
+    def _find_untracked_paths(self):
+        "Find the files that are untracked and should be deleted."
+        untracked_paths = set()
+        for tracked_dir, tracked_filenames in self.tracked_paths.items():
+            actual_filenames = {file.name for file in tracked_dir.iterdir()}
+            for filename in actual_filenames - tracked_filenames:
+                full_path = tracked_dir / filename
+                if full_path in self.ignore_untracked_paths:
+                    continue
+
+                untracked_paths.add(full_path)
+
+        if untracked_paths:
+            err_str = "The following files need to be deleted:\n"
+            for path in untracked_paths:
+                err_str += ("  - " +
+                            str(path) +
+                            ("/" if path.is_dir() else "") +
+                            "\n")
+            err_str += ("The paths above are not managed by batchfetch."
+                        " To retain them, add them to the "
+                        "options.ignore_untracked_paths list, using either "
+                        "relative or absolute paths")
+            raise BatchFetchError(err_str)
+
 
 def parse_args():
     """Parse the command line arguments."""
     desc = __doc__
-    usage = "%(prog)s [--option] [args]"
+    usage = "%(prog)s [--option]"
     parser = argparse.ArgumentParser(description=desc, usage=usage)
 
     parser.add_argument("-f",
@@ -255,8 +307,8 @@ def run_batchfetch_procedure(file: Path, args) -> int:
     errno = 0
     batchfetch_cli = BatchFetchCli(verbose=args.verbose,
                                    max_workers=int(args.jobs))
-    batchfetch_cli.load(file)
     os.chdir(file.parent)
+    batchfetch_cli.load(file)
 
     try:
         if not batchfetch_cli.run_tasks():

{batchfetch-1.2.5 → batchfetch-1.2.6}/batchfetch/batchfetch_git.py

@@ -463,22 +463,22 @@ class BatchFetchGit(TaskBatchFetch):
             self._run(cmd, cwd=str(self.git_local_dir), env=self.env)
             self._git_fetch_origin_done = True
 
-    def _repo_update_submodules(self):
-        # This parameter instructs Git to initiate the update
-        # process for submodules:
-        # 1. Git fetches the commits specified in the parent
-        # repository's configuration for each submodule.
-        # 2. Updates are based solely on the commit pointers stored
-        # within the parent repository's submodule configuration.
-        # 3. It does not directly consult the upstream repositories
-        # of the submodules.
-        # 4. Submodules are updated to reflect the exact commits
-        # revision in the parent repository's configuration,
-        # potentially lagging behind the latest changes made in the
-        # upstream repositories.
-        if self.git_local_dir.joinpath(".gitmodules").is_file():
-            cmd = ["git", "submodule", "update", "--recursive"]
-            self._run(cmd, cwd=str(self.git_local_dir), env=self.env)
+    # def _repo_update_submodules(self):
+    #     # This parameter instructs Git to initiate the update
+    #     # process for submodules:
+    #     # 1. Git fetches the commits specified in the parent
+    #     # repository's configuration for each submodule.
+    #     # 2. Updates are based solely on the commit pointers stored
+    #     # within the parent repository's submodule configuration.
+    #     # 3. It does not directly consult the upstream repositories
+    #     # of the submodules.
+    #     # 4. Submodules are updated to reflect the exact commits
+    #     # revision in the parent repository's configuration,
+    #     # potentially lagging behind the latest changes made in the
+    #     # upstream repositories.
+    #     if self.git_local_dir.joinpath(".gitmodules").is_file():
+    #         cmd = ["git", "submodule", "update", "--recursive"]
+    #         self._run(cmd, cwd=str(self.git_local_dir), env=self.env)
 
     def _repo_fix_remote_origin(self):
         correct_origin_url = self[self.main_key]

{batchfetch-1.2.5 → batchfetch-1.2.6}/batchfetch.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: batchfetch
-Version: 1.2.5
+Version: 1.2.6
 Summary: Efficiently clone and pull multiple Git repositories.
 Home-page: https://github.com/jamescherti/batchfetch
 Author: James Cherti
@@ -89,6 +89,31 @@ options:
   -v, --verbose         Enable verbose mode.
 ```
 
+## Frequently Asked Questions
+
+### What are untracked files?
+
+The parent directory of the "path:" value defines the managed directory, where the directory of each path is considered as the managed directory.
+
+For example, if the "path:" value is `file/my-project`, the managed directory will be `file/`. Any file within `file/` that is not managed by batchfetch will be considered an untracked file.
+
+When *batchfetch* encounters an untracked file, it displays an error message to inform users about paths that are not managed by the system. The message provides clear instructions on how to handle these paths by adding them to the `options.ignore_untracked_paths` list, enabling users to manage untracked files effectively.
+
+Here is an example of a *batchfetch.yaml* file that enables *batchfetch* to accept a list of untracked files:
+
+``` yaml
+options:
+  ignore_untracked_paths:
+    - ./test
+    - /absolute/path
+    - ../relative/path
+
+tasks:
+  - git: https://github.com/user/project
+```
+
+By default, *batchfetch.yaml* is the only untracked file that is ignored. The user does not need to add it to the *ignore_untracked_paths* option.
+
 ## License
 
 Copyright (C) 2024 [James Cherti](https://www.jamescherti.com)

{batchfetch-1.2.5 → batchfetch-1.2.6}/setup.py

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