util
Retry
Bases: object
Retry configuration.
Each retry attempt will create a new Retry object with updated values, so they can be safely reused.
Retries can be defined as a default for a pool::
retries = Retry(connect=5, read=2, redirect=5)
http = PoolManager(retries=retries)
response = http.request('GET', 'http://example.com/')
Or per-request (which overrides the default for the pool)::
response = http.request('GET', 'http://example.com/', retries=Retry(10))
Retries can be disabled by passing False
::
response = http.request('GET', 'http://example.com/', retries=False)
Errors will be wrapped in :class:~urllib3.exceptions.MaxRetryError
unless retries are disabled, in which case the causing exception will be raised.
:param int total: Total number of retries to allow. Takes precedence over other counts.
Set to ``None`` to remove this constraint and fall back on other
counts.
Set to ``0`` to fail on the first retry.
Set to ``False`` to disable and imply ``raise_on_redirect=False``.
:param int connect: How many connection-related errors to retry on.
These are errors raised before the request is sent to the remote server,
which we assume has not triggered the server to process the request.
Set to ``0`` to fail on the first retry of this type.
:param int read: How many times to retry on read errors.
These errors are raised after the request was sent to the server, so the
request may have side-effects.
Set to ``0`` to fail on the first retry of this type.
:param int redirect: How many redirects to perform. Limit this to avoid infinite redirect loops.
A redirect is a HTTP response with a status code 301, 302, 303, 307 or
308.
Set to ``0`` to fail on the first retry of this type.
Set to ``False`` to disable and imply ``raise_on_redirect=False``.
:param int status: How many times to retry on bad status codes.
These are retries made on responses, where status code matches
``status_forcelist``.
Set to ``0`` to fail on the first retry of this type.
:param int other: How many times to retry on other errors.
Other errors are errors that are not connect, read, redirect or status errors.
These errors might be raised after the request was sent to the server, so the
request might have side-effects.
Set to ``0`` to fail on the first retry of this type.
If ``total`` is not set, it's a good idea to set this to 0 to account
for unexpected edge cases and avoid infinite retry loops.
:param iterable allowed_methods: Set of uppercased HTTP method verbs that we should retry on.
By default, we only retry on methods which are considered to be
idempotent (multiple requests with the same parameters end with the
same state). See :attr:`Retry.DEFAULT_ALLOWED_METHODS`.
Set to a ``False`` value to retry on any verb.
.. warning::
Previously this parameter was named ``method_whitelist``, that
usage is deprecated in v1.26.0 and will be removed in v2.0.
:param iterable status_forcelist: A set of integer HTTP status codes that we should force a retry on. A retry is initiated if the request method is in allowed_methods
and the response status code is in status_forcelist
.
By default, this is disabled with ``None``.
:param float backoff_factor: A backoff factor to apply between attempts after the second try (most errors are resolved immediately by a second try without a delay). urllib3 will sleep for::
{backoff factor} * (2 ** ({number of total retries} - 1))
seconds. If the backoff_factor is 0.1, then :func:`.sleep` will sleep
for [0.0s, 0.2s, 0.4s, ...] between retries. It will never be longer
than :attr:`Retry.BACKOFF_MAX`.
By default, backoff is disabled (set to 0).
:param bool raise_on_redirect: Whether, if the number of redirects is exhausted, to raise a MaxRetryError, or to return a response with a response code in the 3xx range.
:param bool raise_on_status: Similar meaning to raise_on_redirect
: whether we should raise an exception, or return a response, if status falls in status_forcelist
range and retries have been exhausted.
:param tuple history: The history of the request encountered during each call to :meth:~Retry.increment
. The list is in the order the requests occurred. Each list item is of class :class:RequestHistory
.
:param bool respect_retry_after_header: Whether to respect Retry-After header on status codes defined as :attr:Retry.RETRY_AFTER_STATUS_CODES
or not.
:param iterable remove_headers_on_redirect: Sequence of headers to remove from the request when a response indicating a redirect is returned before firing off the redirected request.
Source code in client/ayon_fusion/vendor/urllib3/util/retry.py
73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 |
|
from_int(retries, redirect=True, default=None)
classmethod
Backwards-compatibility for the old retries format.
Source code in client/ayon_fusion/vendor/urllib3/util/retry.py
322 323 324 325 326 327 328 329 330 331 332 333 334 |
|
get_backoff_time()
Formula for computing the current backoff
:rtype: float
Source code in client/ayon_fusion/vendor/urllib3/util/retry.py
336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 |
|
get_retry_after(response)
Get the value of Retry-After in seconds.
Source code in client/ayon_fusion/vendor/urllib3/util/retry.py
376 377 378 379 380 381 382 383 384 |
|
increment(method=None, url=None, response=None, error=None, _pool=None, _stacktrace=None)
Return a new Retry object with incremented retry counters.
:param response: A response object, or None, if the server did not return a response. :type response: :class:~urllib3.response.HTTPResponse
:param Exception error: An error encountered during the request, or None if the response was received successfully.
:return: A new Retry
object.
Source code in client/ayon_fusion/vendor/urllib3/util/retry.py
486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 |
|
is_exhausted()
Are we out of retries?
Source code in client/ayon_fusion/vendor/urllib3/util/retry.py
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 |
|
is_retry(method, status_code, has_retry_after=False)
Is this method/status code retryable? (Based on allowlists and control variables such as the number of total retries to allow, whether to respect the Retry-After header, whether this header is present, and whether the returned status code is on the list of status codes to be retried upon on the presence of the aforementioned header)
Source code in client/ayon_fusion/vendor/urllib3/util/retry.py
450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 |
|
sleep(response=None)
Sleep between retry attempts.
This method will respect a server's Retry-After
response header and sleep the duration of the time requested. If that is not present, it will use an exponential backoff. By default, the backoff factor is 0 and this method will return immediately.
Source code in client/ayon_fusion/vendor/urllib3/util/retry.py
400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 |
|
Timeout
Bases: object
Timeout configuration.
Timeouts can be defined as a default for a pool:
.. code-block:: python
timeout = Timeout(connect=2.0, read=7.0) http = PoolManager(timeout=timeout) response = http.request('GET', 'http://example.com/')
Or per-request (which overrides the default for the pool):
.. code-block:: python
response = http.request('GET', 'http://example.com/', timeout=Timeout(10))
Timeouts can be disabled by setting all the parameters to None
:
.. code-block:: python
no_timeout = Timeout(connect=None, read=None) response = http.request('GET', 'http://example.com/, timeout=no_timeout)
:param total: This combines the connect and read timeouts into one; the read timeout will be set to the time leftover from the connect attempt. In the event that both a connect timeout and a total are specified, or a read timeout and a total are specified, the shorter timeout will be applied.
Defaults to None.
:type total: int, float, or None
:param connect: The maximum amount of time (in seconds) to wait for a connection attempt to a server to succeed. Omitting the parameter will default the connect timeout to the system default, probably the global default timeout in socket.py <http://hg.python.org/cpython/file/603b4d593758/Lib/socket.py#l535>
_. None will set an infinite timeout for connection attempts.
:type connect: int, float, or None
:param read: The maximum amount of time (in seconds) to wait between consecutive read operations for a response from the server. Omitting the parameter will default the read timeout to the system default, probably the global default timeout in socket.py <http://hg.python.org/cpython/file/603b4d593758/Lib/socket.py#l535>
_. None will set an infinite timeout.
:type read: int, float, or None
.. note::
Many factors can affect the total amount of time for urllib3 to return
an HTTP response.
For example, Python's DNS resolver does not obey the timeout specified
on the socket. Other factors that can affect total request time include
high CPU load, high swap, the program running at a low priority level,
or other behaviors.
In addition, the read and total timeouts only measure the time between
read operations on the socket connecting the client and the server,
not the total amount of time for the request to return a complete
response. For most requests, the timeout is raised because the server
has not sent the first byte in the specified time. This is not always
the case; if a server streams one byte every fifteen seconds, a timeout
of 20 seconds will not trigger, even though the request will take
several minutes to complete.
If your goal is to cut off any request after a set amount of wall clock
time, consider having a second "watcher" thread to cut off a slow
request.
Source code in client/ayon_fusion/vendor/urllib3/util/timeout.py
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 |
|
connect_timeout
property
Get the value to use when setting a connection timeout.
This will be a positive float or integer, the value None (never timeout), or the default system timeout.
:return: Connect timeout. :rtype: int, float, :attr:Timeout.DEFAULT_TIMEOUT
or None
read_timeout
property
Get the value for the read timeout.
This assumes some time has elapsed in the connection timeout and computes the read timeout appropriately.
If self.total is set, the read timeout is dependent on the amount of time taken by the connect timeout. If the connection time has not been established, a :exc:~urllib3.exceptions.TimeoutStateError
will be raised.
:return: Value to use for the read timeout. :rtype: int, float, :attr:Timeout.DEFAULT_TIMEOUT
or None :raises urllib3.exceptions.TimeoutStateError: If :meth:start_connect
has not yet been called on this object.
clone()
Create a copy of the timeout object
Timeout properties are stored per-pool but each request needs a fresh Timeout object to ensure each one has its own start/stop configured.
:return: a copy of the timeout object :rtype: :class:Timeout
Source code in client/ayon_fusion/vendor/urllib3/util/timeout.py
181 182 183 184 185 186 187 188 189 190 191 192 193 |
|
from_float(timeout)
classmethod
Create a new Timeout from a legacy timeout value.
The timeout value used by httplib.py sets the same timeout on the connect(), and recv() socket requests. This creates a :class:Timeout
object that sets the individual timeouts to the timeout
value passed to this function.
:param timeout: The legacy timeout value. :type timeout: integer, float, sentinel default object, or None :return: Timeout object :rtype: :class:Timeout
Source code in client/ayon_fusion/vendor/urllib3/util/timeout.py
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 |
|
get_connect_duration()
Gets the time elapsed since the call to :meth:start_connect
.
:return: Elapsed time in seconds. :rtype: float :raises urllib3.exceptions.TimeoutStateError: if you attempt to get duration for a timer that hasn't been started.
Source code in client/ayon_fusion/vendor/urllib3/util/timeout.py
206 207 208 209 210 211 212 213 214 215 216 217 218 |
|
start_connect()
Start the timeout clock, used during a connect() attempt
:raises urllib3.exceptions.TimeoutStateError: if you attempt to start a timer that has been started already.
Source code in client/ayon_fusion/vendor/urllib3/util/timeout.py
195 196 197 198 199 200 201 202 203 204 |
|
Url
Bases: namedtuple('Url', url_attrs)
Data structure for representing an HTTP URL. Used as a return value for :func:parse_url
. Both the scheme and host are normalized as they are both case-insensitive according to RFC 3986.
Source code in client/ayon_fusion/vendor/urllib3/util/url.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 |
|
hostname
property
For backwards-compatibility with urlparse. We're nice like that.
netloc
property
Network location including host and port
request_uri
property
Absolute path including the query string.
url
property
Convert self into a url
This function should more or less round-trip with :func:.parse_url
. The returned url may not be exactly the same as the url inputted to :func:.parse_url
, but it should be equivalent by the RFC (e.g., urls with a blank port will have : removed).
Example: ::
>>> U = parse_url('http://google.com/mail/')
>>> U.url
'http://google.com/mail/'
>>> Url('http', 'username:password', 'host.com', 80,
... '/path', 'query', 'fragment').url
'http://username:password@host.com:80/path?query#fragment'
assert_fingerprint(cert, fingerprint)
Checks if given fingerprint matches the supplied certificate.
:param cert: Certificate as bytes object. :param fingerprint: Fingerprint as string of hexdigits, can be interspersed by colons.
Source code in client/ayon_fusion/vendor/urllib3/util/ssl_.py
182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 |
|
get_host(url)
Deprecated. Use :func:parse_url
instead.
Source code in client/ayon_fusion/vendor/urllib3/util/url.py
427 428 429 430 431 432 |
|
is_connection_dropped(conn)
Returns True if the connection is dropped and should be closed.
:param conn: :class:http.client.HTTPConnection
object.
Note: For platforms like AppEngine, this will always return False
to let the platform handle connection recycling transparently for us.
Source code in client/ayon_fusion/vendor/urllib3/util/connection.py
12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 |
|
is_fp_closed(obj)
Checks whether a given file-like object is closed.
:param obj: The file-like object to check.
Source code in client/ayon_fusion/vendor/urllib3/util/response.py
9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 |
|
make_headers(keep_alive=None, accept_encoding=None, user_agent=None, basic_auth=None, proxy_basic_auth=None, disable_cache=None)
Shortcuts for generating request headers.
:param keep_alive: If True
, adds 'connection: keep-alive' header.
:param accept_encoding: Can be a boolean, list, or string. True
translates to 'gzip,deflate'. List will get joined by comma. String will be used as provided.
:param user_agent: String representing the user-agent you want, such as "python-urllib3/0.6"
:param basic_auth: Colon-separated username:password string for 'authorization: basic ...' auth header.
:param proxy_basic_auth: Colon-separated username:password string for 'proxy-authorization: basic ...' auth header.
:param disable_cache: If True
, adds 'cache-control: no-cache' header.
Example::
>>> make_headers(keep_alive=True, user_agent="Batman/1.0")
{'connection': 'keep-alive', 'user-agent': 'Batman/1.0'}
>>> make_headers(accept_encoding=True)
{'accept-encoding': 'gzip,deflate'}
Source code in client/ayon_fusion/vendor/urllib3/util/request.py
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
|
parse_url(url)
Given a url, return a parsed :class:.Url
namedtuple. Best-effort is performed to parse incomplete urls. Fields not provided will be None. This parser is RFC 3986 compliant.
The parser logic and helper functions are based heavily on work done in the rfc3986
module.
:param str url: URL to parse into a :class:.Url
namedtuple.
Partly backwards-compatible with :mod:urlparse
.
Example::
>>> parse_url('http://google.com/mail/')
Url(scheme='http', host='google.com', port=None, path='/mail/', ...)
>>> parse_url('google.com:80')
Url(scheme=None, host='google.com', port=80, path=None, ...)
>>> parse_url('/foo?bar')
Url(scheme=None, host=None, port=None, path='/foo', query='bar', ...)
Source code in client/ayon_fusion/vendor/urllib3/util/url.py
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 |
|
resolve_cert_reqs(candidate)
Resolves the argument to a numeric constant, which can be passed to the wrap_socket function/method from the ssl module. Defaults to :data:ssl.CERT_REQUIRED
. If given a string it is assumed to be the name of the constant in the :mod:ssl
module or its abbreviation. (So you can specify REQUIRED
instead of CERT_REQUIRED
. If it's neither None
nor a string we assume it is already the numeric constant which can directly be passed to wrap_socket.
Source code in client/ayon_fusion/vendor/urllib3/util/ssl_.py
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 |
|
resolve_ssl_version(candidate)
like resolve_cert_reqs
Source code in client/ayon_fusion/vendor/urllib3/util/ssl_.py
234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
|
split_first(s, delims)
.. deprecated:: 1.25
Given a string and an iterable of delimiters, split on the first found delimiter. Return two split parts and the matched delimiter.
If not found, then the first part is the full input string.
Example::
>>> split_first('foo/bar?baz', '?/=')
('foo', 'bar?baz', '/')
>>> split_first('foo/bar?baz', '123')
('foo/bar?baz', '', None)
Scales linearly with number of delims. Not ideal for large number of delims.
Source code in client/ayon_fusion/vendor/urllib3/util/url.py
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 |
|
ssl_wrap_socket(sock, keyfile=None, certfile=None, cert_reqs=None, ca_certs=None, server_hostname=None, ssl_version=None, ciphers=None, ssl_context=None, ca_cert_dir=None, key_password=None, ca_cert_data=None, tls_in_tls=False)
All arguments except for server_hostname, ssl_context, and ca_cert_dir have the same meaning as they do when using :func:ssl.wrap_socket
.
:param server_hostname: When SNI is supported, the expected hostname of the certificate :param ssl_context: A pre-made :class:SSLContext
object. If none is provided, one will be created using :func:create_urllib3_context
. :param ciphers: A string of ciphers we wish the client to support. :param ca_cert_dir: A directory containing CA certificates in multiple separate files, as supported by OpenSSL's -CApath flag or the capath argument to SSLContext.load_verify_locations(). :param key_password: Optional password if the keyfile is encrypted. :param ca_cert_data: Optional string containing CA certificates in PEM format suitable for passing as the cadata parameter to SSLContext.load_verify_locations() :param tls_in_tls: Use SSLTransport to wrap the existing socket.
Source code in client/ayon_fusion/vendor/urllib3/util/ssl_.py
355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 |
|
wait_for_read(sock, timeout=None)
Waits for reading to be available on a given socket. Returns True if the socket is readable, or False if the timeout expired.
Source code in client/ayon_fusion/vendor/urllib3/util/wait.py
142 143 144 145 146 |
|
wait_for_write(sock, timeout=None)
Waits for writing to be available on a given socket. Returns True if the socket is readable, or False if the timeout expired.
Source code in client/ayon_fusion/vendor/urllib3/util/wait.py
149 150 151 152 153 |
|