huggingface-hub 0.34.4__py3-none-any.whl → 1.0.0rc0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of huggingface-hub might be problematic. Click here for more details.

Files changed (125) hide show
  1. huggingface_hub/__init__.py +46 -45
  2. huggingface_hub/_commit_api.py +28 -28
  3. huggingface_hub/_commit_scheduler.py +11 -8
  4. huggingface_hub/_inference_endpoints.py +8 -8
  5. huggingface_hub/_jobs_api.py +167 -10
  6. huggingface_hub/_login.py +13 -39
  7. huggingface_hub/_oauth.py +8 -8
  8. huggingface_hub/_snapshot_download.py +14 -28
  9. huggingface_hub/_space_api.py +4 -4
  10. huggingface_hub/_tensorboard_logger.py +13 -14
  11. huggingface_hub/_upload_large_folder.py +15 -15
  12. huggingface_hub/_webhooks_payload.py +3 -3
  13. huggingface_hub/_webhooks_server.py +2 -2
  14. huggingface_hub/cli/_cli_utils.py +2 -2
  15. huggingface_hub/cli/auth.py +5 -6
  16. huggingface_hub/cli/cache.py +14 -20
  17. huggingface_hub/cli/download.py +4 -4
  18. huggingface_hub/cli/jobs.py +560 -11
  19. huggingface_hub/cli/lfs.py +4 -4
  20. huggingface_hub/cli/repo.py +7 -7
  21. huggingface_hub/cli/repo_files.py +2 -2
  22. huggingface_hub/cli/upload.py +4 -4
  23. huggingface_hub/cli/upload_large_folder.py +3 -3
  24. huggingface_hub/commands/_cli_utils.py +2 -2
  25. huggingface_hub/commands/delete_cache.py +13 -13
  26. huggingface_hub/commands/download.py +4 -13
  27. huggingface_hub/commands/lfs.py +4 -4
  28. huggingface_hub/commands/repo_files.py +2 -2
  29. huggingface_hub/commands/scan_cache.py +1 -1
  30. huggingface_hub/commands/tag.py +1 -3
  31. huggingface_hub/commands/upload.py +4 -4
  32. huggingface_hub/commands/upload_large_folder.py +3 -3
  33. huggingface_hub/commands/user.py +5 -6
  34. huggingface_hub/community.py +5 -5
  35. huggingface_hub/constants.py +3 -41
  36. huggingface_hub/dataclasses.py +16 -19
  37. huggingface_hub/errors.py +42 -29
  38. huggingface_hub/fastai_utils.py +8 -9
  39. huggingface_hub/file_download.py +153 -252
  40. huggingface_hub/hf_api.py +815 -600
  41. huggingface_hub/hf_file_system.py +98 -62
  42. huggingface_hub/hub_mixin.py +37 -57
  43. huggingface_hub/inference/_client.py +177 -325
  44. huggingface_hub/inference/_common.py +110 -124
  45. huggingface_hub/inference/_generated/_async_client.py +226 -432
  46. huggingface_hub/inference/_generated/types/automatic_speech_recognition.py +3 -3
  47. huggingface_hub/inference/_generated/types/base.py +10 -7
  48. huggingface_hub/inference/_generated/types/chat_completion.py +18 -16
  49. huggingface_hub/inference/_generated/types/depth_estimation.py +2 -2
  50. huggingface_hub/inference/_generated/types/document_question_answering.py +2 -2
  51. huggingface_hub/inference/_generated/types/feature_extraction.py +2 -2
  52. huggingface_hub/inference/_generated/types/fill_mask.py +2 -2
  53. huggingface_hub/inference/_generated/types/sentence_similarity.py +3 -3
  54. huggingface_hub/inference/_generated/types/summarization.py +2 -2
  55. huggingface_hub/inference/_generated/types/table_question_answering.py +4 -4
  56. huggingface_hub/inference/_generated/types/text2text_generation.py +2 -2
  57. huggingface_hub/inference/_generated/types/text_generation.py +10 -10
  58. huggingface_hub/inference/_generated/types/text_to_video.py +2 -2
  59. huggingface_hub/inference/_generated/types/token_classification.py +2 -2
  60. huggingface_hub/inference/_generated/types/translation.py +2 -2
  61. huggingface_hub/inference/_generated/types/zero_shot_classification.py +2 -2
  62. huggingface_hub/inference/_generated/types/zero_shot_image_classification.py +2 -2
  63. huggingface_hub/inference/_generated/types/zero_shot_object_detection.py +1 -3
  64. huggingface_hub/inference/_mcp/_cli_hacks.py +3 -3
  65. huggingface_hub/inference/_mcp/agent.py +3 -3
  66. huggingface_hub/inference/_mcp/cli.py +1 -1
  67. huggingface_hub/inference/_mcp/constants.py +2 -3
  68. huggingface_hub/inference/_mcp/mcp_client.py +58 -30
  69. huggingface_hub/inference/_mcp/types.py +10 -7
  70. huggingface_hub/inference/_mcp/utils.py +11 -7
  71. huggingface_hub/inference/_providers/__init__.py +2 -2
  72. huggingface_hub/inference/_providers/_common.py +49 -25
  73. huggingface_hub/inference/_providers/black_forest_labs.py +6 -6
  74. huggingface_hub/inference/_providers/cohere.py +3 -3
  75. huggingface_hub/inference/_providers/fal_ai.py +25 -25
  76. huggingface_hub/inference/_providers/featherless_ai.py +4 -4
  77. huggingface_hub/inference/_providers/fireworks_ai.py +3 -3
  78. huggingface_hub/inference/_providers/hf_inference.py +28 -20
  79. huggingface_hub/inference/_providers/hyperbolic.py +4 -4
  80. huggingface_hub/inference/_providers/nebius.py +10 -10
  81. huggingface_hub/inference/_providers/novita.py +5 -5
  82. huggingface_hub/inference/_providers/nscale.py +4 -4
  83. huggingface_hub/inference/_providers/replicate.py +15 -15
  84. huggingface_hub/inference/_providers/sambanova.py +6 -6
  85. huggingface_hub/inference/_providers/together.py +7 -7
  86. huggingface_hub/lfs.py +20 -31
  87. huggingface_hub/repocard.py +18 -18
  88. huggingface_hub/repocard_data.py +56 -56
  89. huggingface_hub/serialization/__init__.py +0 -1
  90. huggingface_hub/serialization/_base.py +9 -9
  91. huggingface_hub/serialization/_dduf.py +7 -7
  92. huggingface_hub/serialization/_torch.py +28 -28
  93. huggingface_hub/utils/__init__.py +10 -4
  94. huggingface_hub/utils/_auth.py +5 -5
  95. huggingface_hub/utils/_cache_manager.py +31 -31
  96. huggingface_hub/utils/_deprecation.py +1 -1
  97. huggingface_hub/utils/_dotenv.py +3 -3
  98. huggingface_hub/utils/_fixes.py +0 -10
  99. huggingface_hub/utils/_git_credential.py +4 -4
  100. huggingface_hub/utils/_headers.py +7 -29
  101. huggingface_hub/utils/_http.py +366 -208
  102. huggingface_hub/utils/_pagination.py +4 -4
  103. huggingface_hub/utils/_paths.py +5 -5
  104. huggingface_hub/utils/_runtime.py +15 -13
  105. huggingface_hub/utils/_safetensors.py +21 -21
  106. huggingface_hub/utils/_subprocess.py +9 -9
  107. huggingface_hub/utils/_telemetry.py +3 -3
  108. huggingface_hub/utils/_typing.py +25 -5
  109. huggingface_hub/utils/_validators.py +53 -72
  110. huggingface_hub/utils/_xet.py +16 -16
  111. huggingface_hub/utils/_xet_progress_reporting.py +32 -11
  112. huggingface_hub/utils/insecure_hashlib.py +3 -9
  113. huggingface_hub/utils/tqdm.py +3 -3
  114. {huggingface_hub-0.34.4.dist-info → huggingface_hub-1.0.0rc0.dist-info}/METADATA +18 -29
  115. huggingface_hub-1.0.0rc0.dist-info/RECORD +161 -0
  116. huggingface_hub/inference_api.py +0 -217
  117. huggingface_hub/keras_mixin.py +0 -500
  118. huggingface_hub/repository.py +0 -1477
  119. huggingface_hub/serialization/_tensorflow.py +0 -95
  120. huggingface_hub/utils/_hf_folder.py +0 -68
  121. huggingface_hub-0.34.4.dist-info/RECORD +0 -166
  122. {huggingface_hub-0.34.4.dist-info → huggingface_hub-1.0.0rc0.dist-info}/LICENSE +0 -0
  123. {huggingface_hub-0.34.4.dist-info → huggingface_hub-1.0.0rc0.dist-info}/WHEEL +0 -0
  124. {huggingface_hub-0.34.4.dist-info → huggingface_hub-1.0.0rc0.dist-info}/entry_points.txt +0 -0
  125. {huggingface_hub-0.34.4.dist-info → huggingface_hub-1.0.0rc0.dist-info}/top_level.txt +0 -0
