Helper class to send HTTP requests.
Summary
Functions
Python method HTTPConnection._headers.
Python method HTTPConnection._validate_http_url.
Python method HTTPConnection.async_download_file.
Python method HTTPConnection.async_get_bytes.
Python method HTTPConnection.async_get_json.
Python method HTTPConnection.async_get_text.
Python method HTTPConnection.download_file.
Python method HTTPConnection.get_async_client.
Python method HTTPConnection.get_async_response.
Python method HTTPConnection.get_bytes.
Python method HTTPConnection.get_json.
Python method HTTPConnection.get_response.
Python method HTTPConnection.get_sync_client.
Python method HTTPConnection.get_text.
Initialize self. See help(type(self)) for accurate signature.
Types
Functions
@spec _headers( SnakeBridge.Ref.t(), keyword() ) :: {:ok, term()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection._headers.
Parameters
extras(String.t())
Returns
term()
@spec _validate_http_url(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection._validate_http_url.
Parameters
url(String.t())
Returns
term()
@spec async_download_file(SnakeBridge.Ref.t(), String.t(), term(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.async_download_file.
Parameters
url(String.t())save_path(term())timeout(term() keyword-only default: None)chunk_size(integer() keyword-only default: 128)
Returns
term()
@spec async_get_bytes(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, binary()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.async_get_bytes.
Parameters
url(String.t())timeout(term() keyword-only default: None)allow_redirects(boolean() keyword-only default: True)
Returns
binary()
@spec async_get_json(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, String.t()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.async_get_json.
Parameters
url(String.t())timeout(term() keyword-only default: None)
Returns
String.t()
@spec async_get_text(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, String.t()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.async_get_text.
Parameters
url(String.t())timeout(term() keyword-only default: None)
Returns
String.t()
@spec download_file(SnakeBridge.Ref.t(), String.t(), term(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.download_file.
Parameters
url(String.t())save_path(term())timeout(term() keyword-only default: None)chunk_size(integer() keyword-only default: 128)
Returns
term()
@spec get_async_client( SnakeBridge.Ref.t(), keyword() ) :: {:ok, term()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.get_async_client.
Returns
term()
@spec get_async_response(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.get_async_response.
Parameters
url(String.t())timeout(term() keyword-only default: None)extra_headers(term() keyword-only default: None)allow_redirects(boolean() keyword-only default: True)
Returns
term()
@spec get_bytes(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, binary()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.get_bytes.
Parameters
url(String.t())timeout(term() keyword-only default: None)allow_redirects(boolean() keyword-only default: True)
Returns
binary()
@spec get_json(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, String.t()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.get_json.
Parameters
url(String.t())timeout(term() keyword-only default: None)
Returns
String.t()
@spec get_response(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, term()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.get_response.
Parameters
url(String.t())stream(boolean() keyword-only default: False)timeout(term() keyword-only default: None)extra_headers(term() keyword-only default: None)allow_redirects(boolean() keyword-only default: True)
Returns
term()
@spec get_sync_client( SnakeBridge.Ref.t(), keyword() ) :: {:ok, term()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.get_sync_client.
Returns
term()
@spec get_text(SnakeBridge.Ref.t(), String.t(), keyword()) :: {:ok, String.t()} | {:error, Snakepit.Error.t()}
Python method HTTPConnection.get_text.
Parameters
url(String.t())timeout(term() keyword-only default: None)
Returns
String.t()
@spec new(keyword()) :: {:ok, SnakeBridge.Ref.t()} | {:error, Snakepit.Error.t()}
Initialize self. See help(type(self)) for accurate signature.
Parameters
reuse_client(boolean() keyword-only default: True)