Show progress bar in interactive sessions (Jupyter, REPL) by default by betolink · Pull Request #1065 · earthaccess-dev/earthaccess

betolink · 2025-08-08T19:38:43Z

This is a minor patch to restore the progress bar when we open and download files, the default is to show it if we are in a notebook and there is a new parameter to mute it with hide_progress in both download() and open().

📚 Documentation preview 📚: https://earthaccess--1065.org.readthedocs.build/en/1065/

github-actions · 2025-08-08T19:38:55Z

👈 Launch a binder notebook on this branch for commit 9888fc1

betolink · 2025-08-08T19:48:43Z

We need to merge this before #1061 also the integration tests are failing due NSIDC ECS, they got hidden recently in favor of cloud copies but... that's coming in #1061 so I don't mind merging this with them failing.

mfisher87 · 2025-08-09T02:40:05Z

    provider: Optional[str] = None,
    threads: int = 8,
    *,
+    hide_progress: bool = False,


I don't feel we should add a new kwarg here. Currently pqdm_kwargs.disable allows the user to control this behavior, and perhaps this PR should just update the default value instead of introducing a new API element?

I.e.

pqdm_kwargs = { "n_jobs": threads, "disable": not _is_interactive(), **(pqdm_kwargs or {}), }

makes sense, I feel like pqdm is kind of "obscure" and hide_progress is very explicit.

That's definitely true. You've kinda convinced me :) this is end-user-facing and we want it to be user-friendly. Maybe it should be show_progress instead? hide_progress=False is a double-negative.

@mfisher87 it will be great if we can merge this to unblock #1061 and try to release v0.15.0 at the end of the week!

mfisher87

I may not be able to do another pass this week. I have events going on every day after today 😅

mfisher87 · 2025-08-12T16:14:01Z

+    except ImportError:
+        pass
+
+    import sys


Move import to the top of the module?

mfisher87 · 2025-08-12T16:16:33Z

-        **(pqdm_kwargs or {}),
-    }
-
    return pqdm(url_mapping.items(), multi_thread_open, **pqdm_kwargs)


pqdm_kwargs could be None at this point, so it's possible the user will be NoneType is not a mapping on this line.

I think that's why the or {} is there no?

@betolink, correct, that's what the or {} is for.

@betolink I show that line as deleted, so can't it still be None?

(paraphrasing an LLM) you're totally right! I think we should include the or {} in this line as well, technically this is not a public method and the methods that call it have the or {}, should we open an issue for it?

Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>

betolink · 2025-08-12T17:29:46Z

Hi @chuckwondo if you have time, it would be great to have your input on this one. Just a minor edit on how we expose the progress bar. I'm waiting on this to keep working on #1061

chuckwondo · 2025-08-13T14:37:35Z

Thanks @betolink! I'll take a look at this today.

chuckwondo

Looks good! Approving, with just a few minor suggestions.

chuckwondo · 2025-08-13T14:42:23Z

-        **(pqdm_kwargs or {}),
-    }
-
    return pqdm(url_mapping.items(), multi_thread_open, **pqdm_kwargs)


@betolink, correct, that's what the or {} is for.

chuckwondo · 2025-08-13T14:49:55Z

            of a UUID4 value.
        provider: if we download a list of URLs, we need to specify the provider.
        threads: parallel number of threads to use to download the files, adjust as necessary, default = 8
+        show_progress: whether to display a progress bar. Defaults to `True` for interactive sessions, otherwise `False`.


Suggested change

show_progress: whether to display a progress bar. Defaults to `True` for interactive sessions, otherwise `False`.

show_progress: whether or not to display a progress bar. If not specified, defaults to `True` for interactive sessions (i.e., in a notebook or a python REPL session), otherwise `False`.

