steps.api.utils.request

Attributes

AUTHORIZATION_KEY
CONTENT_TYPE_KEY
JSON_HEADER_KEY
FORM_HEADER_KEY

Classes

Request

A user-created Request object.

Module Contents

steps.api.utils.request.AUTHORIZATION_KEY = 'Authorization'

steps.api.utils.request.CONTENT_TYPE_KEY = 'Content-Type'

steps.api.utils.request.JSON_HEADER_KEY = 'application/json'

steps.api.utils.request.FORM_HEADER_KEY = 'application/x-www-form-urlencoded'

class steps.api.utils.request.Request(api=None, timeout: int = 3)

Bases: requests.Request

A user-created Request object.

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

Parameters:

• 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 to the request. If a dictionary or list of tuples [(key, value)] is provided, form-encoding will take place.

• json – json for the body to attach to the request (if files or data is not specified).

• params – URL parameters to append to the URL. If a dictionary or list of tuples [(key, value)] is provided, form-encoding will take place.

• 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', 'https://httpbin.org/get')
>>> req.prepare()
<PreparedRequest [GET]>

api: steps.api.utils.api.Api = None

method = ''

headers

params

body

original_path_url = ''

path_parameters

path_url = ''

url = ''

log = True

timeout = 3

expected_status_code = '200'

response = None

set_header(key, value)

set_body(key, value)

set_param(key, value)

set_authorization_header(value)

set_json_content_type()

set_form_content_type()

set_url(path_url: str, path_parameters: dict = {})

set_method(method: str)

send()

get_pretty_request() → str

get_pretty_response() → str

copy()