pr fix

Author: filipchristiansen

src/gitingest/clone.py

@@ -26,7 +26,7 @@ async def clone_repo(config: CloneConfig, *, token: str | None = None) -> None:
     """Clone a repository to a local path based on the provided configuration.
 
     This function handles the process of cloning a Git repository to the local file system.
-    It can clone a specific branch or commit if provided, and it raises exceptions if
+    It can clone a specific branch, tag, or commit if provided, and it raises exceptions if
     any errors occur during the cloning process.
 
     Parameters

src/gitingest/query_parser.py

@@ -188,17 +188,17 @@ async def _parse_remote_repo(source: str, token: str | None = None) -> Ingestion
         # Try to resolve a tag
         parsed.tag = await _configure_branch_or_tag(
             remaining_parts,
-            url,
-            configure="tags",
+            url=url,
+            ref_type="tags",
             token=token,
         )
 
         # If no tag found, try to resolve a branch
         if not parsed.tag:
             parsed.branch = await _configure_branch_or_tag(
                 remaining_parts,
-                url,
-                configure="branches",
+                url=url,
+                ref_type="branches",
                 token=token,
             )
 
@@ -211,8 +211,9 @@ async def _parse_remote_repo(source: str, token: str | None = None) -> Ingestion
 
 async def _configure_branch_or_tag(
     remaining_parts: list[str],
+    *,
     url: str,
-    configure: str,
+    ref_type: str,
     token: str | None = None,
 ) -> str | None:
     """Configure the branch or tag based on the remaining parts of the URL.
@@ -223,8 +224,8 @@ async def _configure_branch_or_tag(
         The remaining parts of the URL path.
     url : str
         The URL of the repository.
-    configure : str
-        The type of object to configure. Can be "branches" or "tags".
+    ref_type : str
+        The type of reference to configure. Can be "branches" or "tags".
     token : str | None
         GitHub personal access token (PAT) for accessing private repositories.
 
@@ -236,21 +237,21 @@ async def _configure_branch_or_tag(
     Raises
     ------
     ValueError
-        If the ``configure`` parameter is not "branches" or "tags".
+        If the ``ref_type`` parameter is not "branches" or "tags".
 
     """
-    if configure not in ("branches", "tags"):
-        msg = f"Invalid configure type: {configure}"
+    if ref_type not in ("branches", "tags"):
+        msg = f"Invalid reference type: {ref_type}"
         raise ValueError(msg)
 
-    to_fetch = "tags" if configure == "tags" else "branches"
+    _ref_type = "tags" if ref_type == "tags" else "branches"
 
     try:
         # Fetch the list of branches or tags from the remote repository
-        branches_or_tags: list[str] = await fetch_remote_branches_or_tags(url, fetch=to_fetch, token=token)
+        branches_or_tags: list[str] = await fetch_remote_branches_or_tags(url, ref_type=_ref_type, token=token)
     except RuntimeError as exc:
         # If remote discovery fails, we optimistically treat the first path segment as the branch/tag.
-        msg = f"Warning: Failed to fetch {to_fetch}: {exc}"
+        msg = f"Warning: Failed to fetch {_ref_type}: {exc}"
         warnings.warn(msg, RuntimeWarning, stacklevel=2)
         return remaining_parts.pop(0) if remaining_parts else None
 

src/gitingest/utils/git_utils.py

@@ -196,15 +196,15 @@ def _parse_github_url(url: str) -> tuple[str, str, str]:
     return parsed.hostname, owner, repo
 
 
-async def fetch_remote_branches_or_tags(url: str, *, fetch: str, token: str | None = None) -> list[str]:
+async def fetch_remote_branches_or_tags(url: str, *, ref_type: str, token: str | None = None) -> list[str]:
     """Fetch the list of branches or tags from a remote Git repository.
 
     Parameters
     ----------
     url : str
         The URL of the Git repository to fetch branches or tags from.
-    fetch: str
-        The type of object to fetch. Can be "branches" or "tags".
+    ref_type: str
+        The type of reference to fetch. Can be "branches" or "tags".
     token : str | None
         GitHub personal access token (PAT) for accessing private repositories.
 
@@ -216,11 +216,11 @@ async def fetch_remote_branches_or_tags(url: str, *, fetch: str, token: str | No
     Raises
     ------
     ValueError
-        If the ``fetch`` parameter is not "branches" or "tags".
+        If the ``ref_type`` parameter is not "branches" or "tags".
 
     """
-    if fetch not in ("branches", "tags"):
-        msg = f"Invalid fetch type: {fetch}"
+    if ref_type not in ("branches", "tags"):
+        msg = f"Invalid fetch type: {ref_type}"
         raise ValueError(msg)
 
     cmd = ["git"]
@@ -231,7 +231,7 @@ async def fetch_remote_branches_or_tags(url: str, *, fetch: str, token: str | No
 
     cmd += ["ls-remote"]
 
-    fetch_tags = fetch == "tags"
+    fetch_tags = ref_type == "tags"
     to_fetch = "tags" if fetch_tags else "heads"
 
     cmd += [f"--{to_fetch}"]