Please also duplicate this description to the rest of the places where show_progress was added so that the description is consistent everywhere. (There's a fair bit of variation/inconsistency across the other spots.)

done! I'm taking a look at the pre-commit error.

chuckwondo · 2025-08-13T14:53:58Z

@betolink, be sure to merge main into your branch, and address the pre-commit error.

Co-authored-by: Chuck Daniels <cjdaniels4@gmail.com>

betolink · 2025-08-13T16:09:47Z

so weird, locally pre-commit passes

betolink · 2025-08-13T16:17:27Z

Ah my origin/main is not in sync with earthaccess/main, fixing that now!

chuckwondo

Thanks @betolink! Looks good to me!

betolink added 2 commits August 8, 2025 14:30

progress bar defaults to True for interactive sessions

4a5b12e

remove unused params

7c7963a

betolink and others added 2 commits August 8, 2025 14:43

update changelog

3c60fd4

Merge branch 'main' into progress-bar

89eeda6

betolink marked this pull request as ready for review August 8, 2025 19:48

betolink mentioned this pull request Aug 8, 2025

fsspec fetching improvements #1061

Merged

9 tasks

betolink requested review from Sherwin-14 and mfisher87 August 8, 2025 19:49

mfisher87 changed the title ~~Progress bar defaults to True when the session is interactive (Jupyter, RELP etc)~~ Show progress bar in interactive sessions (Jupyter, REPL etc) by default Aug 9, 2025

mfisher87 changed the title ~~Show progress bar in interactive sessions (Jupyter, REPL etc) by default~~ Show progress bar in interactive sessions (Jupyter, REPL) by default Aug 9, 2025

mfisher87 reviewed Aug 9, 2025

View reviewed changes

change hide_progress to show_progress

e59feef

mfisher87 requested changes Aug 12, 2025

View reviewed changes

betolink and others added 6 commits August 12, 2025 11:27

Update earthaccess/store.py

8750353

Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>

Update CHANGELOG.md

5bca506

Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>

Update earthaccess/api.py

6cc6fb9

Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>

Update earthaccess/store.py

07b8c81

Co-authored-by: Matt Fisher <3608264+mfisher87@users.noreply.github.com>

refactor show_progress

b99571e

fix lint

d034de0

betolink requested review from chuckwondo and removed request for Sherwin-14 August 12, 2025 16:48

chuckwondo previously approved these changes Aug 13, 2025

View reviewed changes

Update earthaccess/store.py

b3b6070

Co-authored-by: Chuck Daniels <cjdaniels4@gmail.com>

betolink dismissed chuckwondo’s stale review via b3b6070 August 13, 2025 15:56

improve docstrings for show_progress

3bfad3a

betolink added 2 commits August 13, 2025 11:17

Merge branch 'nsidc:main' into progress-bar

e2e8306

remove trailing space in docs

9888fc1

betolink requested a review from chuckwondo August 13, 2025 16:24

chuckwondo approved these changes Aug 13, 2025

View reviewed changes

betolink merged commit 7fa9c5a into earthaccess-dev:main Aug 13, 2025
8 of 11 checks passed

mfisher87 added this to earthaccess Mar 3, 2026

github-project-automation Bot moved this to ✅ Done in earthaccess Mar 3, 2026

mfisher87 removed this from earthaccess Mar 3, 2026

	show_progress: whether to display a progress bar. Defaults to `True` for interactive sessions, otherwise `False`.
	show_progress: whether or not to display a progress bar. If not specified, defaults to `True` for interactive sessions (i.e., in a notebook or a python REPL session), otherwise `False`.

Uh oh!

Conversation

betolink commented Aug 8, 2025 • edited by github-actions Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Aug 8, 2025 • edited by betolink Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

betolink commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mfisher87 Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mfisher87 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

betolink commented Aug 12, 2025

Uh oh!

chuckwondo commented Aug 13, 2025

Uh oh!

chuckwondo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

chuckwondo commented Aug 13, 2025

Uh oh!

betolink commented Aug 13, 2025

Uh oh!

betolink commented Aug 13, 2025

Uh oh!

chuckwondo left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

betolink commented Aug 8, 2025 •

edited by github-actions Bot

Loading

github-actions Bot commented Aug 8, 2025 •

edited by betolink

Loading

betolink commented Aug 8, 2025 •

edited

Loading

mfisher87 Aug 9, 2025 •

edited

Loading