From 90cb341e8eba094042237e6c65a8754066c174ce Mon Sep 17 00:00:00 2001 From: Casper da Costa-Luis Date: Thu, 25 Feb 2021 16:08:12 +0000 Subject: [PATCH] rename `waituntil` => `delay` --- tests/tests_tqdm.py | 6 +++--- tqdm/std.py | 14 +++++++------- 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/tests/tests_tqdm.py b/tests/tests_tqdm.py index 5a744dd1..8cf00653 100644 --- a/tests/tests_tqdm.py +++ b/tests/tests_tqdm.py @@ -622,11 +622,11 @@ def test_max_interval(): t2.close() -def test_waituntil(): - """Test waituntil""" +def test_delay(): + """Test delay""" timer = DiscreteTimer() with closing(StringIO()) as our_file: - t = tqdm(total=2, file=our_file, leave=True, waituntil=3) + t = tqdm(total=2, file=our_file, leave=True, delay=3) cpu_timify(t, timer) timer.sleep(2) t.update(1) diff --git a/tqdm/std.py b/tqdm/std.py index 4730c915..bc5e71ec 100644 --- a/tqdm/std.py +++ b/tqdm/std.py @@ -844,7 +844,7 @@ class tqdm(Comparable): ascii=None, disable=False, unit='it', unit_scale=False, dynamic_ncols=False, smoothing=0.3, bar_format=None, initial=0, position=None, postfix=None, unit_divisor=1000, write_bytes=None, - lock_args=None, nrows=None, colour=None, waituntil=0, gui=False, + lock_args=None, nrows=None, colour=None, delay=0, gui=False, **kwargs): """ Parameters @@ -952,7 +952,7 @@ class tqdm(Comparable): The fallback is 20. colour : str, optional Bar colour (e.g. 'green', '#00ff00'). - waituntil : float, optional + delay : float, optional Don't display until [default: 0] seconds have elapsed. gui : bool, optional WARNING: internal parameter - do not use. @@ -1071,7 +1071,7 @@ class tqdm(Comparable): self.unit_divisor = unit_divisor self.initial = initial self.lock_args = lock_args - self.waituntil = waituntil + self.delay = delay self.gui = gui self.dynamic_ncols = dynamic_ncols self.smoothing = smoothing @@ -1103,7 +1103,7 @@ class tqdm(Comparable): if not gui: # Initialize the screen printer self.sp = self.status_printer(self.fp) - if waituntil <= 0: + if delay <= 0: self.refresh(lock_args=self.lock_args) # Init the time counter @@ -1168,7 +1168,7 @@ class tqdm(Comparable): mininterval = self.mininterval last_print_t = self.last_print_t last_print_n = self.last_print_n - min_start_t = self.start_t + self.waituntil + min_start_t = self.start_t + self.delay n = self.n time = self._time @@ -1227,7 +1227,7 @@ class tqdm(Comparable): if self.n - self.last_print_n >= self.miniters: cur_t = self._time() dt = cur_t - self.last_print_t - if dt >= self.mininterval and cur_t >= self.start_t + self.waituntil: + if dt >= self.mininterval and cur_t >= self.start_t + self.delay: cur_t = self._time() dn = self.n - self.last_print_n # >= n if self.smoothing and dt and dn: @@ -1287,7 +1287,7 @@ class tqdm(Comparable): leave = pos == 0 if self.leave is None else self.leave with self._lock: - if self.last_print_t < self.start_t + self.waituntil: + if self.last_print_t < self.start_t + self.delay: # haven't ever displayed; nothing to clear return if leave: