urllib3
Python HTTP library with thread-safe connection pooling, file post support, user friendly, and more
HTTPConnectionPool
Bases: ConnectionPool
, RequestMethods
Thread-safe connection pool for one host.
:param host: Host used for this HTTP Connection (e.g. "localhost"), passed into :class:http.client.HTTPConnection
.
:param port: Port used for this HTTP Connection (None is equivalent to 80), passed into :class:http.client.HTTPConnection
.
:param strict: Causes BadStatusLine to be raised if the status line can't be parsed as a valid HTTP/1.0 or 1.1 status line, passed into :class:http.client.HTTPConnection
.
.. note::
Only works in Python 2. This parameter is ignored in Python 3.
:param timeout: Socket timeout in seconds for each individual connection. This can be a float or integer, which sets the timeout for the HTTP request, or an instance of :class:urllib3.util.Timeout
which gives you more fine-grained control over request timeouts. After the constructor has been parsed, this is always a urllib3.util.Timeout
object.
:param maxsize: Number of connections to save that can be reused. More than 1 is useful in multithreaded situations. If block
is set to False, more connections will be created but they will not be saved once they've been used.
:param block: If set to True, no more than maxsize
connections will be used at a time. When no free connections are available, the call will block until a connection has been released. This is a useful side effect for particular multithreaded situations where one does not want to use more than maxsize connections per host to prevent flooding.
:param headers: Headers to include with all requests, unless other headers are given explicitly.
:param retries: Retry configuration to use by default with requests in this pool.
:param _proxy: Parsed proxy URL, should not be used directly, instead, see :class:urllib3.ProxyManager
:param _proxy_headers: A dictionary with proxy headers, should not be used directly, instead, see :class:urllib3.ProxyManager
:param **conn_kw: Additional parameters are used to create fresh :class:urllib3.connection.HTTPConnection
, :class:urllib3.connection.HTTPSConnection
instances.
Source code in client/ayon_fusion/vendor/urllib3/connectionpool.py
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 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 |
|
close()
Close all pooled connections and disable the pool.
Source code in client/ayon_fusion/vendor/urllib3/connectionpool.py
479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
|
is_same_host(url)
Check if the given url
is a member of the same host as this connection pool.
Source code in client/ayon_fusion/vendor/urllib3/connectionpool.py
497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 |
|
urlopen(method, url, body=None, headers=None, retries=None, redirect=True, assert_same_host=True, timeout=_Default, pool_timeout=None, release_conn=None, chunked=False, body_pos=None, **response_kw)
Get a connection from the pool and perform an HTTP request. This is the lowest level call for making a request, so you'll need to specify all the raw details.
.. note::
More commonly, it's appropriate to use a convenience method provided by :class:.RequestMethods
, such as :meth:request
.
.. note::
release_conn
will only behave as expected if preload_content=False
because we want to make preload_content=False
the default behaviour someday soon without breaking backwards compatibility.
:param method: HTTP request method (such as GET, POST, PUT, etc.)
:param url: The URL to perform the request on.
:param body: Data to send in the request body, either :class:str
, :class:bytes
, an iterable of :class:str
/:class:bytes
, or a file-like object.
:param headers: Dictionary of custom headers to send, such as User-Agent, If-None-Match, etc. If None, pool headers are used. If provided, these headers completely replace any pool-specific headers.
:param retries: Configure the number of retries to allow before raising a :class:~urllib3.exceptions.MaxRetryError
exception.
Pass ``None`` to retry until you receive a response. Pass a
:class:`~urllib3.util.retry.Retry` object for fine-grained control
over different types of retries.
Pass an integer number to retry connection errors that many times,
but no other types of errors. Pass zero to never retry.
If ``False``, then retries are disabled and any exception is raised
immediately. Also, instead of raising a MaxRetryError on redirects,
the redirect response will be returned.
:type retries: :class:~urllib3.util.retry.Retry
, False, or an int.
:param redirect: If True, automatically handle redirects (status codes 301, 302, 303, 307, 308). Each redirect counts as a retry. Disabling retries will disable redirect, too.
:param assert_same_host: If True
, will make sure that the host of the pool requests is consistent else will raise HostChangedError. When False
, you can use the pool on an HTTP proxy and request foreign hosts.
:param timeout: If specified, overrides the default timeout for this one request. It may be a float (in seconds) or an instance of :class:urllib3.util.Timeout
.
:param pool_timeout: If set and the pool is set to block=True, then this method will block for pool_timeout
seconds and raise EmptyPoolError if no connection is available within the time period.
:param release_conn: If False, then the urlopen call will not release the connection back into the pool once a response is received (but will release if you read the entire contents of the response such as when preload_content=True
). This is useful if you're not preloading the response's content immediately. You will need to call r.release_conn()
on the response r
to return the connection back into the pool. If None, it takes the value of response_kw.get('preload_content', True)
.
:param chunked: If True, urllib3 will send the body using chunked transfer encoding. Otherwise, urllib3 will send the body using the standard content-length form. Defaults to False.
:param int body_pos: Position to seek to in file-like body in the event of a retry or redirect. Typically this won't need to be set because urllib3 will auto-populate the value when needed.
:param **response_kw: Additional parameters are passed to :meth:urllib3.response.HTTPResponse.from_httplib
Source code in client/ayon_fusion/vendor/urllib3/connectionpool.py
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 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 |
|
HTTPResponse
Bases: IOBase
HTTP Response container.
Backwards-compatible with :class:http.client.HTTPResponse
but the response body
is loaded and decoded on-demand when the data
property is accessed. This class is also compatible with the Python standard library's :mod:io
module, and can hence be treated as a readable object in the context of that framework.
Extra parameters for behaviour not present in :class:http.client.HTTPResponse
:
:param preload_content: If True, the response's body will be preloaded during construction.
:param decode_content: If True, will attempt to decode the body based on the 'content-encoding' header.
:param original_response: When this HTTPResponse wrapper is generated from an :class:http.client.HTTPResponse
object, it's convenient to include the original for debug purposes. It's otherwise unused.
:param retries: The retries contains the last :class:~urllib3.util.retry.Retry
that was used during the request.
:param enforce_content_length: Enforce content length checking. Body returned by server must match value of Content-Length header, if present. Otherwise, raise error.
Source code in client/ayon_fusion/vendor/urllib3/response.py
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 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 |
|
drain_conn()
Read and discard any remaining HTTP response data in the response connection.
Unread data in the HTTPResponse connection blocks the connection from being released back to the pool.
Source code in client/ayon_fusion/vendor/urllib3/response.py
282 283 284 285 286 287 288 289 290 291 |
|
from_httplib(ResponseCls, r, **response_kw)
classmethod
Given an :class:http.client.HTTPResponse
instance r
, return a corresponding :class:urllib3.response.HTTPResponse
object.
Remaining parameters are passed to the HTTPResponse constructor, along with original_response=r
.
Source code in client/ayon_fusion/vendor/urllib3/response.py
581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 |
|
get_redirect_location()
Should we redirect and where to?
:returns: Truthy redirect location string if we got a redirect status code and valid location. None
if redirect status and no location. False
if not a redirect status code.
Source code in client/ayon_fusion/vendor/urllib3/response.py
262 263 264 265 266 267 268 269 270 271 272 273 |
|
geturl()
Returns the URL that was the source of this response. If the request that generated this response redirected, this method will return the final redirect location.
Source code in client/ayon_fusion/vendor/urllib3/response.py
795 796 797 798 799 800 801 802 803 804 |
|
read(amt=None, decode_content=None, cache_content=False)
Similar to :meth:http.client.HTTPResponse.read
, but with two additional parameters: decode_content
and cache_content
.
:param amt: How much of the content to read. If specified, caching is skipped because it doesn't make sense to cache partial content as the full response.
:param decode_content: If True, will attempt to decode the body based on the 'content-encoding' header.
:param cache_content: If True, will save the returned data such that the same result is returned despite of the state of the underlying file object. This is useful if you want the .data
property to continue working after having .read()
the file object. (Overridden if amt
is set.)
Source code in client/ayon_fusion/vendor/urllib3/response.py
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 |
|
read_chunked(amt=None, decode_content=None)
Similar to :meth:HTTPResponse.read
, but with an additional parameter: decode_content
.
:param amt: How much of the content to read. If specified, caching is skipped because it doesn't make sense to cache partial content as the full response.
:param decode_content: If True, will attempt to decode the body based on the 'content-encoding' header.
Source code in client/ayon_fusion/vendor/urllib3/response.py
725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 |
|
stream(amt=2 ** 16, decode_content=None)
A generator wrapper for the read() method. A call will block until amt
bytes have been read from the connection or until the connection is closed.
:param amt: How much of the content to read. The generator will return up to much data per iteration, but may return less. This is particularly likely when using compressed data. However, the empty string will never be returned.
:param decode_content: If True, will attempt to decode the body based on the 'content-encoding' header.
Source code in client/ayon_fusion/vendor/urllib3/response.py
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 |
|
supports_chunked_reads()
Checks if the underlying file-like object looks like a :class:http.client.HTTPResponse
object. We do this by testing for the fp attribute. If it is present we assume it returns raw chunks as processed by read_chunked().
Source code in client/ayon_fusion/vendor/urllib3/response.py
680 681 682 683 684 685 686 687 |
|
tell()
Obtain the number of bytes pulled over the wire so far. May differ from the amount of content returned by :meth:urllib3.response.HTTPResponse.read
if bytes are encoded on the wire (e.g, compressed).
Source code in client/ayon_fusion/vendor/urllib3/response.py
309 310 311 312 313 314 315 |
|
HTTPSConnectionPool
Bases: HTTPConnectionPool
Same as :class:.HTTPConnectionPool
, but HTTPS.
:class:.HTTPSConnection
uses one of assert_fingerprint
, assert_hostname
and host
in this order to verify connections. If assert_hostname
is False, no verification is done.
The key_file
, cert_file
, cert_reqs
, ca_certs
, ca_cert_dir
, ssl_version
, key_password
are only used if :mod:ssl
is available and are fed into :meth:urllib3.util.ssl_wrap_socket
to upgrade the connection socket into an SSL socket.
Source code in client/ayon_fusion/vendor/urllib3/connectionpool.py
865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 |
|
PoolManager
Bases: RequestMethods
Allows for arbitrary requests while transparently keeping track of necessary connection pools for you.
:param num_pools: Number of connection pools to cache before discarding the least recently used pool.
:param headers: Headers to include with all requests, unless other headers are given explicitly.
:param **connection_pool_kw: Additional parameters are used to create fresh :class:urllib3.connectionpool.ConnectionPool
instances.
Example::
>>> manager = PoolManager(num_pools=2)
>>> r = manager.request('GET', 'http://google.com/')
>>> r = manager.request('GET', 'http://google.com/mail')
>>> r = manager.request('GET', 'http://yahoo.com/')
>>> len(manager.pools)
2
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
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 |
|
clear()
Empty our store of pools and direct them all to close.
This will not affect in-flight connections, but they will not be re-used after completion.
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
215 216 217 218 219 220 221 222 |
|
connection_from_context(request_context)
Get a :class:urllib3.connectionpool.ConnectionPool
based on the request context.
request_context
must at least contain the scheme
key and its value must be a key in key_fn_by_scheme
instance variable.
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
|
connection_from_host(host, port=None, scheme='http', pool_kwargs=None)
Get a :class:urllib3.connectionpool.ConnectionPool
based on the host, port, and scheme.
If port
isn't given, it will be derived from the scheme
using urllib3.connectionpool.port_by_scheme
. If pool_kwargs
is provided, it is merged with the instance's connection_pool_kw
variable and used to create the new connection pool, if one is needed.
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
|
connection_from_pool_key(pool_key, request_context=None)
Get a :class:urllib3.connectionpool.ConnectionPool
based on the provided pool key.
pool_key
should be a namedtuple that only contains immutable objects. At a minimum it must have the scheme
, host
, and port
fields.
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 |
|
connection_from_url(url, pool_kwargs=None)
Similar to :func:urllib3.connectionpool.connection_from_url
.
If pool_kwargs
is not provided and a new pool needs to be constructed, self.connection_pool_kw
is used to initialize the :class:urllib3.connectionpool.ConnectionPool
. If pool_kwargs
is provided, it is used instead. Note that if a new pool does not need to be created for the request, the provided pool_kwargs
are not used.
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 |
|
urlopen(method, url, redirect=True, **kw)
Same as :meth:urllib3.HTTPConnectionPool.urlopen
with custom cross-host redirect logic and only sends the request-uri portion of the url
.
The given url
parameter must be absolute, such that an appropriate :class:urllib3.connectionpool.ConnectionPool
can be chosen for it.
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
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 |
|
ProxyManager
Bases: PoolManager
Behaves just like :class:PoolManager
, but sends all requests through the defined proxy, using the CONNECT method for HTTPS URLs.
:param proxy_url: The URL of the proxy to be used.
:param proxy_headers: A dictionary containing headers that will be sent to the proxy. In case of HTTP they are being sent with each request, while in the HTTPS/CONNECT case they are sent only once. Could be used for proxy authentication.
:param proxy_ssl_context: The proxy SSL context is used to establish the TLS connection to the proxy when using HTTPS proxies.
:param use_forwarding_for_https: (Defaults to False) If set to True will forward requests to the HTTPS proxy to be made on behalf of the client instead of creating a TLS tunnel via the CONNECT method. Enabling this flag means that request and response headers and content will be visible from the HTTPS proxy whereas tunneling keeps request and response headers and content private. IP address, target hostname, SNI, and port are always visible to an HTTPS proxy even when this flag is disabled.
Example
proxy = urllib3.ProxyManager('http://localhost:3128/') r1 = proxy.request('GET', 'http://google.com/') r2 = proxy.request('GET', 'http://httpbin.org/') len(proxy.pools) 1 r3 = proxy.request('GET', 'https://httpbin.org/') r4 = proxy.request('GET', 'https://twitter.com/') len(proxy.pools) 3
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
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 |
|
urlopen(method, url, redirect=True, **kw)
Same as HTTP(S)ConnectionPool.urlopen, url
must be absolute.
Source code in client/ayon_fusion/vendor/urllib3/poolmanager.py
522 523 524 525 526 527 528 529 530 531 532 |
|
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 |
|
add_stderr_logger(level=logging.DEBUG)
Helper for quickly adding a StreamHandler to the logger. Useful for debugging.
Returns the handler after adding it.
Source code in client/ayon_fusion/vendor/urllib3/__init__.py
46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
|
connection_from_url(url, **kw)
Given a url, return an :class:.ConnectionPool
instance of its host.
This is a shortcut for not having to parse out the scheme, host, and port of the url before creating an :class:.ConnectionPool
instance.
:param url: Absolute URL string that must include the scheme. Port is optional.
:param **kw: Passes additional parameters to the constructor of the appropriate :class:.ConnectionPool
. Useful for specifying things like timeout, maxsize, headers, etc.
Example::
>>> conn = connection_from_url('http://google.com/')
>>> r = conn.request('GET', '/')
Source code in client/ayon_fusion/vendor/urllib3/connectionpool.py
1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 |
|
disable_warnings(category=exceptions.HTTPWarning)
Helper for quickly disabling all urllib3 warnings.
Source code in client/ayon_fusion/vendor/urllib3/__init__.py
81 82 83 84 85 |
|
encode_multipart_formdata(fields, boundary=None)
Encode a dictionary of fields
using the multipart/form-data MIME format.
:param fields: Dictionary of fields or list of (key, :class:~urllib3.fields.RequestField
).
:param boundary: If not specified, then a random boundary will be generated using :func:urllib3.filepost.choose_boundary
.
Source code in client/ayon_fusion/vendor/urllib3/filepost.py
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 |
|
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 |
|
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 |
|