Fix: tqdm.auto requires ipywidgets for notebook support.

[bdice]

Description

This is a workaround for half of the issue reported in #602:

The notebook issue is partially caused by #371. tqdm has an automatic mode that detects if it is in a notebook, and shows an HTML progress bar instead of a console one (the console format doesn't render very well in the notebook, I have sometimes seen the \r fail to clear the current line and instead output lots of lines with progress bars). This issue has been reported to tqdm as tqdm/tqdm#1082 and there is a PR tqdm/tqdm#1218 to fix it by falling back to the console progress bar.

This PR does not change the default behavior of showing/not showing progress bars. See #602 for more details on that issue.

This workaround requires tqdm/tqdm#1148, so the minimum tqdm version has been bumped to 4.60.0.

Motivation and Context

Workaround for tqdm/tqdm#1218

Types of Changes

• Documentation update
• Bug fix
• New feature
• Breaking change¹

Checklist:

• I am familiar with the Contributing Guidelines.
• I agree with the terms of the Contributor Agreement.
• My name is on the list of contributors.
• My code follows the code style guideline of this project.
• The changes introduced by this pull request are covered by existing or newly introduced tests.

If necessary:

• I have updated the API documentation as part of the package doc-strings.
• I have created a separate pull request to update the framework documentation on signac-docs and linked it here.
• I have updated the changelog.

[codecov]

Codecov Report

Merging #614 (1de0014) into master (ff7f972) will increase coverage by 0.00%.
The diff coverage is 88.88%.

❗ Current head 1de0014 differs from pull request most recent head 0330bf4. Consider uploading reports for the commit 0330bf4 to get more accurate results

@@           Coverage Diff           @@
##           master     #614   +/-   ##
=======================================
  Coverage   79.00%   79.00%           
=======================================
  Files          33       33           
  Lines        3225     3230    +5     
  Branches      688      688           
=======================================
+ Hits         2548     2552    +4     
- Misses        534      535    +1     
  Partials      143      143           

Impacted Files	Coverage Δ
flow/project.py	81.04% <ø> (-0.02%)	⬇️
flow/util/misc.py	74.48% <87.50%> (+0.38%)	⬆️
flow/render_status.py	55.31% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ff7f972...0330bf4. Read the comment docs.

[tommy-waltmann]

Since tqdm/tqdm#1218 and tqdm/tqdm#1148 are merged, shouldn't this PR just be a tqdm version bump? Or have they not made a release since fixing those bugs?

[bdice]

@tommy-waltmann That fix was made to tqdm after I created this PR. It doesn't look like tqdm 4.63.0 is out yet, which would include the fix. However, I'm also not sure if the "fix" acts like we want it to. I would like to fall back silently to text-based progress bars if ipywidgets is not available. It seems like the changes made in tqdm will throw a warning that ipywidgets is not available. For now, I know this PR acts like I want (no warnings, just silent fallback from HTML to text progress bars).

[tommy-waltmann]

Fair enough, if you want different behavior than the tqdm default then you are going to have to wrap it somehow.

[cbkerr]

Thanks! The code makes sense and I checked with the tqdm docs.
I didn't test it locally.