@@ -12,23 +12,21 @@
12
12
  # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
13
  # See the License for the specific language governing permissions and
14
14
  # limitations under the License.
15
- """Contains utilities to handle HTTP requests in Huggingface Hub."""
15
+ """Contains utilities to handle HTTP requests in huggingface_hub."""
16
16
 
17
+ import atexit
17
18
  import io
18
- import os
19
+ import json
19
20
  import re
20
21
  import threading
21
22
  import time
22
23
  import uuid
23
- from functools import lru_cache
24
+ from contextlib import contextmanager
24
25
  from http import HTTPStatus
25
26
  from shlex import quote
26
- from typing import Any, Callable, List, Optional, Tuple, Type, Union
27
+ from typing import Any, Callable, Generator, Optional, Union
27
28
 
28
- import requests
29
- from requests import HTTPError, Response
30
- from requests.adapters import HTTPAdapter
31
- from requests.models import PreparedRequest
29
+ import httpx
32
30
 
33
31
  from huggingface_hub.errors import OfflineModeIsEnabled
34
32
 
@@ -36,14 +34,13 @@ from .. import constants
36
34
  from ..errors import (
37
35
  BadRequestError,
38
36
  DisabledRepoError,
39
- EntryNotFoundError,
40
37
  GatedRepoError,
41
38
  HfHubHTTPError,
39
+ RemoteEntryNotFoundError,
42
40
  RepositoryNotFoundError,
43
41
  RevisionNotFoundError,
44
42
  )
45
43
  from . import logging
46
- from ._fixes import JSONDecodeError
47
44
  from ._lfs import SliceFileObj
48
45
  from ._typing import HTTP_METHOD_T
49
46
 
@@ -72,142 +69,273 @@ REPO_API_REGEX = re.compile(
72
69
  )
73
70
 
74
71
 
75
- class UniqueRequestIdAdapter(HTTPAdapter):
76
- X_AMZN_TRACE_ID = "X-Amzn-Trace-Id"
72
+ class HfHubTransport(httpx.HTTPTransport):
73
+ """
74
+ Transport that will be used to make HTTP requests to the Hugging Face Hub.
77
75
 
78
- def add_headers(self, request, **kwargs):
79
- super().add_headers(request, **kwargs)
76
+ What it does:
77
+ - Block requests if offline mode is enabled
78
+ - Add a request ID to the request headers
79
+ - Log the request if debug mode is enabled
80
+ """
80
81
 
