Interfejs dewelopera¶

Ta część dokumentacji obejmuje wszystkie interfejsy Requests. Tam, gdzie Requests zależy od zewnętrznych bibliotek, dokumentujemy najważniejsze tutaj i oferujemy linki do oryginalnej dokumentacji.

Główny interfejs¶

Cała funkcjonalność Requests jest dostępna w poniższych 7 metodach. Wszystkie zwracają instancję obiektu Response.

requests.request(method, url, **kwargs)¶

Constructs and sends a Request. Returns Response object.

Parametry:

method – method for the new Request object.
url – URL for the new Request object.
params – (optional) Dictionary or bytes to be sent in the query string for the Request.
data – (optional) Dictionary, bytes, or file-like object to send in the body of the Request.
headers – (optional) Dictionary of HTTP Headers to send with the Request.
cookies – (optional) Dict or CookieJar object to send with the Request.
files – (optional) Dictionary of ‘name’: file-like-objects (or {‘name’: (‘filename’, fileobj)}) for multipart encoding upload.
auth – (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth.
timeout – (optional) Float describing the timeout of the request.
allow_redirects – (optional) Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.
proxies – (optional) Dictionary mapping protocol to the URL of the proxy.
verify – (optional) if True, the SSL cert will be verified. A CA_BUNDLE path can also be provided.
stream – (optional) if False, the response content will be immediately downloaded.
cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

Usage:

>>> import requests
>>> req = requests.request('GET', 'http://httpbin.org/get')
<Response [200]>

requests.head(url, **kwargs)¶

Sends a HEAD request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

requests.get(url, **kwargs)¶

Sends a GET request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

requests.post(url, data=None, **kwargs)¶

Sends a POST request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

requests.put(url, data=None, **kwargs)¶

Sends a PUT request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

requests.patch(url, data=None, **kwargs)¶

Sends a PATCH request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

requests.delete(url, **kwargs)¶

Sends a DELETE request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

Klasy niższego poziomu¶

class requests.Request(method=None, url=None, headers=None, files=None, data={}, params={}, auth=None, cookies=None, hooks=None)¶

A user-created Request object.

Used to prepare a PreparedRequest, which is sent to the server.

Parametry:

method – HTTP method to use.
url – URL to send.
headers – dictionary of headers to send.
files – dictionary of {filename: fileobject} files to multipart upload.
data – the body to attach the request. If a dictionary is provided, form-encoding will take place.
params – dictionary of URL parameters to append to the URL.
auth – Auth handler or (user, pass) tuple.
cookies – dictionary or CookieJar of cookies to attach to this request.
hooks – dictionary of callback hooks, for internal usage.

Usage:

>>> import requests
>>> req = requests.Request('GET', 'http://httpbin.org/get')
>>> req.prepare()
<PreparedRequest [GET]>

deregister_hook(event, hook)¶: Deregister a previously registered hook. Returns True if the hook existed, False if not.

prepare()¶: Constructs a PreparedRequest for transmission and returns it.

register_hook(event, hook)¶: Properly register a hook.

class requests.Response¶

The Response object, which contains a server’s response to an HTTP request.

apparent_encoding¶: The apparent encoding, provided by the lovely Charade library (Thanks, Ian!).

content¶: Content of the response, in bytes.

cookies = None¶: A CookieJar of Cookies the server sent back.

elapsed = None¶: The amount of time elapsed between sending the request and the arrival of the response (as a timedelta)

encoding = None¶: Encoding to decode with when accessing r.text.

headers = None¶: Case-insensitive Dictionary of Response Headers. For example, headers['content-encoding'] will return the value of a 'Content-Encoding' response header.

history = None¶: A list of Response objects from the history of the Request. Any redirect responses will end up here. The list is sorted from the oldest to the most recent request.

iter_content(chunk_size=1, decode_unicode=False)¶: Iterates over the response data. When stream=True is set on the request, this avoids reading the content at once into memory for large responses. The chunk size is the number of bytes it should read into memory. This is not necessarily the length of each item returned as decoding can take place.

iter_lines(chunk_size=512, decode_unicode=None)¶: Iterates over the response data, one line at a time. When stream=True is set on the request, this avoids reading the content at once into memory for large responses.

json(**kwargs)¶

Returns the json-encoded content of a response, if any.

Parametry:	**kwargs – Optional arguments that `json.loads` takes.

links¶: Returns the parsed header links of the response, if any.

raise_for_status()¶: Raises stored HTTPError, if one occurred.

raw = None¶: File-like object representation of response (for advanced usage). Requires that ``stream=True` on the request.

status_code = None¶: Integer Code of responded HTTP Status.

text¶

Content of the response, in unicode.

if Response.encoding is None and chardet module is available, encoding will be guessed.

url = None¶: Final URL location of Response.

Sesje żądań¶

class requests.Session¶

A Requests session.

Provides cookie persistience, connection-pooling, and configuration.

Basic Usage:

>>> import requests
>>> s = requests.Session()
>>> s.get('http://httpbin.org/get')
200

auth = None¶: Default Authentication tuple or object to attach to Request.

cert = None¶: SSL certificate default.

close()¶: Closes all adapters and as such the session

delete(url, **kwargs)¶

Sends a DELETE request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get(url, **kwargs)¶

Sends a GET request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get_adapter(url)¶: Returns the appropriate connnection adapter for the given URL.

head(url, **kwargs)¶

Sends a HEAD request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

headers = None¶: A case-insensitive dictionary of headers to be sent on each Request sent from this Session.

hooks = None¶: Event-handling hooks.

max_redirects = None¶: Maximum number of redirects allowed. If the request exceeds this limit, a TooManyRedirects exception is raised.

mount(prefix, adapter)¶

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by key length.

options(url, **kwargs)¶

Sends a OPTIONS request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

params = None¶: Dictionary of querystring data to attach to each Request. The dictionary values may be lists for representing multivalued query parameters.

patch(url, data=None, **kwargs)¶

Sends a PATCH request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

post(url, data=None, **kwargs)¶

Sends a POST request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

proxies = None¶: Dictionary mapping protocol to the URL of the proxy (e.g. {‘http’: ‘foo.bar:3128’}) to be used on each Request.

put(url, data=None, **kwargs)¶

Sends a PUT request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

request(method, url, params=None, data=None, headers=None, cookies=None, files=None, auth=None, timeout=None, allow_redirects=True, proxies=None, hooks=None, stream=None, verify=None, cert=None)¶

Constructs a Request, prepares it and sends it. Returns Response object.

Parametry:

method – method for the new Request object.
url – URL for the new Request object.
params – (optional) Dictionary or bytes to be sent in the query string for the Request.
data – (optional) Dictionary or bytes to send in the body of the Request.
headers – (optional) Dictionary of HTTP Headers to send with the Request.
cookies – (optional) Dict or CookieJar object to send with the Request.
files – (optional) Dictionary of ‘filename’: file-like-objects for multipart encoding upload.
auth – (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth.
timeout – (optional) Float describing the timeout of the request.
allow_redirects – (optional) Boolean. Set to True by default.
proxies – (optional) Dictionary mapping protocol to the URL of the proxy.
stream – (optional) whether to immediately download the response content. Defaults to False.
verify – (optional) if True, the SSL cert will be verified. A CA_BUNDLE path can also be provided.
cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None)¶: Receives a Response. Returns a generator of Responses.

send(request, **kwargs)¶: Send a given PreparedRequest.

stream = None¶: Stream response content default.

trust_env = None¶: Should we trust the environment?

verify = None¶: SSL Verification default.

class requests.adapters.HTTPAdapter(pool_connections=10, pool_maxsize=10, max_retries=0, pool_block=False)¶

The built-in HTTP Adapter for urllib3.

Provides a general-case interface for Requests sessions to contact HTTP and HTTPS urls by implementing the Transport Adapter interface. This class will usually be created by the Session class under the covers.

Parametry:	pool_connections – The number of urllib3 connection pools to cache. pool_maxsize – The maximum number of connections to save in the pool. max_retries – The maximum number of retries each connection should attempt. pool_block – Whether the connection pool should block for connections.

Usage:

>>> import requests
>>> s = requests.Session()
>>> a = requests.adapters.HTTPAdapter()
>>> s.mount('http://', a)

add_headers(request, **kwargs)¶

Add any headers needed by the connection. Currently this adds a Proxy-Authorization header.

This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	request – The `PreparedRequest` to add headers to. kwargs – The keyword arguments from the call to send().

build_response(req, resp)¶

Builds a Response object from a urllib3 response. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter

Parametry:	req – The `PreparedRequest` used to generate the response. resp – The urllib3 response object.

cert_verify(conn, url, verify, cert)¶

Verify a SSL certificate. This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	conn – The urllib3 connection object associated with the cert. url – The requested URL. verify – Whether we should actually verify the certificate. cert – The SSL certificate to verify.

close()¶

Disposes of any internal state.

Currently, this just closes the PoolManager, which closes pooled connections.

get_connection(url, proxies=None)¶

Returns a urllib3 connection for the given URL. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	url – The URL to connect to. proxies – (optional) A Requests-style dictionary of proxies used on this request.

init_poolmanager(connections, maxsize, block=False)¶

Initializes a urllib3 PoolManager. This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	connections – The number of urllib3 connection pools to cache. maxsize – The maximum number of connections to save in the pool. block – Block when no free connections are available.

request_url(request, proxies)¶

Obtain the url to use when making the final request.

If the message is being sent through a proxy, the full URL has to be used. Otherwise, we should only use the path portion of the URL.

This shoudl not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	request – The `PreparedRequest` being sent. proxies – A dictionary of schemes to proxy URLs.

send(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)¶

Sends PreparedRequest object. Returns Response object.

Parametry:	request – The `PreparedRequest` being sent. stream – (optional) Whether to stream the request content. timeout – (optional) The timeout on the request. verify – (optional) Whether to verify SSL certificates. vert – (optional) Any user-provided SSL certificate to be trusted. proxies – (optional) The proxies dictionary to apply to the request.

Wyjątki¶

exception requests.exceptions.RequestException¶: There was an ambiguous exception that occurred while handling your request.

exception requests.exceptions.ConnectionError¶: A Connection error occurred.

exception requests.exceptions.HTTPError(*args, **kwargs)¶: An HTTP error occurred.

exception requests.exceptions.URLRequired¶: A valid URL is required to make a request.

exception requests.exceptions.TooManyRedirects¶: Too many redirects.

Sprawdzanie kodów odpowiedzi¶

requests.codes()¶: Dictionary lookup object.

>>> requests.codes['temporary_redirect']
307

>>> requests.codes.teapot
418

>>> requests.codes['\o/']
200

Ciasteczka (cookies)¶

requests.utils.dict_from_cookiejar(cj)¶

Returns a key/value dictionary from a CookieJar.

Parametry:	cj – CookieJar object to extract cookies from.

requests.utils.cookiejar_from_dict(cookie_dict, cookiejar=None)¶

Returns a CookieJar from a key/value dictionary.

Parametry:	cookie_dict – Dict of key/values to insert into CookieJar.

requests.utils.add_dict_to_cookiejar(cj, cookie_dict)¶

Returns a CookieJar from a key/value dictionary.

Parametry:	cj – CookieJar to insert cookies into. cookie_dict – Dict of key/values to insert into CookieJar.

Kodowania¶

requests.utils.get_encodings_from_content(content)¶

Returns encodings from given content string.

Parametry:	content – bytestring to extract encodings from.

requests.utils.get_encoding_from_headers(headers)¶

Returns encodings from given HTTP Header Dict.

Parametry:	headers – dictionary to extract encoding from.

requests.utils.get_unicode_from_response(r)¶

Returns the requested content back in unicode.

Parametry:	r – Response object to get unicode content from.

Tried:

charset from content-type
every encodings from <meta ... charset=XXX>
fall back and replace all unicode characters

Klasy¶

class requests.Response

The Response object, which contains a server’s response to an HTTP request.

apparent_encoding: The apparent encoding, provided by the lovely Charade library (Thanks, Ian!).

content: Content of the response, in bytes.

cookies = None: A CookieJar of Cookies the server sent back.

elapsed = None: The amount of time elapsed between sending the request and the arrival of the response (as a timedelta)

encoding = None: Encoding to decode with when accessing r.text.

headers = None: Case-insensitive Dictionary of Response Headers. For example, headers['content-encoding'] will return the value of a 'Content-Encoding' response header.

history = None: A list of Response objects from the history of the Request. Any redirect responses will end up here. The list is sorted from the oldest to the most recent request.

iter_content(chunk_size=1, decode_unicode=False): Iterates over the response data. When stream=True is set on the request, this avoids reading the content at once into memory for large responses. The chunk size is the number of bytes it should read into memory. This is not necessarily the length of each item returned as decoding can take place.

iter_lines(chunk_size=512, decode_unicode=None): Iterates over the response data, one line at a time. When stream=True is set on the request, this avoids reading the content at once into memory for large responses.

json(**kwargs)

Returns the json-encoded content of a response, if any.

Parametry:	**kwargs – Optional arguments that `json.loads` takes.

links: Returns the parsed header links of the response, if any.

raise_for_status(): Raises stored HTTPError, if one occurred.

raw = None: File-like object representation of response (for advanced usage). Requires that ``stream=True` on the request.

status_code = None: Integer Code of responded HTTP Status.

text

Content of the response, in unicode.

if Response.encoding is None and chardet module is available, encoding will be guessed.

url = None: Final URL location of Response.

class requests.Request(method=None, url=None, headers=None, files=None, data={}, params={}, auth=None, cookies=None, hooks=None)

A user-created Request object.

Used to prepare a PreparedRequest, which is sent to the server.

Parametry:

method – HTTP method to use.
url – URL to send.
headers – dictionary of headers to send.
files – dictionary of {filename: fileobject} files to multipart upload.
data – the body to attach the request. If a dictionary is provided, form-encoding will take place.
params – dictionary of URL parameters to append to the URL.
auth – Auth handler or (user, pass) tuple.
cookies – dictionary or CookieJar of cookies to attach to this request.
hooks – dictionary of callback hooks, for internal usage.

Usage:

>>> import requests
>>> req = requests.Request('GET', 'http://httpbin.org/get')
>>> req.prepare()
<PreparedRequest [GET]>

deregister_hook(event, hook): Deregister a previously registered hook. Returns True if the hook existed, False if not.

prepare(): Constructs a PreparedRequest for transmission and returns it.

register_hook(event, hook): Properly register a hook.

class requests.PreparedRequest¶

The fully mutable PreparedRequest object, containing the exact bytes that will be sent to the server.

Generated from either a Request object or manually.

Usage:

>>> import requests
>>> req = requests.Request('GET', 'http://httpbin.org/get')
>>> r = req.prepare()
<PreparedRequest [GET]>

>>> s = requests.Session()
>>> s.send(r)
<Response [200]>

body = None¶: request body to send to the server.

deregister_hook(event, hook)¶: Deregister a previously registered hook. Returns True if the hook existed, False if not.

headers = None¶: dictionary of HTTP headers.

hooks = None¶: dictionary of callback hooks, for internal usage.

method = None¶: HTTP verb to send to the server.

path_url¶: Build the path URL to use.

prepare_auth(auth, url='')¶: Prepares the given HTTP auth data.

prepare_body(data, files)¶: Prepares the given HTTP body data.

prepare_cookies(cookies)¶: Prepares the given HTTP cookie data.

prepare_headers(headers)¶: Prepares the given HTTP headers.

prepare_hooks(hooks)¶: Prepares the given hooks.

prepare_method(method)¶: Prepares the given HTTP method.

prepare_url(url, params)¶: Prepares the given HTTP URL.

register_hook(event, hook)¶: Properly register a hook.

url = None¶: HTTP URL to send the request to.

class requests.Session

A Requests session.

Provides cookie persistience, connection-pooling, and configuration.

Basic Usage:

>>> import requests
>>> s = requests.Session()
>>> s.get('http://httpbin.org/get')
200

auth = None: Default Authentication tuple or object to attach to Request.

cert = None: SSL certificate default.

close(): Closes all adapters and as such the session

delete(url, **kwargs)

Sends a DELETE request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get(url, **kwargs)

Sends a GET request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

get_adapter(url): Returns the appropriate connnection adapter for the given URL.

head(url, **kwargs)

Sends a HEAD request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

headers = None: A case-insensitive dictionary of headers to be sent on each Request sent from this Session.

hooks = None: Event-handling hooks.

max_redirects = None: Maximum number of redirects allowed. If the request exceeds this limit, a TooManyRedirects exception is raised.

mount(prefix, adapter)

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by key length.

options(url, **kwargs)

Sends a OPTIONS request. Returns Response object.

Parametry:	url – URL for the new `Request` object. **kwargs – Optional arguments that `request` takes.

params = None: Dictionary of querystring data to attach to each Request. The dictionary values may be lists for representing multivalued query parameters.

patch(url, data=None, **kwargs)

Sends a PATCH request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

post(url, data=None, **kwargs)

Sends a POST request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

proxies = None: Dictionary mapping protocol to the URL of the proxy (e.g. {‘http’: ‘foo.bar:3128’}) to be used on each Request.

put(url, data=None, **kwargs)

Sends a PUT request. Returns Response object.

Parametry:	url – URL for the new `Request` object. data – (optional) Dictionary, bytes, or file-like object to send in the body of the `Request`. **kwargs – Optional arguments that `request` takes.

request(method, url, params=None, data=None, headers=None, cookies=None, files=None, auth=None, timeout=None, allow_redirects=True, proxies=None, hooks=None, stream=None, verify=None, cert=None)

Constructs a Request, prepares it and sends it. Returns Response object.

Parametry:

method – method for the new Request object.
url – URL for the new Request object.
params – (optional) Dictionary or bytes to be sent in the query string for the Request.
data – (optional) Dictionary or bytes to send in the body of the Request.
headers – (optional) Dictionary of HTTP Headers to send with the Request.
cookies – (optional) Dict or CookieJar object to send with the Request.
files – (optional) Dictionary of ‘filename’: file-like-objects for multipart encoding upload.
auth – (optional) Auth tuple or callable to enable Basic/Digest/Custom HTTP Auth.
timeout – (optional) Float describing the timeout of the request.
allow_redirects – (optional) Boolean. Set to True by default.
proxies – (optional) Dictionary mapping protocol to the URL of the proxy.
stream – (optional) whether to immediately download the response content. Defaults to False.
verify – (optional) if True, the SSL cert will be verified. A CA_BUNDLE path can also be provided.
cert – (optional) if String, path to ssl client cert file (.pem). If Tuple, (‘cert’, ‘key’) pair.

resolve_redirects(resp, req, stream=False, timeout=None, verify=True, cert=None, proxies=None): Receives a Response. Returns a generator of Responses.

send(request, **kwargs): Send a given PreparedRequest.

stream = None: Stream response content default.

trust_env = None: Should we trust the environment?

verify = None: SSL Verification default.

class requests.adapters.HTTPAdapter(pool_connections=10, pool_maxsize=10, max_retries=0, pool_block=False)

The built-in HTTP Adapter for urllib3.

Provides a general-case interface for Requests sessions to contact HTTP and HTTPS urls by implementing the Transport Adapter interface. This class will usually be created by the Session class under the covers.

Parametry:	pool_connections – The number of urllib3 connection pools to cache. pool_maxsize – The maximum number of connections to save in the pool. max_retries – The maximum number of retries each connection should attempt. pool_block – Whether the connection pool should block for connections.

Usage:

>>> import requests
>>> s = requests.Session()
>>> a = requests.adapters.HTTPAdapter()
>>> s.mount('http://', a)

add_headers(request, **kwargs)

Add any headers needed by the connection. Currently this adds a Proxy-Authorization header.

This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	request – The `PreparedRequest` to add headers to. kwargs – The keyword arguments from the call to send().

build_response(req, resp)

Builds a Response object from a urllib3 response. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter

Parametry:	req – The `PreparedRequest` used to generate the response. resp – The urllib3 response object.

cert_verify(conn, url, verify, cert)

Verify a SSL certificate. This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	conn – The urllib3 connection object associated with the cert. url – The requested URL. verify – Whether we should actually verify the certificate. cert – The SSL certificate to verify.

close()

Disposes of any internal state.

Currently, this just closes the PoolManager, which closes pooled connections.

get_connection(url, proxies=None)

Returns a urllib3 connection for the given URL. This should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	url – The URL to connect to. proxies – (optional) A Requests-style dictionary of proxies used on this request.

init_poolmanager(connections, maxsize, block=False)

Initializes a urllib3 PoolManager. This method should not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	connections – The number of urllib3 connection pools to cache. maxsize – The maximum number of connections to save in the pool. block – Block when no free connections are available.

request_url(request, proxies)

Obtain the url to use when making the final request.

If the message is being sent through a proxy, the full URL has to be used. Otherwise, we should only use the path portion of the URL.

This shoudl not be called from user code, and is only exposed for use when subclassing the HTTPAdapter.

Parametry:	request – The `PreparedRequest` being sent. proxies – A dictionary of schemes to proxy URLs.

send(request, stream=False, timeout=None, verify=True, cert=None, proxies=None)

Sends PreparedRequest object. Returns Response object.

Parametry:	request – The `PreparedRequest` being sent. stream – (optional) Whether to stream the request content. timeout – (optional) The timeout on the request. verify – (optional) Whether to verify SSL certificates. vert – (optional) Any user-provided SSL certificate to be trusted. proxies – (optional) The proxies dictionary to apply to the request.

Migracja do wersji 1.x¶

Ta sekcja opisuje najważniejsze różnice pomiędzy 0.x a 1.x i ma na celu ułatwienie aktualizacji.

Zmiany w API¶

Response.json jest teraz wywoływalne (callable), a nie właściwością (property) odpowiedzi.

import requests
r = requests.get('https://github.com/timeline.json')
r.json()   # *wywołanie* podnosi wyjątek jeśli dekodowanie JSON nie uda się

API dla Session zmieniło się. Obiekty sesji nie przyjmują już parametrów. Session jest teraz pisane wielką literą, ale wciąż można używać session dla kompatybilności wstecznej.
```
s = requests.Session()    # wcześniej sesja przyjmowała parametry
s.auth = auth
s.headers.update(headers)
r = s.get('http://httpbin.org/headers')
```
Wszystkie request hooki zostały usunięte, za wyjątkiem response.
Pomocnicy uwierzytelniania są teraz w oddzielnych modułach. Patrz requests-oauthlib i requests-kerberos.

Parametr dla żądań streamingowych został zmieniony z prefetch na stream i logika została odwróćona. Dodatkowo, stream jest teraz wymagany do odczytu surowej odpowiedzi.
```
# w 0.x, prefetch=False miałoby taki sam efekt
r = requests.get('https://github.com/timeline.json', stream=True)
r.raw.read(10)
```

Parametr config metody requests został usunięty. Niektóre opcje są teraz konfigurowalne w Session, np. keep-alive i maksymalna ilość przekierowań. Opcja gadatliwości powinna być skonfigurowana przez logging.

import requests
import logging

# te dwie linie włączają debugowanie na poziomie httlib (requests->urllib3->httplib)
# zobaczysz REQUEST, wraz z HEADERS i DATA, oraz RESPONSE z HEADERS i bez DATA.
# jedyną brakującą rzeczą będzie response.body, które nie jest logowane.
import httplib
httplib.HTTPConnection.debuglevel = 1

logging.basicConfig() # musisz zainicjować logging, w przeciwnym wypadku nie zobaczysz nic z requests
logging.getLogger().setLevel(logging.DEBUG)
requests_log = logging.getLogger("requests.packages.urllib3")
requests_log.setLevel(logging.DEBUG)
requests_log.propagate = True

requests.get('http://httpbin.org/headers')

Licencja¶

Jedną z kluczowych zmian która nie dotyczy API jest zmiana licencji z licencji ISC na licencję Apache 2.0. Licensja Apache 2.0 zapewnia licencjonowanie kontrybucji na tejże licencji.

Interfejs dewelopera¶

Główny interfejs¶

Klasy niższego poziomu¶

Sesje żądań¶

Wyjątki¶

Sprawdzanie kodów odpowiedzi¶

Ciasteczka (cookies)¶

Kodowania¶

Klasy¶

Migracja do wersji 1.x¶

Zmiany w API¶

Licencja¶

Donate

Spis treści

Related Topics