http

Package httpmodule provides HTTP client functionality for durable programs.

http

Functions

client(timeout: Duration?, retry_strategy: Strategy?, on_error: Callable?)

Example:

http.client(timeout=time.SECOND * 30)

Parameters:

Name	Type	Required	Description
timeout	Duration
retry_strategy	Strategy
on_error	Callable

Returns: Client

---

response(status_code: Int, headers: Dict?, body: String?)

Example:

http.response(status_code=http.STATUS_OK, body="{}")

Parameters:

Name	Type	Required	Description
status_code	Int	✓
headers	Dict
body	String

Returns: Response

---

request(url: String, method: String, headers: Dict?, body: String?, form: Dict?)

Example:

http.request("https://example.com/api", http.POST, body="{}")

Parameters:

Name	Type	Required	Description
url	String	✓
method	String	✓
headers	Dict
body	String
form	Dict

Returns: Request

---

cookie(name: String, value: String)

Example:

http.cookie("session", "abc123")

Parameters:

Name	Type	Required	Description
name	String	✓
value	String	✓

Returns: Cookie

---

Types

Client

Attributes:

do(request: Request)

Parameters:

Name	Type	Required	Description
request	Request	✓

Returns: Response

get(url: String)

Parameters:

Name	Type	Required	Description
url	String	✓

Returns: Response

post(url: String, body: String, content_type: String, headers: Dict)

Parameters:

Name	Type	Required	Description
url	String	✓
body	String
content_type	String
headers	Dict

Returns: Response

post_form(url: String, form: Dict, headers: Dict)

Parameters:

Name	Type	Required	Description
url	String	✓
form	Dict	✓
headers	Dict

Returns: Response

head(url: String)

Parameters:

Name	Type	Required	Description
url	String	✓

Returns: Response

put(url: String)

Parameters:

Name	Type	Required	Description
url	String	✓

Returns: Response

patch(url: String)

Parameters:

Name	Type	Required	Description
url	String	✓

Returns: Response

delete(url: String)

Parameters:

Name	Type	Required	Description
url	String	✓

Returns: Response

options(url: String)

Parameters:

Name	Type	Required	Description
url	String	✓

Returns: Response

trace(url: String)

Parameters:

Name	Type	Required	Description
url	String	✓

Returns: Response

timeout

Returns: Duration

---

Cookie

Attributes:

name

Returns: String

value

Returns: String

quoted

Returns: Bool

path

Returns: String

domain

Returns: String

expires

Returns: Time

raw_expires

Returns: String

max_age

Returns: Int

secure

Returns: Bool

http_only

Returns: Bool

same_site

Returns: Int

partitioned

Returns: Bool

raw

Returns: String

unparsed

Returns: List

---

Request

Attributes:

method

Returns: String

url

Returns: String

proto

Returns: String

proto_major

Returns: Int

proto_minor

Returns: Int

header

Returns: Dict

body

Returns: String

content_length

Returns: Int

transfer_encoding

Returns: List

host

Returns: String

remote_addr

Returns: String

request_uri

Returns: String

response

Returns: Response

cookies

Returns: List

referer

Returns: String

user_agent

Returns: String

add_cookie(cookie: Cookie)

Parameters:

Name	Type	Required	Description
cookie	Cookie	✓

Returns: None

---

Response

Attributes:

status

Returns: String

status_code

Returns: Int

proto

Returns: String

proto_major

Returns: Int

proto_minor

Returns: Int

header

Returns: Dict

body

Returns: String

content_length

Returns: Int

transfer_encoding

Returns: List

uncompressed

Returns: Bool

request

Returns: Request

cookies

Returns: List

location

Returns: String

---

Constants

• GET - Constant
• HEAD - Constant
• POST - Constant
• PUT - Constant
• PATCH - Constant
• DELETE - Constant
• CONNECT - Constant
• OPTIONS - Constant
• TRACE - Constant
• STATUS_CONTINUE - Constant
• STATUS_SWITCHING_PROTOCOLS - Constant
• STATUS_PROCESSING - Constant
• STATUS_EARLY_HINTS - Constant
• STATUS_OK - Constant
• STATUS_CREATED - Constant
• STATUS_ACCEPTED - Constant
• STATUS_NON_AUTHORITATIVE_INFO - Constant
• STATUS_NO_CONTENT - Constant
• STATUS_RESET_CONTENT - Constant
• STATUS_PARTIAL_CONTENT - Constant
• STATUS_MULTI_STATUS - Constant
• STATUS_ALREADY_REPORTED - Constant
• STATUS_IM_USED - Constant
• STATUS_MULTIPLE_CHOICES - Constant
• STATUS_MOVED_PERMANENTLY - Constant
• STATUS_FOUND - Constant
• STATUS_SEE_OTHER - Constant
• STATUS_NOT_MODIFIED - Constant
• STATUS_USE_PROXY - Constant
• STATUS_TEMPORARY_REDIRECT - Constant
• STATUS_PERMANENT_REDIRECT - Constant
• STATUS_BAD_REQUEST - Constant
• STATUS_UNAUTHORIZED - Constant
• STATUS_PAYMENT_REQUIRED - Constant
• STATUS_FORBIDDEN - Constant
• STATUS_NOT_FOUND - Constant
• STATUS_METHOD_NOT_ALLOWED - Constant
• STATUS_NOT_ACCEPTABLE - Constant
• STATUS_PROXY_AUTH_REQUIRED - Constant
• STATUS_REQUEST_TIMEOUT - Constant
• STATUS_CONFLICT - Constant
• STATUS_GONE - Constant
• STATUS_LENGTH_REQUIRED - Constant
• STATUS_PRECONDITION_FAILED - Constant
• STATUS_REQUEST_ENTITY_TOO_LARGE - Constant
• STATUS_REQUEST_URI_TOO_LONG - Constant
• STATUS_UNSUPPORTED_MEDIA_TYPE - Constant
• STATUS_REQUESTED_RANGE_NOT_SATISFIABLE - Constant
• STATUS_EXPECTATION_FAILED - Constant
• STATUS_TEAPOT - Constant
• STATUS_MISDIRECTED_REQUEST - Constant
• STATUS_UNPROCESSABLE_ENTITY - Constant
• STATUS_LOCKED - Constant
• STATUS_FAILED_DEPENDENCY - Constant
• STATUS_TOO_EARLY - Constant
• STATUS_UPGRADE_REQUIRED - Constant
• STATUS_PRECONDITION_REQUIRED - Constant
• STATUS_TOO_MANY_REQUESTS - Constant
• STATUS_REQUEST_HEADER_FIELDS_TOO_LARGE - Constant
• STATUS_UNAVAILABLE_FOR_LEGAL_REASONS - Constant
• STATUS_INTERNAL_SERVER_ERROR - Constant
• STATUS_NOT_IMPLEMENTED - Constant
• STATUS_BAD_GATEWAY - Constant
• STATUS_SERVICE_UNAVAILABLE - Constant
• STATUS_GATEWAY_TIMEOUT - Constant
• STATUS_HTTP_VERSION_NOT_SUPPORTED - Constant
• STATUS_VARIANT_ALSO_NEGOTIATES - Constant
• STATUS_INSUFFICIENT_STORAGE - Constant
• STATUS_LOOP_DETECTED - Constant
• STATUS_NOT_EXTENDED - Constant
• STATUS_NETWORK_AUTHENTICATION_REQUIRED - Constant