Requests in Python

vibssingh

How to test response time in Request using Python Requests

HOME

In Python, the requests library is commonly employed for retrieving content from a specific resource URI. When a request is made to a designated URI using Python, it yields a response object. This response object is then utilized to access various attributes, including content and headers. This article focuses on demonstrating how to examine the response.elapsed attribute within a response object.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

In Python, response.elapsed is an attribute of the Response object from the requests library, which is commonly used for making HTTP requests. The elapsed attribute represents the time elapsed between sending the request and receiving the response.

Below is the example of response.elapsed.

import requests

endpoint = 'https://reqres.in/api/users'


def test_response():
    payload = {
        "name": "Vibha",
        "Job": "CEO"
    }

    response = requests.post(endpoint, payload)
    response_body = response.json()
    print("Response :", response_body)
    assert response.status_code == 201
    print("Elapsed Time :", response.elapsed.total_seconds())

Save above file as ResponseTime_test.py and run using the below command:

pytest ResponseTime_test.py -s

Note: -s is shortcut for –capture=no

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!

vibssingh

How to add header to Python Requests

Last Updated On

HOME

In this tutorial, we will add header to the Python Request.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

What are HTTP headers?

HTTP headers let the client and the server pass additional information with an HTTP request or response. All the headers are case-insensitive, headers fields are separated by colon, key-value pairs in clear-text string format.

Headers = { “Authorization” : ”our_unique_secret_token” }

Below is the example of POST Request with header.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “PostRequest.py”.

Step 5 – Create the test

Import the required packages.

The POST method is used to get the resource from the server and returns 201 for successful call.

import requests

ENDPOINT = 'https://reqres.in/api/users'


def test_add_header():
    request_body = {
        "name": "Vibha",
        "Job": "CEO"
    }

    header = {"Content-Type":  "application/json; charset=utf-8"}

    response = requests.post(ENDPOINT, request_body, header)
    print(response.json())
    print("Request Header", response.request.headers)
    print("Response Header", response.headers)
    assert response.status_code == 201
    assert response.headers["Content-Type"] == "application/json; charset=utf-8"

requests.post(url, data=data, header=header) – function sends a POST request to the specified URL with the provided data. The data dictionary contains the key-value pairs that we want to send in the POST request payload. You can modify it based on the requirements of the API we are working with. The header dictionary also contains the key-value pair.

The response object contains information about the response, including the status code and the response content.

We can assert the header of the response also as shown below:

assert response.headers["Content-Type"] == "application/json; charset=utf-8"

Step 6 – To run the test through command line, use the below command:

pytest PostRequest_test.py -s

The output of the above program is

That’s it! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

How to test PATCH Request Using Python Requests

HOME

In this tutorial, we will test PATCH Request in Python.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is the example of PATCH Request.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “PatchRequest.py”.

Step 5 – Create the test

Import the required packages.

The PATCH method is used to apply partial modifications to a resource.

import requests

ENDPOINT = 'https://reqres.in/api/users/2'


def test_partiallyupdate_user():
    request_body = {
        "Job": "CFO"
    }

    response = requests.patch(ENDPOINT, request_body)
    print(response.text)
    assert response.status_code == 200
    response_body = response.json()
    assert response_body["Job"] == "CFO"

requests.patch(url,data=data) – function sends a PATCH request to the specified URL with the provided data. The data dictionary contains the key-value pairs that we want to send in the PATCH request payload. You can modify it based on the requirements of the API we are working with.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

How to test DELETE Request Using Python Requests

HOME

In this tutorial, we will test DELETE Request in Python.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is the example of DELETE Request.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “DeleteRequest.py”.

Step 5 – Create the test

Import the required packages.

The DELETE method is typically used to request that a resource be removed or deleted.

import requests

ENDPOINT = 'https://reqres.in/api/users/2'


def test_delete_user():

    response = requests.delete(ENDPOINT)
    assert response.status_code == 204

requests.delete(url) – function sends a DELETE request to the specified URL.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

That’s it! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

How to test PUT Request Using Python Requests

Last Updated On

HOME

In this tutorial, we will test PUT Request in Python.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is the example of PUT Request.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “PuttRequest.py”.

Step 5 – Create the test

Import the required packages.

The PUT method is typically used to update or create a resource on the server and returns 200 for successful call.

import requests

ENDPOINT = 'https://reqres.in/api/users/2'


def test_update_user():
    request_body = {
        "name": "Vibha",
        "Job": "CTO"
    }

    response = requests.put(ENDPOINT, request_body)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 200
    assert response_body["Job"] == "CTO"

