Migrate to use custom rmtree

Author: woojiahao

app/commands/download.py

@@ -1,5 +1,4 @@
 import os
-import shutil
 from datetime import datetime
 from pathlib import Path
 from typing import Dict, Optional
@@ -9,6 +8,7 @@
 
 from app.commands.check.git import git
 from app.exercise_config import ExerciseConfig
+from app.utils.cli import rmtree
 from app.utils.click import error, info, success, warn
 from app.utils.gh_cli import (
     clone_with_custom_name,
@@ -21,7 +21,6 @@
     download_file,
     execute_py_file_function_from_url,
     exercise_exists,
-    generate_cds_string,
     get_gitmastery_file_path,
     get_variable_from_url,
     read_gitmastery_exercise_config,
@@ -127,7 +126,7 @@ def download(ctx: click.Context, exercise: str) -> None:
 
     if os.path.isdir(exercise):
         warn(f"You already have {exercise}, removing it to download again")
-        shutil.rmtree(exercise)
+        rmtree(exercise)
 
     os.makedirs(exercise)
     os.chdir(exercise)
@@ -151,7 +150,7 @@ def download(ctx: click.Context, exercise: str) -> None:
                 # Rollback the download and remove the folder
                 warn("Git is not setup. Rolling back the download")
                 os.chdir("..")
-                shutil.rmtree(formatted_exercise)
+                rmtree(formatted_exercise)
                 warn("Setup Git before downloading this exercise")
                 exit(1)
 
@@ -166,7 +165,7 @@ def download(ctx: click.Context, exercise: str) -> None:
                 # Rollback the download and remove the folder
                 warn("Github is not setup. Rolling back the download")
                 os.chdir("..")
-                shutil.rmtree(formatted_exercise)
+                rmtree(formatted_exercise)
                 warn("Setup Github and Github CLI before downloading this exercise")
                 exit(1)
 

app/commands/progress/reset.py

@@ -1,6 +1,5 @@
 import json
 import os
-import shutil
 import sys
 from datetime import datetime
 
@@ -14,7 +13,8 @@
     LOCAL_FOLDER_NAME,
     PROGRESS_REPOSITORY_NAME,
 )
-from app.utils.click import error, info, success, warn
+from app.utils.cli import rmtree
+from app.utils.click import info, success, warn
 from app.utils.gh_cli import delete_repo, get_prs, get_username, pull_request
 from app.utils.git_cli import add_all, commit, push
 from app.utils.gitmastery import (
@@ -52,7 +52,7 @@ def reset(ctx: click.Context) -> None:
         username = get_username(verbose)
         exercise_fork_name = f"{username}-gitmastery-{gitmastery_exercise_config.exercise_repo.repo_title}"
         delete_repo(exercise_fork_name, verbose)
-    shutil.rmtree(
+    rmtree(
         gitmastery_exercise_path / gitmastery_exercise_config.exercise_repo.repo_name
     )
     setup_exercise_folder(download_time, gitmastery_exercise_config, verbose)

app/commands/progress/sync/off.py

@@ -1,6 +1,5 @@
 import json
 import os
-import shutil
 import sys
 
 import click
@@ -11,6 +10,7 @@
     LOCAL_FOLDER_NAME,
     STUDENT_PROGRESS_FORK_NAME,
 )
+from app.utils.cli import rmtree
 from app.utils.click import confirm, error, info
 from app.utils.gh_cli import delete_repo, get_username
 from app.utils.gitmastery import require_gitmastery_root
@@ -53,7 +53,7 @@ def off(ctx: click.Context) -> None:
     with open(local_progress_filepath, "r") as file:
         local_progress = json.load(file)
 
-    shutil.rmtree(LOCAL_FOLDER_NAME)
+    rmtree(LOCAL_FOLDER_NAME)
 
     # Re-create just the progress folder
     with open(local_progress_filepath, "a") as progress_file:

app/commands/progress/sync/on.py

@@ -1,6 +1,5 @@
 import json
 import os
-import shutil
 
 import click
 
@@ -11,7 +10,8 @@
     PROGRESS_REPOSITORY_NAME,
     STUDENT_PROGRESS_FORK_NAME,
 )
-from app.utils.click import error, info, success, warn
+from app.utils.cli import rmtree
+from app.utils.click import info, success, warn
 from app.utils.gh_cli import (
     clone_with_custom_name,
     fork,
@@ -20,10 +20,9 @@
     has_fork,
     pull_request,
 )
-from app.utils.git_cli import add_all, add_remote, commit, push
+from app.utils.git_cli import add_all, commit, push
 from app.utils.gitmastery import (
     GITMASTERY_CONFIG_NAME,
-    generate_cds_string,
     require_gitmastery_root,
 )
 
@@ -67,7 +66,7 @@ def on(ctx: click.Context) -> None:
     if os.path.isfile(local_progress_filepath):
         with open(local_progress_filepath, "r") as file:
             local_progress = json.load(file)
-    shutil.rmtree(LOCAL_FOLDER_NAME)
+    rmtree(LOCAL_FOLDER_NAME)
 
     clone_with_custom_name(f"{username}/{fork_name}", LOCAL_FOLDER_NAME, verbose)
 

app/utils/cli.py

@@ -2,7 +2,8 @@
 import shutil
 import stat
 import subprocess
-from typing import Optional, Tuple
+from pathlib import Path
+from typing import Optional, Tuple, Union
 
 
 def get_stdout_stderr(verbose: bool) -> Tuple[Optional[int], Optional[int]]:
@@ -11,7 +12,7 @@ def get_stdout_stderr(verbose: bool) -> Tuple[Optional[int], Optional[int]]:
     return stdout, stderr
 
 
-def rmtree(folder_name: str) -> None:
+def rmtree(folder_name: Union[str, Path]) -> None:
     def force_remove_readonly(func, path, _):
         os.chmod(path, stat.S_IWRITE)
         func(path)