Add disable progress bar feature, edit docstrings

[Cubostar]

Description

Adds feature explained in #3259. Also edited the docstrings to mention the new progress bool.

[ghost]

Thanks for the pull request @Cubostar! Everything looks great!

[pep8speaks]

Hello @Cubostar! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2019-08-22 14:59:18 UTC

[Cubostar]

Should tests be edited to check if this feature works?

[nabobalis]

I'm not sure I know how you would test it. @Cadair do you know a way?

[Cadair]

Easiest way would be to run a download and use pytest to capture the stdout and see if there is a progress bar or not.

(I am like 90% sure you can do that with pytest somehow.)

[Cubostar]

I'll do that in ~sunpy.net.tests.test_helioviewer.py then

[Cubostar]

I haven't been able to test if these new tests I wrote work. Right now I'm assuming that capsys is a fixture (?) from pytest and is not a parameter, but I'm not quite sure how pytest works to run these.

[Cubostar]

Interestingly, there wasn't an AssertError even though test_progress_png didn't set progress=False.

[Cubostar]

Don't worry, just a rebase. The duplicate commits are because I reset my developer environment after making this pull request, so the branch progressbar-feat was only tracking the remote branch progressbar-feat on GitHub. The rebase basically made my local branch the official progressbar-feat, hence the extra commits (I think).

[Cubostar]

Tests now work! 😄

[ayshih]

I haven't evaluated the changes at all, but I consider this PR to be non-merge-able until it is properly rebased because the commit history is a mess.

@Cubostar You can ask for help if you don't know to do the rebase

[ayshih]

@Cubostar While the general approach to clean up a commit history is through rebasing, you can instead limit yourself to just cherry-picking, which is easier to walk you through. You'd create a fresh branch (here, progressbar-feat-new) and then cherry-pick the commits that you want to keep:

git fetch upstream
git checkout --no-track -b progressbar-feat-new upstream/master
git cherry-pick c007692^..2659b50
git cherry-pick 8ac93ea

After you confirm that the new branch does in fact contain all of your intended changes, you can rename the branch locally – overwriting the old branch – and then force push the branch to your remote:

git branch -M progressbar-feat-new progressbar-feat
git push -f origin progressbar-feat

[Cubostar]

WOW everything is so clean! Tysm @ayshih this is amazing

[Cadair]

Looks good to me barring the removal of the (object) in the class definition.

[Cubostar]

It seems that the CircleCI tests fail if HelioviewerClient doesn't have parentheses. Is this okay with you guys?

[ayshih]

The CircleCI builds are currently failing for reasons that are totally unrelated to this PR, not because of the recent change that you made. You don't need to worry about it.

[Cadair]

Thanks @Cubostar :)