Skip to content

Commit ffd9713

Browse files
author
Jason Munro
authored
Add arg to mute progress bars (#844)
* Add arg to mute progress bars * Linting
1 parent 63adcdf commit ffd9713

2 files changed

Lines changed: 10 additions & 1 deletion

File tree

mp_api/client/core/client.py

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@
4646
# TODO: think about how to migrate from PMG_MAPI_KEY
4747
DEFAULT_API_KEY = environ.get("MP_API_KEY", None)
4848
DEFAULT_ENDPOINT = environ.get("MP_API_ENDPOINT", "https://api.materialsproject.org/")
49+
settings = MAPIClientSettings()
4950

5051
T = TypeVar("T")
5152

@@ -70,6 +71,7 @@ def __init__(
7071
use_document_model: bool = True,
7172
timeout: int = 20,
7273
headers: dict = None,
74+
mute_progress_bars: bool = settings.MUTE_PROGRESS_BARS,
7375
):
7476
"""Args:
7577
api_key (str): A String API key for accessing the MaterialsProject
@@ -107,6 +109,7 @@ def __init__(
107109
self.use_document_model = use_document_model
108110
self.timeout = timeout
109111
self.headers = headers or {}
112+
self.mute_progress_bars = mute_progress_bars
110113

111114
if self.suffix:
112115
self.endpoint = urljoin(self.endpoint, self.suffix)
@@ -632,7 +635,7 @@ def _submit_requests(
632635
desc=pbar_message,
633636
total=num_docs_needed,
634637
)
635-
if not MAPIClientSettings().MUTE_PROGRESS_BARS
638+
if not self.mute_progress_bars
636639
else None
637640
)
638641

mp_api/client/mprester.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,7 @@ def __init__(
131131
use_document_model: bool = True,
132132
session: Session = None,
133133
headers: dict = None,
134+
mute_progress_bars: bool = _MAPI_SETTINGS.MUTE_PROGRESS_BARS,
134135
):
135136
"""Args:
136137
api_key (str): A String API key for accessing the MaterialsProject
@@ -162,6 +163,7 @@ def __init__(
162163
and will not give auto-complete for available fields.
163164
session (Session): Session object to use. By default (None), the client will create one.
164165
headers (dict): Custom headers for localhost connections.
166+
mute_progress_bars (bool): Whether to mute progress bars.
165167
"""
166168
if api_key and len(api_key) != 32:
167169
raise ValueError(
@@ -180,6 +182,7 @@ def __init__(
180182
)
181183
self.use_document_model = use_document_model
182184
self.monty_decode = monty_decode
185+
self.mute_progress_bars = mute_progress_bars
183186

184187
self._deprecated_attributes = [
185188
"eos",
@@ -269,6 +272,7 @@ def __init__(
269272
monty_decode=monty_decode,
270273
use_document_model=use_document_model,
271274
headers=self.headers,
275+
mute_progress_bars=self.mute_progress_bars,
272276
)
273277
for cls in self._all_resters
274278
if cls.suffix in core_suffix
@@ -293,6 +297,7 @@ def __init__(
293297
else False, # Disable monty decode on nested data which may give errors
294298
use_document_model=use_document_model,
295299
headers=self.headers,
300+
mute_progress_bars=self.mute_progress_bars,
296301
) # type: BaseRester
297302
setattr(
298303
self,
@@ -320,6 +325,7 @@ def __core_custom_getattr(_self, _attr, _rester_map):
320325
else False, # Disable monty decode on nested data which may give errors
321326
use_document_model=use_document_model,
322327
headers=self.headers,
328+
mute_progress_bars=self.mute_progress_bars,
323329
) # type: BaseRester
324330

325331
setattr(

0 commit comments

Comments
 (0)