U diGd @sUdZddlZddlZddlZddlZddlZddlZddlmZddl m Z ddl m Z m Z mZmZmZmZmZddlZddlmZmZddlmZddlmZdd lmZd d lmZd d lmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%d dlm&Z&d dl'm(Z(d dl)m*Z*d dl+m,Z,e&-e.Z/dZ0dZ1dZ2ej3dej4dZ5GdddeZ6GdddeZ7ej8dddZ9e gej8fZ:e9a;e:eddd$d%Z?ee@e@ej8d&d'd(ZAd)d d*ejBejCejDjEfd+d,e,eFe@eGeGeeeHeeeHd-ffee@ee@d-ffed.d/d0ZIeFeeFeFd1d2d3ZJdAeeeFdd4d5d6ZKee#eFee#d7d8d9ZLejeFd:d;d<ZMe3d=ejNZOeeFe@eeFd>d?d@ZPdS)Bz>Contains utilities to handle HTTP requests in Huggingface Hub.N) lru_cache)quote)AnyCallableListOptionalTupleTypeUnion) HTTPErrorResponse) HTTPAdapter)PreparedRequest)OfflineModeIsEnabled) constants)BadRequestErrorDisabledRepoErrorEntryNotFoundErrorGatedRepoErrorHfHubHTTPErrorRepositoryNotFoundErrorRevisionNotFoundError)logging)JSONDecodeError) SliceFileObj) HTTP_METHOD_TX-Amzn-Trace-Idz x-request-idz x-amz-cf-ida  # staging or production endpoint ^https://[^/]+ ( # on /api/repo_type/repo_id /api/(models|datasets|spaces)/(.+) | # or /repo_id/resolve/revision/... /(.+)/resolve/(.+) ) )flagscs4eZdZdZfddZeedfdd ZZS)UniqueRequestIdAdapterrc stj|f|t|jkr8|jtp0tt|jt<t t|jdddk}t d|jtd|j d|j d|d dS) N authorizationrzRequest :  z (authenticated: ))super add_headersX_AMZN_TRACE_IDheadersget X_REQUEST_IDstruuidZuuid4lenloggerdebugmethodurl)selfrequestkwargsZ has_token __class__?/tmp/pip-unpacked-wheel-ohruig0i/huggingface_hub/utils/_http.pyr'Ns &z"UniqueRequestIdAdapter.add_headersr4returnc stjrtdt|ztj|f||WStjk r}z0|j t }|dk rn|j d|df|_ W5d}~XYnXdS)zSCatch any RequestException to append request id to the error message for debugging.zSend: Nz (Request ID: r%) rZHF_DEBUGr/r0_curlifyr&sendrequestsRequestExceptionr)r*r(args)r3r4r@r5e request_idr6r8r9r=[s zUniqueRequestIdAdapter.send) __name__ __module__ __qualname__r(r'rr r= __classcell__r8r8r6r9r Ks r c@seZdZeedddZdS)OfflineAdapterr:cOstd|jddS)Nz Cannot reach za: offline mode is enabled. To disable it, please unset the `HF_HUB_OFFLINE` environment variable.)rr2)r3r4r@r5r8r8r9r=js zOfflineAdapter.sendN)rCrDrErr r=r8r8r8r9rGisrG)r;cCsLt}tjr,|dt|dtn|dt|dt|S)Nzhttp://zhttps://)r>SessionrZHF_HUB_OFFLINEmountrGr )sessionr8r8r9_default_backend_factorypsrK_GLOBAL_BACKEND_FACTORY)backend_factoryr;cCs|atdS)a Configure the HTTP backend by providing a `backend_factory`. Any HTTP calls made by `huggingface_hub` will use a Session object instantiated by this factory. This can be useful if you are running your scripts in a specific environment requiring custom configuration (e.g. custom proxy or certifications). Use [`get_session`] to get a configured Session. Since `requests.Session` is not guaranteed to be thread-safe, `huggingface_hub` creates 1 Session instance per thread. They are all instantiated using the same `backend_factory` set in [`configure_http_backend`]. A LRU cache is used to cache the created sessions (and connections) between calls. Max size is 128 to avoid memory leaks if thousands of threads are spawned. See [this issue](https://github.com/psf/requests/issues/2766) to know more about thread-safety in `requests`. Example: ```py import requests from huggingface_hub import configure_http_backend, get_session # Create a factory function that returns a Session with configured proxies def backend_factory() -> requests.Session: session = requests.Session() session.proxies = {"http": "http://10.10.1.10:3128", "https": "https://10.10.1.11:1080"} return session # Set it as the default session factory configure_http_backend(backend_factory=backend_factory) # In practice, this is mostly done internally in `huggingface_hub` session = get_session() ``` N)rLreset_sessions)rMr8r8r9configure_http_backends rOcCstttdS)a Get a `requests.Session` object, using the session factory from the user. Use [`get_session`] to get a configured Session. Since `requests.Session` is not guaranteed to be thread-safe, `huggingface_hub` creates 1 Session instance per thread. They are all instantiated using the same `backend_factory` set in [`configure_http_backend`]. A LRU cache is used to cache the created sessions (and connections) between calls. Max size is 128 to avoid memory leaks if thousands of threads are spawned. See [this issue](https://github.com/psf/requests/issues/2766) to know more about thread-safety in `requests`. Example: ```py import requests from huggingface_hub import configure_http_backend, get_session # Create a factory function that returns a Session with configured proxies def backend_factory() -> requests.Session: session = requests.Session() session.proxies = {"http": "http://10.10.1.10:3128", "https": "https://10.10.1.11:1080"} return session # Set it as the default session factory configure_http_backend(backend_factory=backend_factory) # In practice, this is mostly done internally in `huggingface_hub` session = get_session() ```  process_id thread_id)_get_session_from_cacheosgetpid threading get_identr8r8r8r9 get_sessionsrXcCs tdS)zReset the cache of sessions. Mostly used internally when sessions are reconfigured or an SSLError is raised. See [`configure_http_backend`] for more details. N)rS cache_clearr8r8r8r9rNsrN)rQrRr;cCstS)z Create a new session per thread using global factory. Using LRU cache (maxsize 128) to avoid memory leaks when using thousands of threads. Cache is cleared when `configure_http_backend` is called. )rLrPr8r8r9rSsrS)iiii) max_retriesbase_wait_time max_wait_timeretry_on_exceptionsretry_on_status_codes.)r1r2r\r]r^r_r`r;c Ksvt|tr|f}t|tr |f}d}|} d} d|krTt|dtjtfrT|d} t} |d7}zt| dk rz|d| | j f||d|} | j |kr| WSt d| j d|d|||kr| | WSWnb|k r8} zBt d | d |d|t| tjrt||kr(| W5d} ~ XYnXt d | d |d |dt| t|| d} qZdS)a7 Wrapper around requests to retry calls on an endpoint, with exponential backoff. Endpoint call is retried on exceptions (ex: connection timeout, proxy error,...) and/or on specific status codes (ex: service unavailable). If the call failed more than `max_retries`, the exception is thrown or `raise_for_status` is called on the response object. Re-implement mechanisms from the `backoff` library to avoid adding an external dependencies to `hugging_face_hub`. See https://github.com/litl/backoff. Args: method (`Literal["GET", "OPTIONS", "HEAD", "POST", "PUT", "PATCH", "DELETE"]`): HTTP method to perform. url (`str`): The URL of the resource to fetch. max_retries (`int`, *optional*, defaults to `5`): Maximum number of retries, defaults to 5 (no retries). base_wait_time (`float`, *optional*, defaults to `1`): Duration (in seconds) to wait before retrying the first time. Wait time between retries then grows exponentially, capped by `max_wait_time`. max_wait_time (`float`, *optional*, defaults to `8`): Maximum duration (in seconds) to wait before retrying. retry_on_exceptions (`Type[Exception]` or `Tuple[Type[Exception]]`, *optional*): Define which exceptions must be caught to retry the request. Can be a single type or a tuple of types. By default, retry on `requests.Timeout`, `requests.ConnectionError` and `requests.exceptions.ChunkedEncodingError`. retry_on_status_codes (`int` or `Tuple[int]`, *optional*, defaults to `(500, 502, 503, 504)`): Define on which status codes the request must be retried. By default, 5xx errors are retried. **kwargs (`dict`, *optional*): kwargs to pass to `requests.request`. Example: ``` >>> from huggingface_hub.utils import http_backoff # Same usage as "requests.request". >>> response = http_backoff("GET", "https://www.google.com") >>> response.raise_for_status() # If you expect a Gateway Timeout from time to time >>> http_backoff("PUT", upload_url, data=data, retry_on_status_codes=504) >>> response.raise_for_status() ``` > [!WARNING] > When using `requests` it is possible to stream data by passing an iterator to the > `data` argument. On http backoff this is a problem as the iterator is not reset > after a failed call. This issue is mitigated for file objects or any IO streams > by saving the initial position of the cursor (with `data.tell()`) and resetting the > cursor between each call (with `data.seek()`). For arbitrary iterators, http backoff > will fail. If this is a hard constraint for you, please let us know by opening an > issue on [Github](https://github.com/huggingface/huggingface_hub). rNdatar)r1r2z HTTP Error z thrown while requesting r$'z' thrown while requesting z Retrying in z s [Retry /z].r) isinstancetypeintioIOBasertellrXseekr4 status_coder/warningraise_for_statusr>ConnectionErrorrNtimesleepmin)r1r2r\r]r^r_r`r5Znb_triesZ sleep_timeZio_obj_initial_posrJresponseerrr8r8r9 http_backoffs<D       rt)r2endpointr;cCsD|r|dntj}|tjtjfkr@|tj|}|tj|}|S)zReplace the default endpoint in a URL by a custom one. This is useful when using a proxy and the Hugging Face Hub returns a URL with the default endpoint. rc)rstriprZENDPOINTZ_HF_DEFAULT_ENDPOINTZ_HF_DEFAULT_STAGING_ENDPOINTreplace)r2rur8r8r9fix_hf_endpoint_in_urlPs rx)rr endpoint_namer;c Csz|Wnxtk r}zV|jd}|jd}|dkrt|jddd|jd}tt|||n|dkr|jddd |jd}tt|||n|d kr|jddd |jd}tt |||n|d kr&|jddd |jddd }tt |||n>|dkst|jdkr|dkr|j dk r|j jdk rt |j jdk r|jddd|jdd}tt|||n|jdkr|dk rd|dnd}tt|||n|jdkrd|jd|dd|jdd}tt|||nF|jdkrd|j jd}|d|d |jd!d}tt|||ttt|||W5d}~XYnXdS)"a( Internal version of `response.raise_for_status()` that will refine a potential HTTPError. Raised exception will be an instance of `HfHubHTTPError`. This helper is meant to be the unique method to raise_for_status when making a call to the Hugging Face Hub. Example: ```py import requests from huggingface_hub.utils import get_session, hf_raise_for_status, HfHubHTTPError response = get_session().post(...) try: hf_raise_for_status(response) except HfHubHTTPError as e: print(str(e)) # formatted message e.request_id, e.server_message # details returned by server # Complete the error message with additional information once it's raised e.append_to_message(" `create_commit` expects the repository to exist.") raise ``` Args: response (`Response`): Response from the server. endpoint_name (`str`, *optional*): Name of the endpoint that has been called. If provided, the error message will be more complete. > [!WARNING] > Raises when the request has failed: > > - [`~utils.RepositoryNotFoundError`] > If the repository to download from cannot be found. This may be because it > doesn't exist, because `repo_type` is not set correctly, or because the repo > is `private` and you do not have access. > - [`~utils.GatedRepoError`] > If the repository exists but is gated and the user is not on the authorized > list. > - [`~utils.RevisionNotFoundError`] > If the repository exists but the revision couldn't be find. > - [`~utils.EntryNotFoundError`] > If the repository exists but the entry (e.g. the requested file) couldn't be > find. > - [`~utils.BadRequestError`] > If request failed with a HTTP 400 BadRequest error. > - [`~utils.HfHubHTTPError`] > If request failed for a reason not listed above. z X-Error-CodeX-Error-MessageZRevisionNotFoundz Client Error. zRevision Not Found for url: .Z EntryNotFoundzEntry Not Found for url: Z GatedRepoz!Cannot access gated repo for url z$Access to this resource is disabled.z!Cannot access repository for url  Z RepoNotFoundiz+Invalid credentials in Authorization headerNzRepository Not Found for url: z Please make sure you specified the correct `repo_id` and `repo_type`. If you are trying to access a private or gated repo, make sure you are authenticated. For more details, see https://huggingface.co/docs/huggingface_hub/authenticationiz Bad request for z endpoint:z Bad request:iz Forbidden: z Cannot access content at: z2 Make sure your token has the correct permissions.iZRangez. Requested range: z. Content-Range: z Content-Range)rmr r)r*rkr2_formatrrrrr4REPO_API_REGEXsearchrrrr,)rrryrAZ error_code error_messagemessageZ range_headerr8r8r9hf_raise_for_status]s5              r) error_typecustom_messagerrr;cCsg}|jd}|dk r"||zp|}|d}|dk r^t|trT||n |||d}|dk r|D]}d|krt||dqtWn@tk r|jdd}|jrd| kr||jYnXdd |D}tt |}d |} |} | r:| | kr:d |kr.| d | 7} n | d | 7} d} d} t d ftd ftdffD]<\} }|j| }|rXt|} d|d|d} qqX| r| | krd | kr| d }| d|| | |d} n| | 7} || || pddS)Nrzerrorerrorsrz Content-Typer"htmlcSs$g|]}t|rt|qSr8)r,strip).0liner8r8r9 s z_format..r}r{z Request IDz Amzn Trace IDz Amz CF IDz (r#r%)rrserver_message)r)r*appendjsonrdlistextendrtextlowerdictfromkeysjoinr+r( X_AMZ_CF_IDr,indexr)rrrrZ server_errorsZ from_headersrarr content_typerZfinal_error_messagerBZrequest_id_messageheaderlabelvalueZ newline_indexr8r8r9r~s\               r~r:cCsdd|jfg}t|jD].\}}|dkr4d}|dd||fg7}q|jr|j}t|trr|j ddd }nt |d rd }t |d kr|d d d}|d| ddfg7}|d |j fg7}g}|D],\}}|r|t||r|t|qd|S)zConvert a `requests.PreparedRequest` into a curl command (str). Used for debug purposes only. Implementation vendored from https://github.com/ofw/curlify/blob/master/curlify.py. MIT License Copyright (c) 2016 Egor. )ZcurlNz-Xr!zz-Hz{0}: {1}zutf-8ignore)rreadziNz ... [truncated]z-dr}r"r$)r1sortedr)itemsrformatbodyrdbytesdecodehasattrr.rwr2rrr)r4partskvrZ flat_partsr8r8r9r<0s0      r<z%^\s*bytes\s*=\s*(\d*)\s*-\s*(\d*)\s*$)original_range resume_sizer;cCs|sd|dSd|kr(td|dt|}|sFtd|d|\}}|s|sjtd|dt||}d|}|d krtd |d|St|}||}|rt|}d|d|}||krtd |d|Sd|dS) zB Adjust HTTP Range header to account for resume position. zbytes=-,zMultiple ranges detected - z, not supported yet.zInvalid range format - r|zbytes=-rzEmpty new range - ) ValueError RANGE_REGEXmatch RuntimeErrorgroupsrf)rrrstartend new_suffixZ new_rangeZ new_startr8r8r9_adjust_range_header\s2     r)N)Q__doc__rgrTrerVror- functoolsrshlexrtypingrrrrrr r r>r r Zrequests.adaptersr Zrequests.modelsrZhuggingface_hub.errorsrr"rrrrrrrrrrZ_fixesrZ_lfsr_typingrZ get_loggerrCr/r(r+rcompileVERBOSErr rGrHrKZBACKEND_FACTORY_TrL__annotations__rOrXrNrfrSTimeoutrn exceptionsChunkedEncodingErrorr,float Exceptionrtrxrr~r< IGNORECASErrr8r8r8r9s~  $    $        $    { Q)