feature: add support for non-tqdm arbitrary progress bars for HTTPDownloader

[neutrinoceros]

Hi ! here's a patch with minimal changes required to make the downloaders accept an arbitrary "progress bar" object from outside of pooch, making tqdm not the only way to display progress. In particular, this allows users to create custom progress bars with rich. The reason I'm doing this is that there are a lot of places in the project I maintain use progress bars (and the pooch downloader is one of them), and I want them to have a visual consistency.

I'm opening as a draft for now because I need to work a little more to figure out a proper way to expose the total computation, since it would be useful to properly define a progress from outside pooch.
I may need help to write tests (or update the existing ones) for this, but I tested it for HTTPDownloader on the project I'm maintaining (https://github.com/yt-project/yt).

Here's a screenshot of it in action

I'll try to come up with a simple example of arbitrary progress bar class to contribute to docs later.

Reminders:

• Run make format and make check to make sure the code follows the style guide.
• Add tests for new features or tests that would have caught the bug that you're fixing.
• (NA) Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
• Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
• If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
• Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

[welcome]

💖 Thanks for opening your first pull request! 💖

Please make sure you read the following:

• Authorship Guidelines: Our rules for giving you credit for your contributions, including authorship on publications and Zenodo archives.
• Contributing Guide: What the review process is like and our infrastructure for testing and documentation.
• Code of Conduct: How we expect people to interact in our projects.

A few things to keep in mind:

• Remember to run make format to make sure your code follows our style guide.
• If you need help writing tests, take a look at the existing ones for inspiration. If you don't know where to start, let us know and we'll walk you through it.
• All new features should be documented. It helps to write the docstrings for your functions/classes before writing the code. This will help you think about your code design and results in better code.
• No matter what, we are really grateful that you put in the effort to do this! ⭐

[neutrinoceros]

Apparently there's exactly one line I'm not hitting but I can't figure out which one and I can't access the codecov report for some reason.
edit: got it !
I'm now restricting the change for the HTTPDownloader class because things get more complicated with SFTPDownloader

[leouieda]

👋🏽 Hi @neutrinoceros thanks for the PR! This looks nice a great addition. I'm a bit strapped for time at the moment so this may take a little while to be merged. I hope that's OK.

A few quick questions:

1. Did you make up the spec for the progress bar class or is that what is used by other libraries? It would be nice if we didn't create our own spec for this to help with interoperability.
2. Would this work if we pass in a tqdm instance? If so, then it would be nice to have a test for that.

[neutrinoceros]

Thanks for getting back to me !
There's no rush on my side, take your time.

The specs are designed around tqdm's api to allow more flexibility in pooch with minimal change. Basically I'm going with a duck typing approach : if it looks, feels and tastes like a tqdm pbar, we can treat it as if it was, transparently and without creating much technical debt on your side.

Other libraries use slightly different method names as far as I can tell (The ones I have personally studied are tqdm and rich.progress), but it's only a matter of wrapping them with a little syntactic sugar to make them compatible.
In my own application for this, I wrapped a rich progress bar in a small custom class to make it look like tqdm and it worked :)

[leouieda]

Great stuff @neutrinoceros (and awesome handle)! Left a few suggestions, mostly for the docs. Otherwise, this seems to work like a charm 👍🏽

[leouieda]

Could you add an example using this class with HTTPDownloader?

[leouieda]

Might also be good to add a .. note: here saying that this only available for HTTPDownloader for now.

[neutrinoceros]

done !

[neutrinoceros]

Thanks for your careful review ! I'll go back to this in a few days.

[welcome]

🎉🎉🎉 Congrats on merging your first pull request and welcome to the team! 🎉🎉🎉

If you would like to be added as a author on the Zenodo archive of the next release, make sure that you have added your full name, affiliation, and ORCID (optional) to the AUTHORS.md file of this repository.

We hope that this was a good experience for you. Let us know if there is any way that the contributing process could be improved.

[leouieda]

@neutrinoceros thank you for the contribution! I made a few minor edits to the docs but this is looking really good.

[neutrinoceros]

Glad you like it ! Thank you for your support in getting this to the finish line. Do you intend to release it in the same go or should I except a delay ? I'm good with either way :)

[leouieda]

I'm just going to push some updates to the docs and then make a release. It should be out within the next few weeks.