-
Notifications
You must be signed in to change notification settings - Fork 2.6k
feat: add HAYSTACK_PROGRESS_BARS environment variable support #10389
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
luojiyin1987
wants to merge
16
commits into
deepset-ai:main
Choose a base branch
from
luojiyin1987:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+207
−26
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@luojiyin1987 is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
sjrl
reviewed
Jan 15, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Fix #8782 - Add support for
HAYSTACK_PROGRESS_BARSenvironment variable to globally control progress bar behavior across all Haystack components.Problem
Haystack 1.x had a
HAYSTACK_PROGRESS_BARSenvironment variable that allowed users to globally disable progress bars. This functionality was not migrated to Haystack 2.x, and setting standard tqdm environment variables likeTQDM_DISABLEdoesn't work because components explicitly passdisable=not self.progress_barto tqdm.Solution
Created a centralized
get_progress_bar_setting()utility function that:HAYSTACK_PROGRESS_BARSenvironment variable firstprogress_barparameter if env var is not setThis allows users to:
export HAYSTACK_PROGRESS_BARS=0export HAYSTACK_PROGRESS_BARS=1Serialization Fix
The implementation saves the original
progress_barparameter value as_progress_bar_paramfor serialization, whileself.progress_barcontains the env-resolved value for runtime. This prevents the environment variable effect from being "baked into" serialized pipeline configs.Changes
haystack/utils/progress_helper.py- Core utility functionhaystack/utils/__init__.py- Export the new functiontest/utils/test_progress_helper.py- Comprehensive testsprogress_barparameter:OpenAIDocumentEmbedderHuggingFaceAPIDocumentEmbedderAzureOpenAIDocumentEmbedderSentenceTransformersDocumentEmbedderSentenceTransformersTextEmbedderSentenceTransformersSparseDocumentEmbedderSentenceTransformersDocImageEmbedderLLMEvaluatorFaithfulnessEvaluatorContextRelevanceEvaluatorMarkdownToDocumentconverterTest Plan
get_progress_bar_setting()with various env valuesHAYSTACK_PROGRESS_BARS=0disables progress barsHAYSTACK_PROGRESS_BARS=1enables progress barsChecklist