81
- # Add random request ID => easier for server-side debug
82
- if X_AMZN_TRACE_ID not in request.headers:
83
- request.headers[X_AMZN_TRACE_ID] = request.headers.get(X_REQUEST_ID) or str(uuid.uuid4())
82
+ def handle_request(self, request: httpx.Request) -> httpx.Response:
83
+ if constants.HF_HUB_OFFLINE:
84
+ raise OfflineModeIsEnabled(
85
+ f"Cannot reach {request.url}: offline mode is enabled. To disable it, please unset the `HF_HUB_OFFLINE` environment variable."
86
+ )
87
+ request_id = _add_request_id(request)
88
+ try:
89
+ return super().handle_request(request)
90
+ except httpx.RequestError as e:
91
+ if request_id is not None:
92
+ # Taken from https://stackoverflow.com/a/58270258
93
+ e.args = (*e.args, f"(Request ID: {request_id})")
94
+ raise
84
95
 
85
- # Add debug log
86
- has_token = len(str(request.headers.get("authorization", ""))) > 0
87
- logger.debug(
88
- f"Request {request.headers[X_AMZN_TRACE_ID]}: {request.method} {request.url} (authenticated: {has_token})"
89
- )
90
96
 
91
- def send(self, request: PreparedRequest, *args, **kwargs) -> Response:
92
- """Catch any RequestException to append request id to the error message for debugging."""
93
- if constants.HF_DEBUG:
94
- logger.debug(f"Send: {_curlify(request)}")
97
+ class HfHubAsyncTransport(httpx.AsyncHTTPTransport):
98
+ async def handle_async_request(self, request: httpx.Request) -> httpx.Response:
99
+ if constants.HF_HUB_OFFLINE:
100
+ raise OfflineModeIsEnabled(
101
+ f"Cannot reach {request.url}: offline mode is enabled. To disable it, please unset the `HF_HUB_OFFLINE` environment variable."
102
+ )
103
+ request_id = _add_request_id(request)
95
104
  try:
96
- return super().send(request, *args, **kwargs)
97
- except requests.RequestException as e:
98
- request_id = request.headers.get(X_AMZN_TRACE_ID)
105
+ return await super().handle_async_request(request)
106
+ except httpx.RequestError as e:
99
107
  if request_id is not None:
100
108
  # Taken from https://stackoverflow.com/a/58270258
101
109
  e.args = (*e.args, f"(Request ID: {request_id})")
102
110
  raise
103
111
 
104
112
 
105
- class OfflineAdapter(HTTPAdapter):
106
- def send(self, request: PreparedRequest, *args, **kwargs) -> Response:
107
- raise OfflineModeIsEnabled(
108
- f"Cannot reach {request.url}: offline mode is enabled. To disable it, please unset the `HF_HUB_OFFLINE` environment variable."
109
- )
113
+ def _add_request_id(request: httpx.Request) -> Optional[str]:
114
+ # Add random request ID => easier for server-side debug
115
+ if X_AMZN_TRACE_ID not in request.headers:
116
+ request.headers[X_AMZN_TRACE_ID] = request.headers.get(X_REQUEST_ID) or str(uuid.uuid4())
117
+ request_id = request.headers.get(X_AMZN_TRACE_ID)
110
118
 
119
+ # Debug log
120
+ logger.debug(
121
+ "Request %s: %s %s (authenticated: %s)",
122
+ request_id,
123
+ request.method,
124
+ request.url,
125
+ request.headers.get("authorization") is not None,
126
+ )
127
+ if constants.HF_DEBUG:
128
+ logger.debug("Send: %s", _curlify(request))
111
129
 
112
- def _default_backend_factory() -> requests.Session:
113
- session = requests.Session()
114
- if constants.HF_HUB_OFFLINE:
115
- session.mount("http://", OfflineAdapter())
116
- session.mount("https://", OfflineAdapter())
117
- else:
118
- session.mount("http://", UniqueRequestIdAdapter())
119
- session.mount("https://", UniqueRequestIdAdapter())
120
- return session
130
+ return request_id
121
131
 
122
132
 
123
- BACKEND_FACTORY_T = Callable[[], requests.Session]
124
- _GLOBAL_BACKEND_FACTORY: BACKEND_FACTORY_T = _default_backend_factory
133
+ def default_client_factory() -> httpx.Client:
134
+ """
135
+ Factory function to create a `httpx.Client` with the default transport.
136
+ """
137
+ return httpx.Client(
138
+ transport=HfHubTransport(),
139
+ follow_redirects=True,
140
+ timeout=httpx.Timeout(constants.DEFAULT_REQUEST_TIMEOUT, write=60.0),
141
+ )
125
142
 
126
143
 
127
- def configure_http_backend(backend_factory: BACKEND_FACTORY_T = _default_backend_factory) -> None:
144
+ def default_async_client_factory() -> httpx.AsyncClient:
128
145
  """
129
- Configure the HTTP backend by providing a `backend_factory`. Any HTTP calls made by `huggingface_hub` will use a
130
- Session object instantiated by this factory. This can be useful if you are running your scripts in a specific
131
- environment requiring custom configuration (e.g. custom proxy or certifications).
146
+ Factory function to create a `httpx.AsyncClient` with the default transport.
147
+ """
148
+ return httpx.AsyncClient(
149
+ transport=HfHubAsyncTransport(),
150
+ follow_redirects=True,
151
+ timeout=httpx.Timeout(constants.DEFAULT_REQUEST_TIMEOUT, write=60.0),
152
+ )
132
153
 
133
- Use [`get_session`] to get a configured Session. Since `requests.Session` is not guaranteed to be thread-safe,
134
- `huggingface_hub` creates 1 Session instance per thread. They are all instantiated using the same `backend_factory`
135
- set in [`configure_http_backend`]. A LRU cache is used to cache the created sessions (and connections) between
136
- calls. Max size is 128 to avoid memory leaks if thousands of threads are spawned.
137
154
 
