Progress bar functionality

[thebigmunch]

Any plans/thoughts on including progress bar functionality?

I know they're another big pill to swallow, but they certainly could fit the premise of rich. Integrating outside progress bar libraries isn't great as it is right now.

[willmcgugan]

Actually yes. I was thinking about progress bars. Something like https://github.com/tqdm/tqdm but "prettier".

[willmcgugan]

I was thinking of rendering them like this. Fairly minimal.

Screen Recording 2020-03-06 at 09.30.16.mov.zip

[thebigmunch]

Are you thinking about having a bar equivalent to box to style them?

Are you thinking about having optional progress text? Maybe just take a callable that accepts whatever progress object you're working with and returns a string. One of the problems I've run into with tqdm's progress text is that it's difficult to customize in many ways because it's too specific. So, I think this would be a better way to do it.

[willmcgugan]

Yeah, that seems like a good idea. In Rich terms it would be a 'renderable' so you could substitute it for anything that renders progress.

[thebigmunch]

Loving the progress (pun intended) on this so far. Looking like the kind of simple progress bar UX I've wanted.

[willmcgugan]

Thanks. API is coming together. Posted a example https://twitter.com/willmcgugan/status/1236715446197510144

[thebigmunch]

Thanks. API is coming together. Posted a example twitter.com/willmcgugan/status/1236715446197510144

I've been moving over torrent CLI utility thorod over to rich. Already been playing with rich.progress to replace the bar I display when hashing files on torrent creation. Previously used tqdm.

[willmcgugan]

Nice. Let me know how that goes. But bear in mind the interface in master may change before the next release.

[thebigmunch]

Nice. Let me know how that goes. But bear in mind the interface in master may change before the next release.

Yeah, I've already had to change it once. But, getting most the work done and just having to change it a bit at the end is nice when you have limited time.

[thebigmunch]

Here's a screen recording of a run of thorod with a progress bar to give you an idea of some of the things I might like to include in this particular bar: progress, rate, and elapsed time. I had to hack some things a bit to get there:

@dataclass
class HashingTask(Task):
	start: pendulum.datetime = pendulum.now()

	@property
	def elapsed(self):
		return humanize_duration((pendulum.now() - self.start).seconds)

	@property
	def progress(self):
		return f"{humanize_filesize(self.completed)}/{humanize_filesize(self.total)}"

	@property
	def rate(self):
		return f"{humanize_filesize(self.completed / (pendulum.now() - self.start).seconds)}/s"


class HashingProgress(Progress):
	def add_task(
		self,
		name,
		total: int = 100,
		completed: int = 0,
		visible: bool = True,
		**fields: str
	):
		with self._lock:
			task = HashingTask(name, total, completed, visible=visible, fields=fields)
			self._tasks[self._task_index] = task
			self.refresh()
			try:
				return self._task_index
			finally:
				self._task_index = TaskID(int(self._task_index) + 1)

[willmcgugan]

Nice. You may be able to do that without the customized Progress class. The Progress constructor takes a list of columns, which can be a format string or a callable. The callable should take a Task object and return something Rich can render. Have a look at bar_widget which works that way.

I'll probably implement widgets for ETA, file speed, etc. Similar to your properties.

BTW I think your start variable will set the default once at import time. You may need field(default_factory=pendulum.now)

[thebigmunch]

BTW I think your start variable will set the default once at import time. You may need field(default_factory=pendulum.now)

Yeah. It's a CLI app, so it's one use and wasn't so critical when I was just testing things.

One thing that did bug me is that the add_task method is a misnomer. I would expect it to add a Task instance. But, what it does is create a Task instance and then add it.

Nice. You may be able to do that without the customized Progress class. The Progress constructor takes a list of columns, which can be a format string or a callable. The callable should take a Task object and return something Rich can render. Have a look at bar_widget which works that way.

I had started playing around with using a customized bar like this. I found this to be a bit clunky, though. You can't just add an instance due to it being called in the code, hence the bar_widget function to return an instance.

I also don't see how adding a Task in the Progress instantiation would work. Maybe I'm missing something.

[thebigmunch]

Oh, I also noticed that Progress.update takes **fields, but then also doesn't do anything with them.