requests.put(url, data=data) – function sends a PUT request to the specified URL with the provided data. The data dictionary contains the key-value pairs that we want to send in the PUT request payload. You can modify it based on the requirements of the API we are working with.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

The complete code can be found in GitHub – vibssingh/RestAPITesting_Python

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

Requests in Python

Last Updated On

HOME

Requests is an HTTP client library for the Python programming language. Requests is one of the most downloaded Python libraries, with over 300 million monthly downloads. It maps the HTTP protocol onto Python’s object-oriented semantics.

Chapter 1 How to test GET Request Using Python Requests
Chapter 2 How to test POST Request Using Python Requests
Chapter 3 How to test PUT Request Using Python Requests
Chapter 4 How to test DELETE Request Using Python Requests
Chapter 5 How to test PATCH Request Using Python Requests
Chapter 6 How to add header to Python Requests
Chapter 7 How to test response time in Request Using Python Requests
Chapter 8 How to pass basic authentication credentials in Python Requests
Chapter 9 How to pass basic authentication token in Python Requests – NEW
Chapter 10 How to create Python Allure Report for Rest API – NEW
Chapter 11 How to add environment details to Python Allure Report – NEW
Chapter 12 How to run Python Rest API tests with GitHub Actions – NEW
Chapter 13 Status Code, Line, Body, and Header Verification in Python Requests – NEW

vibssingh

How to test POST Request Using Python Requests

HOME

In this tutorial, we will test POST Request in Python using Requests.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or other Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is the example of POST Request.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “PostRequest.py”.

Step 5 – Create the test

Import the required packages.

The POST method is used to get the resource from the server and returns 201 for successful call.

import requests

ENDPOINT = 'https://reqres.in/api/users'


def test_create_user():

    response = requests.post(ENDPOINT, {"name": "Vibha", "job": "CTO"})
    response_body = response.json()
    print(response_body)
    assert response.status_code == 201
    assert response_body["name"] == "Vibha"
    assert response_body["job"] == "CTO"

requests.post(url, data=data) – function sends a POST request to the specified URL with the provided data. The data dictionary contains the key-value pairs that we want to send in the POST request payload. You can modify it based on the requirements of the API we are working with.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

In the above example, we have passed the request body in the requests.post(). In the below example, will define a variable and assign the request body to it.

def test_create_user1():
    payload = {
        "name": "Vibha",
        "job": "CTO"
    }

    response = requests.post(ENDPOINT, payload)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 201
    assert response_body["name"] == "Vibha"
    assert response_body["job"] == "CTO"

The output of the above program is

We are done! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!

vibssingh

How to test GET Request Using Python Requests

Last Updated On

HOME

In this tutorial, we will test GET Request in Python using Requests.

Prerequisite:

  1. Python is installed on the machine
  2. PIP is installed on the machine
  3. PyCharm or another Python Editor is installed on the machine

If you need help in installing Python, please refer to this tutorial – How to Install Python on Windows 11.

If you need help in installing PyCharms, please refer to this tutorial – How to install PyCharms on Windows 11.

Below is an example of a GET Request using Postman.

Installation of Python Requests Module

Step 1 – If you are using PyCharm IDE then you need to install the Request library. Execute the below command using pip.

pip install -U requests

Step 2 – Install Pytest

pip install -U pytest

Step 3 – Create a new project folder and open it in PyCharm.

Step 4 – Go to the project folder and Create a new file, name it “GetRequest.py”.

Step 5 – Create the test

Import the required packages.

The GET method is used to get the resource from the server and returns 200 if successful.

import requests

ENDPOINT = 'https://reqres.in/api/'
USER = 'users/2'


def test_get_user_successful():
    response = requests.get(ENDPOINT+USER)
    response_body = response.json()
    print(response_body)
    assert response.status_code == 200
    assert response_body["data"]["id"] == 2
    assert response_body["data"]["first_name"] == "Janet"
    assert response_body["data"]["last_name"] == "Weaver"

requests.get(url) – function sends a GET request to the specified URL.

The response object contains information about the response, including the status code and the response content.

The output of the above program is

In the case of a failed test, we can see the error message in the logs.

def test_get_user_unsuccessful():
    response = requests.get(ENDPOINT+USER)
    print(response.json())
    assert response.status_code == 203

The output of the above program is

The complete code can be found in GitHub – vibssingh/RestAPITesting_Python

That’s it! Congratulations on making it through this tutorial and hope you found it useful! Happy Learning!!