make progrgress_bar param accept a dict

[wsuzume]

Fixes #777 (Oh, I unintendedly hit the jackpot🎰)

What does this PR do?

This pull request is an extension that allows passing arguments to tqdm by enabling the progress_bar parameter of execute_notebook to accept a dict.

This pull request maintains compatibility with the current implementation, though it might make the conditional branching a bit messy...

I believe there could be discussions on how to actually enable such specification, as follows.

            # Ensure at least unit and desc.
            # Conversely, it becomes impossible to remove unit and desc.
            elif isinstance(progress_bar, dict):
                _progress_bar = { "unit": "cell", "desc": "Executing" }
                _progress_bar.update(progress_bar)
                self.pbar = tqdm(total=len(self.nb.cells), **_progress_bar)

            # Simple and accepts any dictionary.
            # However, it's not intuitive as an empty dictionary is precluded by `if progress_bar:`.
            elif isinstance(progress_bar, dict):
                self.pbar = tqdm(total=len(self.nb.cells), **progress_bar)

        # It becomes possible to accept an empty dictionary,
        # but the implementation becomes slightly complicated.
        if isinstance(progress_bar, bool):
            if progress_bar:
                # lazy import due to implicit slow ipython import
                from tqdm.auto import tqdm
                ...
        elif isinstance(progress_bar, dict):
            # lazy import due to implicit slow ipython import
            from tqdm.auto import tqdm
            ...

[codecov]

Codecov Report

Merging #778 (385be4e) into main (cb2eb37) will decrease coverage by 0.28%.
Report is 3 commits behind head on main.
The diff coverage is 28.57%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #778      +/-   ##
==========================================
- Coverage   91.54%   91.27%   -0.28%     
==========================================
  Files          17       17              
  Lines        1621     1627       +6     
==========================================
+ Hits         1484     1485       +1     
- Misses        137      142       +5     

[MSeal]

This seems like a great improvement for the control plane of progress bars. Thanks for exploring and adding it!