Add warning about uncomitted changes, run uv lock

Author: robbievanleeuwen

README.md

@@ -1,6 +1,7 @@
 # upgrade-dependencies
 
-Creates PRs for dependency updates in python projects.
+CLI tool to check for dependency updates in your python project. Automatically creates
+GitHub pull requests for dependencies you wish to update!
 
 ## Limitations
 
@@ -22,5 +23,5 @@ Creates PRs for dependency updates in python projects.
 - [x] Create changes to files
 - [ ] Handle uv better (not group)
 - [x] Create pull request
-- [ ] Add tests
 - [ ] Documentation
+- [ ] Add tests

src/upgrade_dependencies/main.py

@@ -372,15 +372,26 @@ def update(
         progress.update(task, description="Updating dependency...")
         files_before = get_git_status()
 
+        # warning if there are changed files
+        if len(files_before) > 0:
+            msg = ":warning-emoji: [italic]There are uncomitted changes in your current"
+            msg += " branch. upgrade-dependencies will only commit files that were"
+            msg += " unmodified prior to running [bold]update[/bold][/italic]."
+            rprint(msg)
+
         # update dependency
         project.update_dependency(dependency=dep, version=version)
 
+        # run uv.lock, don't worry if it doesn't work (i.e. uv not installed)
+        run_shell_command(["uv", "lock"], suppress_errors=True)
+
         # get status of files after changes
         files_after = get_git_status()
 
         # get only the files that were changed
         changed_files = [f for f in files_after if f not in files_before]
 
+        # git add the changed files
         run_shell_command(["git", "add", *changed_files])
 
         # commit the changes
@@ -396,7 +407,7 @@ def update(
 
         run_shell_command(["git", "commit", "-m", commit_message])
 
-        # push the branch
+        # push the branch to GitHub
         progress.update(task, description="Pushing changes to GitHub...")
         run_shell_command(["git", "push", "origin", branch_name])
 
@@ -437,7 +448,7 @@ def update(
         # re-checkout master
         run_shell_command(["git", "checkout", "master"])
 
-    rprint(f"✅Dependency updated! View the pull request at {pr.stdout}")
+    rprint(f"✅ {dep.package_name} updated! View the pull request at {pr.stdout}")
 
 
 def main():

src/upgrade_dependencies/utils.py

@@ -250,21 +250,32 @@ def update_pre_commit(
         yaml.dump(data, temp_f)  # pyright: ignore
 
 
-def run_shell_command(shell_args: list[str]) -> Any:
+def run_shell_command(
+    shell_args: list[str],
+    suppress_errors: bool = False,
+) -> Any:
     """_summary_.
 
     Args:
         shell_args: _description_
+        suppress_errors: _description_
 
     Returns:
         _description_
     """
-    try:
-        res = subprocess.run(shell_args, check=True, capture_output=True, text=True)  # noqa: S603
-    except subprocess.CalledProcessError as e:
-        msg = f"Command failed with return code {e.returncode}.\n"
-        msg += f"Error output: {e.stderr}"
-        raise RuntimeError(msg) from e
+    if suppress_errors:
+        res = subprocess.run(  # noqa: S603
+            shell_args,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+    else:
+        try:
+            res = subprocess.run(shell_args, check=True, capture_output=True, text=True)  # noqa: S603
+        except subprocess.CalledProcessError as e:
+            msg = f"Command failed with return code {e.returncode}.\n"
+            msg += f"Error output: {e.stderr}"
+            raise RuntimeError(msg) from e
 
     return res
 
@@ -283,7 +294,7 @@ def get_git_status() -> list[str]:
     for line in result.stdout.strip().split("\n"):
         status, file_path = line.split(maxsplit=1)  # status and file name
 
-        if status in ["M", "A", "D"]:  # Modified, Added, or Deleted
+        if status in ["M", "A", "D"]:  # modified, added, or deleted
             changed_files.append(file_path)
 
     return changed_files