The requests module in Python is used to send HTTP requests and communicate with web servers and APIs. It provides simple functions for sending requests such as GET, POST, PUT, and DELETE. The module also allows Python programs to send data, receive responses, work with JSON data, and handle common request errors.

Table of Contents

---

What is the requests Module?

The requests module is a popular Python library used to send HTTP requests to web servers. It makes it easier for Python programs to communicate with websites and REST APIs.
The module provides functions for different HTTP methods and allows programs to send and receive data over the internet.

Installing the requests Module

The requests module is not part of Python's standard library, so it can be installed using pip.

Syntax:

pip install requests

After installing it, the module can be imported into a Python program.

Importing the requests Module

The requests module can be imported using the import statement.

Example:

# Python program to import the requests module
import requests
print("Requests module imported successfully.")

Output:

Requests module imported successfully.

Sending a GET Request

The GET method is used to retrieve information from a web server or API. The requests.get() function sends a GET request to the specified URL.

Example:

# Python program to send a GET request
import requests
url = "https://jsonplaceholder.typicode.com/posts/1"
response = requests.get(url)
print("Status Code:", response.status_code)
print("Response:", response.json())

Output:

Status Code: 200
Response: {'userId': 1, 'id': 1, 'title': 'sunt aut facere repellat provident occaecati excepturi optio reprehenderit', ...}

The status_code property shows the HTTP status code returned by the server.

Sending a POST Request

The POST method is used to send data to a server and create a new resource.

Example:

# Python program to send a POST request
import requests
url = "https://jsonplaceholder.typicode.com/posts"
data = {
    "title": "Python Requests",
    "body": "Learning the requests module",
    "userId": 1
}
response = requests.post(url, json=data)
print("Status Code:", response.status_code)
print("Response:", response.json())

Output:

Status Code: 201
Response: {'title': 'Python Requests', 'body': 'Learning the requests module', 'userId': 1, 'id': 101}

The json parameter sends the Python dictionary as JSON data in the request.

Sending a PUT Request

The PUT method is used to update an existing resource on a server.

Example:

# Python program to send a PUT request
import requests
url = "https://jsonplaceholder.typicode.com/posts/1"
data = {
    "id": 1,
    "title": "Updated Title",
    "body": "Updated content",
    "userId": 1
}
response = requests.put(url, json=data)
print("Status Code:", response.status_code)
print("Response:", response.json())

Output:

Status Code: 200
Response: {'id': 1, 'title': 'Updated Title', 'body': 'Updated content', 'userId': 1}

The PUT request sends the updated information to the specified resource.

Sending a DELETE Request

The DELETE method is used to remove a resource from a server.

Example:

# Python program to send a DELETE request
import requests
url = "https://jsonplaceholder.typicode.com/posts/1"
response = requests.delete(url)
print("Status Code:", response.status_code)

Output:

Status Code: 200

The response indicates that the delete request was processed successfully.

Passing Query Parameters

Query parameters are additional values sent with a URL to provide information to an API. The params parameter can be used to send query parameters.

Example:

# Python program to send query parameters using requests
import requests
url = "https://jsonplaceholder.typicode.com/posts"
parameters = {
    "userId": 1
}
response = requests.get(url, params=parameters)
print("Status Code:", response.status_code)
print("Response:", response.json())

Output:

Status Code: 200
Response: [{'userId': 1, 'id': 1, 'title': '...', 'body': '...'}, ...]

The requests module automatically adds the query parameters to the URL.

Sending JSON Data

The json parameter can be used to send JSON data to an API. Python dictionaries can be passed directly to this parameter.

Example:

# Python program to send JSON data using requests
import requests
url = "https://jsonplaceholder.typicode.com/posts"
data = {
    "name": "Tanavi",
    "language": "Python"
}
response = requests.post(url, json=data)
print("Status Code:", response.status_code)
print("Response:", response.json())

Output:

Status Code: 201
Response: {'name': 'Tanavi', 'language': 'Python', 'id': 101}

The requests module converts the dictionary into JSON when it sends the request.

Reading the Response

The response returned by a server contains useful information such as the status code, headers, and response body.

Example:

# Python program to read an HTTP response
import requests
url = "https://jsonplaceholder.typicode.com/users/1"
response = requests.get(url)
print("Status Code:", response.status_code)
print("Content Type:", response.headers.get("Content-Type"))
print("Response Text:", response.text)

Output:

Status Code: 200
Content Type: application/json; charset=utf-8
Response Text: {"id":1,"name":"Leanne Graham",...}

The status_code provides the HTTP status, while headers contain information about the response. The text property returns the response body as text.

Handling Request Errors

Network problems, invalid URLs, and unsuccessful HTTP responses can cause request errors. The requests module provides exceptions that can be handled using a try-except block.

Example:

# Python program to handle request errors
import requests
url = "https://jsonplaceholder.typicode.com/users/1"
try:
    response = requests.get(url, timeout=10)
    response.raise_for_status()
    print("Request completed successfully.")
    print(response.json())
except requests.exceptions.RequestException as error:
    print("Request failed:", error)

Output:

Request completed successfully.
{'id': 1, 'name': 'Leanne Graham', ...}

The raise_for_status() method raises an exception when the server returns an unsuccessful HTTP status code.

Advantages of the requests Module

1. Simple Syntax: The requests module provides simple functions for sending HTTP requests.
2. Multiple HTTP Methods: It supports commonly used methods such as GET, POST, PUT, and DELETE.
3. JSON Support: The module makes it easy to send and receive JSON data.
4. Error Handling: The module provides exceptions that can be used to handle request-related errors.
5. API Integration: Python programs can use the module to communicate with REST APIs and other web services.

Common Beginner Mistakes

1. Forgetting to Install the Module: The requests module must be installed before importing it if it is not already available in the Python environment.
2. Using an Incorrect URL: An incorrect or unavailable URL can cause the request to fail.
3. Ignoring Status Codes: Beginners may assume that every request is successful without checking the returned status code.
4. Forgetting a Timeout: Requests without a timeout can wait for a long time when a server does not respond.
5. Ignoring Exceptions: Network and request errors should be handled properly to prevent unexpected program termination.

Conclusion

The requests module provides a simple way to communicate with web servers and REST APIs using Python. It can send different HTTP requests, pass parameters, send JSON data, and process server responses. By learning the requests module, beginners can build Python programs that interact with web services and APIs.

Frequently Asked Questions

1. What is the requests module in Python?

The requests module is a Python library used to send HTTP requests and communicate with web servers and APIs.

2. How can the requests module be installed?

The requests module can be installed using the pip install requests command.

3. Which function is used to send a GET request?

The requests.get() function is used to send a GET request to a specified URL.

4. How can JSON data be sent using requests?

JSON data can be sent by passing a Python dictionary to the json parameter of a request function such as requests.post().

5. How can request errors be handled?

Request errors can be handled using a try-except block and exceptions such as requests.exceptions.RequestException.