Skip to content

Commit faf6ba4

Browse files
committed
refactor!: rename base_rev -> base in vcs.get_changed_files()
This function works with anything committish, update the argument name to reflect that (while we're breaking backwards compat anyway).
1 parent 9e03b87 commit faf6ba4

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

src/taskgraph/util/vcs.py

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -140,12 +140,12 @@ def get_changed_files(
140140
diff_filter: Optional[str],
141141
mode: Optional[str],
142142
rev: Optional[str],
143-
base_rev: Optional[str],
143+
base: Optional[str],
144144
) -> List[str]:
145145
"""Return a list of files that are changed in:
146146
* either this repository's working copy,
147147
* or at a given revision (``rev``)
148-
* or between 2 revisions (``base_rev`` and ``rev``)
148+
* or between 2 revisions (``base`` and ``rev``)
149149
150150
``diff_filter`` controls which kinds of modifications are returned.
151151
It is a string which may only contain the following characters:
@@ -162,9 +162,9 @@ def get_changed_files(
162162
``rev`` is a specifier for which changesets to consider for
163163
changes. The exact meaning depends on the vcs system being used.
164164
165-
``base_rev`` specifies the range of changesets. This parameter cannot
165+
``base`` specifies the range of changesets. This parameter cannot
166166
be used without ``rev``. The range includes ``rev`` but excludes
167-
``base_rev``.
167+
``base``.
168168
"""
169169

170170
@abstractmethod
@@ -293,17 +293,17 @@ def get_tracked_files(self, *paths, rev=None):
293293
rev = rev or "."
294294
return self.run("files", "-r", rev, *paths).splitlines()
295295

296-
def get_changed_files(self, diff_filter=None, mode=None, rev=None, base_rev=None):
296+
def get_changed_files(self, diff_filter=None, mode=None, rev=None, base=None):
297297
diff_filter = diff_filter or "ADM"
298298
if rev is None:
299-
if base_rev is not None:
300-
raise ValueError("Cannot specify `base_rev` without `rev`")
299+
if base is not None:
300+
raise ValueError("Cannot specify `base` without `rev`")
301301
# Use --no-status to print just the filename.
302302
df = self._format_diff_filter(diff_filter, for_status=True)
303303
return self.run("status", "--no-status", f"-{df}").splitlines()
304304
else:
305305
template = self._files_template(diff_filter)
306-
revision_argument = rev if base_rev is None else f"{rev} % {base_rev}"
306+
revision_argument = rev if base is None else f"{rev} % {base}"
307307
return self.run("log", "-r", revision_argument, "-T", template).splitlines()
308308

309309
def get_outgoing_files(self, diff_filter="ADM", upstream=None):
@@ -479,23 +479,21 @@ def get_tracked_files(self, *paths, rev=None):
479479
rev = rev or "HEAD"
480480
return self.run("ls-tree", "-r", "--name-only", rev, *paths).splitlines()
481481

482-
def get_changed_files(self, diff_filter=None, mode=None, rev=None, base_rev=None):
482+
def get_changed_files(self, diff_filter=None, mode=None, rev=None, base=None):
483483
diff_filter = diff_filter or "ADM"
484484
mode = mode or "unstaged"
485485
assert all(f.lower() in self._valid_diff_filter for f in diff_filter)
486486

487487
if rev is None:
488-
if base_rev is not None:
489-
raise ValueError("Cannot specify `base_rev` without `rev`")
488+
if base is not None:
489+
raise ValueError("Cannot specify `base` without `rev`")
490490
cmd = ["diff"]
491491
if mode == "staged":
492492
cmd.append("--cached")
493493
elif mode == "all":
494494
cmd.append("HEAD")
495495
else:
496-
revision_argument = (
497-
f"{rev}~1..{rev}" if base_rev is None else f"{base_rev}..{rev}"
498-
)
496+
revision_argument = f"{rev}~1..{rev}" if base is None else f"{base}..{rev}"
499497
cmd = ["log", "--format=format:", revision_argument]
500498

501499
cmd.append("--name-only")

0 commit comments

Comments
 (0)