Fix: Add display() call to close() in rich module

[glensc]

See how I've come to this conclusion. This note and notes before it:

• [tqdm.rich] latest rich breaks the example #1306 (comment)

Testcase:

from tqdm.rich import trange, tqdm
for i in trange(10):
    print(f"i={i}")
print("finished")

This snippet, when run, must reach 100%. without the patch it doesn't even get past 0.

The display() calls in std.close are never reached because the "gui mode check" exits the function:

• tqdm/tqdm/std.py

  Lines 1295 to 1297 in 6791e8c

  	# GUI mode
  	if getattr(self, 'sp', None) is None:
  	return

Fixes:

• [tqdm.rich] latest rich breaks the example #1306
• rich based progress part doesn't 'complete' cleanly #1266

[glensc]

Suggested change

	self.display()
	if self.leave:
	self.display()

should it be with self.leave check like gui.py?

• tqdm/tqdm/gui.py

  Lines 104 to 105 in 6791e8c

  	if self.leave:
  	self.display()

[glensc]

@casperdcl do you need some help maintaining this project?

[codecov]

Codecov Report

Merging #1395 (6791e8c) into master (6791e8c) will not change coverage.
The diff coverage is n/a.

❗ Current head 6791e8c differs from pull request most recent head 4d75eb0. Consider uploading reports for the commit 4d75eb0 to get more accurate results

@@           Coverage Diff           @@
##           master    #1395   +/-   ##
=======================================
  Coverage   88.94%   88.94%           
=======================================
  Files          26       26           
  Lines        1764     1764           
  Branches      344      344           
=======================================
  Hits         1569     1569           
  Misses        145      145           
  Partials       50       50           

[glensc]

Monkey patching in my project:

• Monkey patch tqdm to fix closing progressbar Taxel/PlexTraktSync#1275

[glensc]

@casperdcl my monkey patching no issues so far:

• Fix: Add display() call to close() in rich module #1395 (comment)

[sybrenjansen]

I know this PR is a bit old, but I was having the issue as well and decided to check if there was any fix. This PR actually didn't fix it for me, at least not completely.

The display call is needed, but the display implementation also needs to be updated to:

    def display(self, *_, **__):
        if not hasattr(self, '_prog'):
            return
        self._prog.update(self._task_id, completed=self.n, description=self.desc, refresh=True)

Mind the refresh=True at the end.

The default (https://github.com/Textualize/rich/blob/master/rich/progress.py#L1421) is set to False, but this will actually force a refresh and made my issues go away.

[glensc]

it has been rebased to the last release: v4.66.1, so not old.

[glensc]

@sybrenjansen

🚧 Never link to branches, share a permalink 🚧

• see https://news.ycombinator.com/item?id=8046710
  and https://help.github.com/articles/getting-permanent-links-to-files/
  and https://docs.gitlab.com/ee/user/shortcuts.html#project-files
• hit y
• and perhaps for https://github.com/josephfrazier/octopermalinker (GitHub)

NOTE: edit your post and fix it with a permalink!

[glensc]

@sybrenjansen what's your reproducer? perhaps it's something else (create new issue with it?), as this fixes for me and other users in #1306

[casperdcl]

argh sorry for the epic delay... will release in tqdm>=4.66.4 shortly