138
- See [this issue](https://github.com/psf/requests/issues/2766) to know more about thread-safety in `requests`.
155
+ CLIENT_FACTORY_T = Callable[[], httpx.Client]
156
+ ASYNC_CLIENT_FACTORY_T = Callable[[], httpx.AsyncClient]
139
157
 
140
- Example:
141
- ```py
142
- import requests
143
- from huggingface_hub import configure_http_backend, get_session
158
+ _CLIENT_LOCK = threading.Lock()
159
+ _GLOBAL_CLIENT_FACTORY: CLIENT_FACTORY_T = default_client_factory
160
+ _GLOBAL_ASYNC_CLIENT_FACTORY: ASYNC_CLIENT_FACTORY_T = default_async_client_factory
161
+ _GLOBAL_CLIENT: Optional[httpx.Client] = None
144
162
 
145
- # Create a factory function that returns a Session with configured proxies
146
- def backend_factory() -> requests.Session:
147
- session = requests.Session()
148
- session.proxies = {"http": "http://10.10.1.10:3128", "https": "https://10.10.1.11:1080"}
149
- return session
150
163
 
151
- # Set it as the default session factory
152
- configure_http_backend(backend_factory=backend_factory)
164
+ def set_client_factory(client_factory: CLIENT_FACTORY_T) -> None:
165
+ """
166
+ Set the HTTP client factory to be used by `huggingface_hub`.
153
167
 
154
- # In practice, this is mostly done internally in `huggingface_hub`
155
- session = get_session()
156
- ```
168
+ The client factory is a method that returns a `httpx.Client` object. On the first call to [`get_client`] the client factory
169
+ will be used to create a new `httpx.Client` object that will be shared between all calls made by `huggingface_hub`.
170
+
171
+ This can be useful if you are running your scripts in a specific environment requiring custom configuration (e.g. custom proxy or certifications).
172
+
173
+ Use [`get_client`] to get a correctly configured `httpx.Client`.
157
174
  """
158
- global _GLOBAL_BACKEND_FACTORY
159
- _GLOBAL_BACKEND_FACTORY = backend_factory
160
- reset_sessions()
175
+ global _GLOBAL_CLIENT_FACTORY
176
+ with _CLIENT_LOCK:
177
+ close_client()
178
+ _GLOBAL_CLIENT_FACTORY = client_factory
161
179
 
162
180
 
163
- def get_session() -> requests.Session:
181
+ def set_async_client_factory(async_client_factory: ASYNC_CLIENT_FACTORY_T) -> None:
164
182
  """
165
- Get a `requests.Session` object, using the session factory from the user.
183
+ Set the HTTP async client factory to be used by `huggingface_hub`.
166
184
 
167
- Use [`get_session`] to get a configured Session. Since `requests.Session` is not guaranteed to be thread-safe,
168
- `huggingface_hub` creates 1 Session instance per thread. They are all instantiated using the same `backend_factory`
169
- set in [`configure_http_backend`]. A LRU cache is used to cache the created sessions (and connections) between
170
- calls. Max size is 128 to avoid memory leaks if thousands of threads are spawned.
185
+ The async client factory is a method that returns a `httpx.AsyncClient` object.
186
+ This can be useful if you are running your scripts in a specific environment requiring custom configuration (e.g. custom proxy or certifications).
187
+ Use [`get_async_client`] to get a correctly configured `httpx.AsyncClient`.
171
188
 
172
- See [this issue](https://github.com/psf/requests/issues/2766) to know more about thread-safety in `requests`.
189
+ <Tip warning={true}>
173
190
 
174
- Example:
175
- ```py
176
- import requests
177
- from huggingface_hub import configure_http_backend, get_session
191
+ Contrary to the `httpx.Client` that is shared between all calls made by `huggingface_hub`, the `httpx.AsyncClient` is not shared.
192
+ It is recommended to use an async context manager to ensure the client is properly closed when the context is exited.
178
193
 
179
- # Create a factory function that returns a Session with configured proxies
180
- def backend_factory() -> requests.Session:
181
- session = requests.Session()
182
- session.proxies = {"http": "http://10.10.1.10:3128", "https": "https://10.10.1.11:1080"}
183
- return session
194
+ </Tip>
195
+ """
196
+ global _GLOBAL_ASYNC_CLIENT_FACTORY
197
+ _GLOBAL_ASYNC_CLIENT_FACTORY = async_client_factory
184
198
 
185
- # Set it as the default session factory
186
- configure_http_backend(backend_factory=backend_factory)
187
199
 
188
- # In practice, this is mostly done internally in `huggingface_hub`
189
- session = get_session()
190
- ```
200
+ def get_session() -> httpx.Client:
201
+ """
202
+ Get a `httpx.Client` object, using the transport factory from the user.
203
+
204
+ This client is shared between all calls made by `huggingface_hub`. Therefore you should not close it manually.
205
+
206
+ Use [`set_client_factory`] to customize the `httpx.Client`.
191
207
  """
192
- return _get_session_from_cache(process_id=os.getpid(), thread_id=threading.get_ident())
208
+ global _GLOBAL_CLIENT
209
+ if _GLOBAL_CLIENT is None:
210
+ with _CLIENT_LOCK:
211
+ _GLOBAL_CLIENT = _GLOBAL_CLIENT_FACTORY()
212
+ return _GLOBAL_CLIENT
193
213
 
194
214
 
195
- def reset_sessions() -> None:
196
- """Reset the cache of sessions.
215
+ def get_async_session() -> httpx.AsyncClient:
216
+ """
217
+ Return a `httpx.AsyncClient` object, using the transport factory from the user.
218
+
219
+ Use [`set_async_client_factory`] to customize the `httpx.AsyncClient`.
220
+
221
+ <Tip warning={true}>
222
+
223
+ Contrary to the `httpx.Client` that is shared between all calls made by `huggingface_hub`, the `httpx.AsyncClient` is not shared.
224
+ It is recommended to use an async context manager to ensure the client is properly closed when the context is exited.
197
225
 
198
- Mostly used internally when sessions are reconfigured or an SSLError is raised.
199
- See [`configure_http_backend`] for more details.
226
+ </Tip>
200
227
  """
201
- _get_session_from_cache.cache_clear()
228
+ return _GLOBAL_ASYNC_CLIENT_FACTORY()
202
229
 
203
230
 
204
- @lru_cache
205
- def _get_session_from_cache(process_id: int, thread_id: int) -> requests.Session:
231
+ def close_client() -> None:
206
232
  """
207
- Create a new session per thread using global factory. Using LRU cache (maxsize 128) to avoid memory leaks when
208
- using thousands of threads. Cache is cleared when `configure_http_backend` is called.
233
+ Close the global httpx.Client used by `huggingface_hub`.
234
+
235
+ If a Client is closed, it will be recreated on the next call to [`get_client`].
236
+
237
+ Can be useful if e.g. an SSL certificate has been updated.
209
238
  """
210
- return _GLOBAL_BACKEND_FACTORY()
239
+ global _GLOBAL_CLIENT
240
+ client = _GLOBAL_CLIENT
241
+
242
+ # First, set global client to None
243
+ _GLOBAL_CLIENT = None
244
+
245
+ # Then, close the clients
246
+ if client is not None:
247
+ try:
248
+ client.close()
249
+ except Exception as e:
250
+ logger.warning(f"Error closing client: {e}")
251
+
252
+
253
+ atexit.register(close_client)
254
+
255
+
256
+ def _http_backoff_base(
257
+ method: HTTP_METHOD_T,
258
+ url: str,
259
+ *,
260
+ max_retries: int = 5,
261
+ base_wait_time: float = 1,
262
+ max_wait_time: float = 8,
263
+ retry_on_exceptions: Union[type[Exception], tuple[type[Exception], ...]] = (
264
+ httpx.TimeoutException,
265
+ httpx.NetworkError,
266
+ ),
267
+ retry_on_status_codes: Union[int, tuple[int, ...]] = HTTPStatus.SERVICE_UNAVAILABLE,
268
+ stream: bool = False,
269
+ **kwargs,
270
+ ) -> Generator[httpx.Response, None, None]:
271
+ """Internal implementation of HTTP backoff logic shared between `http_backoff` and `http_stream_backoff`."""
272
+ if isinstance(retry_on_exceptions, type): # Tuple from single exception type
273
+ retry_on_exceptions = (retry_on_exceptions,)
274
+
275
+ if isinstance(retry_on_status_codes, int): # Tuple from single status code
276
+ retry_on_status_codes = (retry_on_status_codes,)
277
+
278
+ nb_tries = 0
279
+ sleep_time = base_wait_time
280
+
281
+ # If `data` is used and is a file object (or any IO), it will be consumed on the
282
+ # first HTTP request. We need to save the initial position so that the full content
283
+ # of the file is re-sent on http backoff. See warning tip in docstring.
284
+ io_obj_initial_pos = None
285
+ if "data" in kwargs and isinstance(kwargs["data"], (io.IOBase, SliceFileObj)):
286
+ io_obj_initial_pos = kwargs["data"].tell()
287
+
288
+ client = get_session()
289
+ while True:
290
+ nb_tries += 1
291
+ try:
292
+ # If `data` is used and is a file object (or any IO), set back cursor to
293
+ # initial position.
294
+ if io_obj_initial_pos is not None:
295
+ kwargs["data"].seek(io_obj_initial_pos)
296
+
297
+ # Perform request and handle response
298
+ def _should_retry(response: httpx.Response) -> bool:
299
+ """Handle response and return True if should retry, False if should return/yield."""
300
+ if response.status_code not in retry_on_status_codes:
301
+ return False # Success, don't retry
302
+
303
+ # Wrong status code returned (HTTP 503 for instance)
304
+ logger.warning(f"HTTP Error {response.status_code} thrown while requesting {method} {url}")
305
+ if nb_tries > max_retries:
306
+ hf_raise_for_status(response) # Will raise uncaught exception
307
+ # Return/yield response to avoid infinite loop in the corner case where the
308
+ # user ask for retry on a status code that doesn't raise_for_status.
309
+ return False # Don't retry, return/yield response
310
+
311
+ return True # Should retry
312
+
313
+ if stream:
314
+ with client.stream(method=method, url=url, **kwargs) as response:
315
+ if not _should_retry(response):
316
+ yield response
317
+ return
318
+ else:
319
+ response = client.request(method=method, url=url, **kwargs)
320
+ if not _should_retry(response):
321
+ yield response
322
+ return
323
+
324
+ except retry_on_exceptions as err:
325
+ logger.warning(f"'{err}' thrown while requesting {method} {url}")
326
+
327
+ if isinstance(err, httpx.ConnectError):
328
+ close_client() # In case of SSLError it's best to close the shared httpx.Client objects
329
+
330
+ if nb_tries > max_retries:
331
+ raise err
332
+
333
+ # Sleep for X seconds
334
+ logger.warning(f"Retrying in {sleep_time}s [Retry {nb_tries}/{max_retries}].")
335
+ time.sleep(sleep_time)
336
+
337
+ # Update sleep time for next retry
338
+ sleep_time = min(max_wait_time, sleep_time * 2) # Exponential backoff
211
339
 
212
340
 
213
341
  def http_backoff(
@@ -217,14 +345,14 @@ def http_backoff(
217
345
  max_retries: int = 5,
218
346
  base_wait_time: float = 1,
219
347
  max_wait_time: float = 8,
220
- retry_on_exceptions: Union[Type[Exception], Tuple[Type[Exception], ...]] = (
221
- requests.Timeout,
222
- requests.ConnectionError,
348
+ retry_on_exceptions: Union[type[Exception], tuple[type[Exception], ...]] = (
349
+ httpx.TimeoutException,
350
+ httpx.NetworkError,
223
351
  ),
224
- retry_on_status_codes: Union[int, Tuple[int, ...]] = HTTPStatus.SERVICE_UNAVAILABLE,
352
+ retry_on_status_codes: Union[int, tuple[int, ...]] = HTTPStatus.SERVICE_UNAVAILABLE,
225
353
  **kwargs,
226
- ) -> Response:
227
- """Wrapper around requests to retry calls on an endpoint, with exponential backoff.
354
+ ) -> httpx.Response:
355
+ """Wrapper around httpx to retry calls on an endpoint, with exponential backoff.
228
356
 
229
357
  Endpoint call is retried on exceptions (ex: connection timeout, proxy error,...)
230
358
  and/or on specific status codes (ex: service unavailable). If the call failed more
@@ -247,20 +375,20 @@ def http_backoff(
247
375
  `max_wait_time`.
248
376
  max_wait_time (`float`, *optional*, defaults to `8`):
249
377
  Maximum duration (in seconds) to wait before retrying.
250
- retry_on_exceptions (`Type[Exception]` or `Tuple[Type[Exception]]`, *optional*):
378
+ retry_on_exceptions (`type[Exception]` or `tuple[type[Exception]]`, *optional*):
251
379
  Define which exceptions must be caught to retry the request. Can be a single type or a tuple of types.
252
- By default, retry on `requests.Timeout` and `requests.ConnectionError`.
253
- retry_on_status_codes (`int` or `Tuple[int]`, *optional*, defaults to `503`):
380
+ By default, retry on `httpx.TimeoutException` and `httpx.NetworkError`.
381
+ retry_on_status_codes (`int` or `tuple[int]`, *optional*, defaults to `503`):
254
382
  Define on which status codes the request must be retried. By default, only
255
383
  HTTP 503 Service Unavailable is retried.
256
384
  **kwargs (`dict`, *optional*):
257
- kwargs to pass to `requests.request`.
385
+ kwargs to pass to `httpx.request`.
258
386
 
259
387
  Example:
260
388
  ```
261
389
  >>> from huggingface_hub.utils import http_backoff
262
390
 
263
- # Same usage as "requests.request".
391
+ # Same usage as "httpx.request".
264
392
  >>> response = http_backoff("GET", "https://www.google.com")
265
393
  >>> response.raise_for_status()
266
394
 
@@ -271,7 +399,7 @@ def http_backoff(
271
399
 
272
400
  <Tip warning={true}>
273
401
 
274
- When using `requests` it is possible to stream data by passing an iterator to the
402
+ When using `httpx` it is possible to stream data by passing an iterator to the
275
403
  `data` argument. On http backoff this is a problem as the iterator is not reset
276
404
  after a failed call. This issue is mitigated for file objects or any IO streams
277
405
  by saving the initial position of the cursor (with `data.tell()`) and resetting the
@@ -281,59 +409,105 @@ def http_backoff(
281
409
 
282
410
  </Tip>
283
411
  """
284
- if isinstance(retry_on_exceptions, type): # Tuple from single exception type
285
- retry_on_exceptions = (retry_on_exceptions,)
412
+ return next(
413
+ _http_backoff_base(
414
+ method=method,
415
+ url=url,
416
+ max_retries=max_retries,
417
+ base_wait_time=base_wait_time,
418
+ max_wait_time=max_wait_time,
419
+ retry_on_exceptions=retry_on_exceptions,
420
+ retry_on_status_codes=retry_on_status_codes,
421
+ stream=False,
422
+ **kwargs,
423
+ )
424
+ )
286
425
 
287
- if isinstance(retry_on_status_codes, int): # Tuple from single status code
288
- retry_on_status_codes = (retry_on_status_codes,)
289
426
 
290
- nb_tries = 0
291
- sleep_time = base_wait_time
427
+ @contextmanager
428
+ def http_stream_backoff(
429
+ method: HTTP_METHOD_T,
430
+ url: str,
431
+ *,
432
+ max_retries: int = 5,
433
+ base_wait_time: float = 1,
434
+ max_wait_time: float = 8,
435
+ retry_on_exceptions: Union[type[Exception], tuple[type[Exception], ...]] = (
436
+ httpx.TimeoutException,
437
+ httpx.NetworkError,
438
+ ),
439
+ retry_on_status_codes: Union[int, tuple[int, ...]] = HTTPStatus.SERVICE_UNAVAILABLE,
440
+ **kwargs,
441
+ ) -> Generator[httpx.Response, None, None]:
442
+ """Wrapper around httpx to retry calls on an endpoint, with exponential backoff.
292
443
 
293
- # If `data` is used and is a file object (or any IO), it will be consumed on the
294
- # first HTTP request. We need to save the initial position so that the full content
295
- # of the file is re-sent on http backoff. See warning tip in docstring.
296
- io_obj_initial_pos = None
297
- if "data" in kwargs and isinstance(kwargs["data"], (io.IOBase, SliceFileObj)):
298
- io_obj_initial_pos = kwargs["data"].tell()
444
+ Endpoint call is retried on exceptions (ex: connection timeout, proxy error,...)
445
+ and/or on specific status codes (ex: service unavailable). If the call failed more
446
+ than `max_retries`, the exception is thrown or `raise_for_status` is called on the
447
+ response object.
299
448
 
300
- session = get_session()
301
- while True:
302
- nb_tries += 1
303
- try:
304
- # If `data` is used and is a file object (or any IO), set back cursor to
305
- # initial position.
306
- if io_obj_initial_pos is not None:
307
- kwargs["data"].seek(io_obj_initial_pos)
449
+ Re-implement mechanisms from the `backoff` library to avoid adding an external
450
+ dependencies to `hugging_face_hub`. See https://github.com/litl/backoff.
308
451
 
309
- # Perform request and return if status_code is not in the retry list.
310
- response = session.request(method=method, url=url, **kwargs)
311
- if response.status_code not in retry_on_status_codes:
312
- return response
452
+ Args:
453
+ method (`Literal["GET", "OPTIONS", "HEAD", "POST", "PUT", "PATCH", "DELETE"]`):
454
+ HTTP method to perform.
455
+ url (`str`):
456
+ The URL of the resource to fetch.
457
+ max_retries (`int`, *optional*, defaults to `5`):
458
+ Maximum number of retries, defaults to 5 (no retries).
459
+ base_wait_time (`float`, *optional*, defaults to `1`):
460
+ Duration (in seconds) to wait before retrying the first time.
461
+ Wait time between retries then grows exponentially, capped by
462
+ `max_wait_time`.
463
+ max_wait_time (`float`, *optional*, defaults to `8`):
464
+ Maximum duration (in seconds) to wait before retrying.
465
+ retry_on_exceptions (`type[Exception]` or `tuple[type[Exception]]`, *optional*):
466
+ Define which exceptions must be caught to retry the request. Can be a single type or a tuple of types.
467
+ By default, retry on `httpx.Timeout` and `httpx.NetworkError`.
468
+ retry_on_status_codes (`int` or `tuple[int]`, *optional*, defaults to `503`):
469
+ Define on which status codes the request must be retried. By default, only
470
+ HTTP 503 Service Unavailable is retried.
471
+ **kwargs (`dict`, *optional*):
472
+ kwargs to pass to `httpx.request`.
313
473
 
314
- # Wrong status code returned (HTTP 503 for instance)
315
- logger.warning(f"HTTP Error {response.status_code} thrown while requesting {method} {url}")
316
- if nb_tries > max_retries:
317
- response.raise_for_status() # Will raise uncaught exception
318
- # We return response to avoid infinite loop in the corner case where the
319
- # user ask for retry on a status code that doesn't raise_for_status.
320
- return response
474
+ Example:
475
+ ```
476
+ >>> from huggingface_hub.utils import http_stream_backoff
321
477
 
322
- except retry_on_exceptions as err:
323
- logger.warning(f"'{err}' thrown while requesting {method} {url}")
478
+ # Same usage as "httpx.stream".
479
+ >>> with http_stream_backoff("GET", "https://www.google.com") as response:
480
+ ... for chunk in response.iter_bytes():
481
+ ... print(chunk)
324
482
 
325
- if isinstance(err, requests.ConnectionError):
326
- reset_sessions() # In case of SSLError it's best to reset the shared requests.Session objects
483
+ # If you expect a Gateway Timeout from time to time
484
+ >>> with http_stream_backoff("PUT", upload_url, data=data, retry_on_status_codes=504) as response:
485
+ ... response.raise_for_status()
486
+ ```
327
487
 
328
- if nb_tries > max_retries:
329
- raise err
488
+ <Tip warning={true}>
330
489
 
331
- # Sleep for X seconds
332
- logger.warning(f"Retrying in {sleep_time}s [Retry {nb_tries}/{max_retries}].")
333
- time.sleep(sleep_time)
490
+ When using `httpx` it is possible to stream data by passing an iterator to the
491
+ `data` argument. On http backoff this is a problem as the iterator is not reset
492
+ after a failed call. This issue is mitigated for file objects or any IO streams
493
+ by saving the initial position of the cursor (with `data.tell()`) and resetting the
494
+ cursor between each call (with `data.seek()`). For arbitrary iterators, http backoff
495
+ will fail. If this is a hard constraint for you, please let us know by opening an
496
+ issue on [Github](https://github.com/huggingface/huggingface_hub).
334
497
 
335
- # Update sleep time for next retry
336
- sleep_time = min(max_wait_time, sleep_time * 2) # Exponential backoff
498
+ </Tip>
499
+ """
500
+ yield from _http_backoff_base(
501
+ method=method,
502
+ url=url,
503
+ max_retries=max_retries,
504
+ base_wait_time=base_wait_time,
505
+ max_wait_time=max_wait_time,
506
+ retry_on_exceptions=retry_on_exceptions,
507
+ retry_on_status_codes=retry_on_status_codes,
508
+ stream=True,
509
+ **kwargs,
510
+ )
337
511
 
338
512
 
339
513
  def fix_hf_endpoint_in_url(url: str, endpoint: Optional[str]) -> str:
@@ -349,55 +523,32 @@ def fix_hf_endpoint_in_url(url: str, endpoint: Optional[str]) -> str:
349
523
  return url
350
524
 
351
525
 
352
- def hf_raise_for_status(response: Response, endpoint_name: Optional[str] = None) -> None:
526
+ def hf_raise_for_status(response: httpx.Response, endpoint_name: Optional[str] = None) -> None:
353
527
  """
354
- Internal version of `response.raise_for_status()` that will refine a
355
- potential HTTPError. Raised exception will be an instance of `HfHubHTTPError`.
356
-
357
- This helper is meant to be the unique method to raise_for_status when making a call
358
- to the Hugging Face Hub.
528
+ Internal version of `response.raise_for_status()` that will refine a potential HTTPError.
529
+ Raised exception will be an instance of [`~errors.HfHubHTTPError`].
359
530
 
360
-
361
- Example:
362
- ```py
363
- import requests
364
- from huggingface_hub.utils import get_session, hf_raise_for_status, HfHubHTTPError
365
-
366
- response = get_session().post(...)
367
- try:
368
- hf_raise_for_status(response)
369
- except HfHubHTTPError as e:
370
- print(str(e)) # formatted message
371
- e.request_id, e.server_message # details returned by server
372
-
373
- # Complete the error message with additional information once it's raised
374
- e.append_to_message("\n`create_commit` expects the repository to exist.")
375
- raise
376
- ```
531
+ This helper is meant to be the unique method to raise_for_status when making a call to the Hugging Face Hub.
377
532
 
378
533
  Args:
379
534
  response (`Response`):
380
535
  Response from the server.
381
536
  endpoint_name (`str`, *optional*):
382
- Name of the endpoint that has been called. If provided, the error message
383
- will be more complete.
537
+ Name of the endpoint that has been called. If provided, the error message will be more complete.
384
538
 
385
539
  <Tip warning={true}>
386
540
 
387
541
  Raises when the request has failed:
388
542
 
389
543
  - [`~utils.RepositoryNotFoundError`]
390
- If the repository to download from cannot be found. This may be because it
391
- doesn't exist, because `repo_type` is not set correctly, or because the repo
392
- is `private` and you do not have access.
544
+ If the repository to download from cannot be found. This may be because it doesn't exist, because `repo_type`
545
+ is not set correctly, or because the repo is `private` and you do not have access.
393
546
  - [`~utils.GatedRepoError`]
394
- If the repository exists but is gated and the user is not on the authorized
395
- list.
547
+ If the repository exists but is gated and the user is not on the authorized list.
396
548
  - [`~utils.RevisionNotFoundError`]
397
549
  If the repository exists but the revision couldn't be find.
398
- - [`~utils.EntryNotFoundError`]
399
- If the repository exists but the entry (e.g. the requested file) couldn't be
400
- find.
550
+ - [`~utils.RemoteEntryNotFoundError`]
551
+ If the repository exists but the entry (e.g. the requested file) couldn't be find.
401
552
  - [`~utils.BadRequestError`]
402
553
  If request failed with a HTTP 400 BadRequest error.
403
554
  - [`~utils.HfHubHTTPError`]
@@ -407,7 +558,10 @@ def hf_raise_for_status(response: Response, endpoint_name: Optional[str] = None)
407
558
  """
408
559
  try:
409
560
  response.raise_for_status()
410
- except HTTPError as e:
561
+ except httpx.HTTPStatusError as e:
562
+ if response.status_code // 100 == 3:
563
+ return # Do not raise on redirects to stay consistent with `requests`
564
+
411
565
  error_code = response.headers.get("X-Error-Code")
412
566
  error_message = response.headers.get("X-Error-Message")
413
567
 
@@ -417,7 +571,7 @@ def hf_raise_for_status(response: Response, endpoint_name: Optional[str] = None)
417
571
 
418
572
  elif error_code == "EntryNotFound":
419
573
  message = f"{response.status_code} Client Error." + "\n\n" + f"Entry Not Found for url: {response.url}."
420
- raise _format(EntryNotFoundError, message, response) from e
574
+ raise _format(RemoteEntryNotFoundError, message, response) from e
421
575
 
422
576
  elif error_code == "GatedRepo":
423
577
  message = (
@@ -440,7 +594,7 @@ def hf_raise_for_status(response: Response, endpoint_name: Optional[str] = None)
440
594
  and error_message != "Invalid credentials in Authorization header"
441
595
  and response.request is not None
442
596
  and response.request.url is not None
443
- and REPO_API_REGEX.search(response.request.url) is not None
597
+ and REPO_API_REGEX.search(str(response.request.url)) is not None
444
598
  ):
445
599
  # 401 is misleading as it is returned for:
446
600
  # - private and gated repos if user is not authenticated
@@ -482,7 +636,7 @@ def hf_raise_for_status(response: Response, endpoint_name: Optional[str] = None)
482
636
  raise _format(HfHubHTTPError, str(e), response) from e
483
637
 
484
638
 
485
- def _format(error_type: Type[HfHubHTTPError], custom_message: str, response: Response) -> HfHubHTTPError:
639
+ def _format(error_type: type[HfHubHTTPError], custom_message: str, response: httpx.Response) -> HfHubHTTPError:
486
640
  server_errors = []
487
641
 
488
642
  # Retrieve server error from header
@@ -493,7 +647,11 @@ def _format(error_type: Type[HfHubHTTPError], custom_message: str, response: Res
493
647
  # Retrieve server error from body
494
648
  try:
495
649
  # Case errors are returned in a JSON format
496
- data = response.json()
650
+ try:
651
+ data = response.json()
652
+ except httpx.ResponseNotRead:
653
+ response.read() # In case of streaming response, we need to read the response first
654
+ data = response.json()
497
655
 
498
656
  error = data.get("error")
499
657
  if error is not None:
@@ -511,7 +669,7 @@ def _format(error_type: Type[HfHubHTTPError], custom_message: str, response: Res
511
669
  if "message" in error:
512
670
  server_errors.append(error["message"])
513
671
 
514
- except JSONDecodeError:
672
+ except json.JSONDecodeError:
515
673
  # If content is not JSON and not HTML, append the text
516
674
  content_type = response.headers.get("Content-Type", "")
517
675
  if response.text and "html" not in content_type.lower():
@@ -556,15 +714,15 @@ def _format(error_type: Type[HfHubHTTPError], custom_message: str, response: Res
556
714
  return error_type(final_error_message.strip(), response=response, server_message=server_message or None)
557
715
 
558
716
 
559
- def _curlify(request: requests.PreparedRequest) -> str:
560
- """Convert a `requests.PreparedRequest` into a curl command (str).
717
+ def _curlify(request: httpx.Request) -> str:
718
+ """Convert a `httpx.Request` into a curl command (str).
561
719
 
562
720
  Used for debug purposes only.
563
721
 
564
722
  Implementation vendored from https://github.com/ofw/curlify/blob/master/curlify.py.
565
723
  MIT License Copyright (c) 2016 Egor.
566
724
  """
567
- parts: List[Tuple[Any, Any]] = [
725
+ parts: list[tuple[Any, Any]] = [
568
726
  ("curl", None),
569
727
  ("-X", request.method),
570
728
  ]
@@ -572,16 +730,16 @@ def _curlify(request: requests.PreparedRequest) -> str:
572
730
  for k, v in sorted(request.headers.items()):
573
731
  if k.lower() == "authorization":
574
732
  v = "<TOKEN>" # Hide authorization header, no matter its value (can be Bearer, Key, etc.)
575
- parts += [("-H", "{0}: {1}".format(k, v))]
576
-
577
- if request.body:
578
- body = request.body
579
- if isinstance(body, bytes):
580
- body = body.decode("utf-8", errors="ignore")
581
- elif hasattr(body, "read"):
582
- body = "<file-like object>" # Don't try to read it to avoid consuming the stream
733
+ parts += [("-H", f"{k}: {v}")]
734
+
735
+ body: Optional[str] = None
736
+ if request.content is not None:
737
+ body = request.content.decode("utf-8", errors="ignore")
583
738
  if len(body) > 1000:
584
- body = body[:1000] + " ... [truncated]"
739
+ body = f"{body[:1000]} ... [truncated]"
740
+ elif request.stream is not None:
741
+ body = "<streaming body>"
742
+ if body is not None:
585
743
  parts += [("-d", body.replace("\n", ""))]
586
744
 
587
745
  parts += [(None, request.url)]