Python requests.delete Function

The requests.delete function in Python’s requests module is used to make HTTP DELETE requests. This function is typically used to delete a resource on a server.

Table of Contents

1. Introduction
2. requests.delete Function Syntax
3. Examples
   • Basic Usage
   • Sending Headers
   • Handling JSON Responses
4. Real-World Use Case
5. Conclusion

Introduction

The requests.delete function is part of the requests module, which makes it easy to make HTTP requests in Python. You can use this function to send a DELETE request to a web server to delete a specific resource and get responses.

requests.delete Function Syntax

Here’s how you use the requests.delete function:

import requests

response = requests.delete(url, **kwargs)

Parameters:

• url: The URL for the request.
• **kwargs: Optional arguments to customize the request. Common ones include:
  • params: Dictionary to send in the query string.
  • headers: Dictionary of HTTP headers to send with the request.

Returns:

• A Response object containing the server’s response to the HTTP request.

Examples

Basic Usage

Send a simple DELETE request to a URL.

import requests

response = requests.delete('https://jsonplaceholder.typicode.com/posts/1')
print(response.status_code)

Output:

200

Sending Headers

Send custom headers with a DELETE request.

import requests

headers = {'Authorization': 'Bearer your_token'}
response = requests.delete('https://jsonplaceholder.typicode.com/posts/1', headers=headers)
print(response.status_code)

Output:

200

Handling JSON Responses

Send a DELETE request and handle the JSON response.

import requests

response = requests.delete('https://jsonplaceholder.typicode.com/posts/1')
if response.status_code == 200:
    print('Resource deleted successfully')
else:
    print('Failed to delete resource')

Output:

Resource deleted successfully

Real-World Use Case

Deleting Data from an API

Delete data from an API that requires authentication.

import requests

url = 'https://jsonplaceholder.typicode.com/posts/1'
headers = {'Authorization': 'Bearer your_token'}
response = requests.delete(url, headers=headers)
if response.status_code == 200:
    print('Resource deleted successfully')
else:
    print('Failed to delete resource')

Output:

Resource deleted successfully

Conclusion

The requests.delete function is a simple and effective way to make HTTP DELETE requests in Python. You can use it to delete data from web servers, include custom headers, and handle responses. This function makes it easy to interact with web services and APIs.