Hướng dẫn requests patch python

Mục lục bài viết:

• Bắt đầu với các yêu cầu
• Yêu cầu GET
• Phản hồi
  • Mã trạng thái
  • Nội dung
  • Tiêu đề
• Tham số chuỗi truy vấn
• Yêu cầu tiêu đề
• Các phương thức HTTP khác
• Nội dung thư
• Kiểm tra yêu cầu của bạn
• Xác thực
• Xác minh chứng chỉ SSL
• Hiệu suất
  • Hết giờ
  • Đối tượng phiên
  • Số lần thử tối đa
• Phần kết luận

Nội dung chính

• Mục lục bài viết:
• Bắt đầu với requests
• Yêu cầu GET
• Phản hồi
• Mã trạng thái
• Tiêu đề
• Tham số chuỗi truy vấn
• Yêu cầu tiêu đề
• Các phương thức HTTP khác
• Nội dung thư
• Kiểm tra yêu cầu của bạn
• Xác thực
• Xác minh chứng chỉ SSL
• Hiệu suất
• Hết giờ
• Đối tượng phiên
• Số lần thử tối đa
• Phần kết luận

Các requeststhư viện là tiêu chuẩn de facto cho làm các yêu cầu HTTP bằng Python. Nó tóm tắt sự phức tạp của việc thực hiện các yêu cầu đằng sau một API đẹp, đơn giản để bạn có thể tập trung vào việc tương tác với các dịch vụ và sử dụng dữ liệu trong ứng dụng của mình.

Trong suốt bài viết này, bạn sẽ thấy một số tính năng hữu ích nhất requestsphải cung cấp cũng như cách tùy chỉnh và tối ưu hóa các tính năng đó cho các tình huống khác nhau mà bạn có thể gặp phải. Bạn cũng sẽ học cách sử dụng requestsmột cách hiệu quả cũng như cách ngăn chặn các yêu cầu đến các dịch vụ bên ngoài làm chậm ứng dụng của bạn.

Trong hướng dẫn này, bạn sẽ học cách:

• Đưa ra yêu cầu bằng các phương thức HTTP phổ biến nhất
• Tùy chỉnh tiêu đề và dữ liệu yêu cầu của bạn, sử dụng chuỗi truy vấn và nội dung thư
• Kiểm tra dữ liệu từ các yêu cầu và phản hồi của bạn
• Thực hiện các yêu cầu đã xác thực
• Định cấu hình các yêu cầu của bạn để giúp ngăn ứng dụng của bạn sao lưu hoặc làm chậm

Mặc dù tôi đã cố gắng bao gồm nhiều thông tin nhất mà bạn cần để hiểu các tính năng và ví dụ có trong bài viết này, nhưng tôi giả sử có một kiến thức chung rất cơ bản về HTTP . Điều đó nói rằng, bạn vẫn có thể làm theo tốt.

Bây giờ điều đó không còn nữa, hãy đi sâu vào và xem bạn có thể sử dụng như thế nào requeststrong ứng dụng của mình!

Bắt đầu với requests

Hãy bắt đầu bằng cách cài đặt requeststhư viện. Để làm như vậy, hãy chạy lệnh sau:

Nếu bạn thích sử dụng Pipenv để quản lý các gói Python , bạn có thể chạy như sau:

$ pipenv install requests

Sau khi requestsđược cài đặt, bạn có thể sử dụng nó trong ứng dụng của mình. Quá trình nhập requeststrông giống như sau:

Bây giờ bạn đã thiết lập xong, đã đến lúc bắt đầu hành trình của bạn requests. Mục tiêu đầu tiên của bạn sẽ là học cách đưa ra GETyêu cầu.

Yêu cầu GET

Các phương thức HTTP chẳng hạn như GETvà POST, xác định hành động bạn đang cố gắng thực hiện khi thực hiện một yêu cầu HTTP. Bên cạnh đó GETvà POST, có một số phương pháp thông thường khác mà bạn sẽ sử dụng sau này trong hướng dẫn này.

Một trong những phương thức HTTP phổ biến nhất là GET. Các GETphương pháp chỉ ra rằng bạn đang cố gắng để có được hoặc lấy dữ liệu từ một nguồn lực xác định. Để thực hiện một GETyêu cầu, hãy gọi requests.get().

Để kiểm tra điều này, bạn có thể GETyêu cầu API REST gốc của GitHub bằng cách gọi get()với URL sau:

>>>

>>> requests.get('https://api.github.com')

Xin chúc mừng! Bạn đã thực hiện yêu cầu đầu tiên của mình. Hãy đi sâu hơn một chút về phản hồi của yêu cầu đó.

Phản hồi

A Responselà một đối tượng mạnh mẽ để kiểm tra kết quả của yêu cầu. Hãy thực hiện lại yêu cầu đó một lần nữa, nhưng lần này lưu trữ giá trị trả về trong một biến để bạn có thể xem xét kỹ hơn các thuộc tính và hành vi của nó:

>>>

>>> response = requests.get('https://api.github.com')

Trong ví dụ này, bạn đã nắm bắt được giá trị trả về của get(), là một phiên bản của Responsevà lưu trữ nó trong một biến được gọi là response. Bây giờ bạn có thể sử dụng responseđể xem rất nhiều thông tin về kết quả của GETyêu cầu của bạn .

Mã trạng thái

Bit thông tin đầu tiên mà bạn có thể thu thập Responselà mã trạng thái. Mã trạng thái thông báo cho bạn về trạng thái của yêu cầu.

Ví dụ: 200 OKtrạng thái có nghĩa là yêu cầu của bạn đã thành công, trong khi 404 NOT FOUNDtrạng thái có nghĩa là tài nguyên bạn đang tìm kiếm không được tìm thấy. Cũng có nhiều mã trạng thái có thể có khác để cung cấp cho bạn thông tin chi tiết cụ thể về những gì đã xảy ra với yêu cầu của bạn.

Bằng cách truy cập .status_code, bạn có thể thấy mã trạng thái mà máy chủ trả về:

>>>

>>> response.status_code
200

.status_codetrả về a 200, có nghĩa là yêu cầu của bạn đã thành công và máy chủ đã phản hồi với dữ liệu bạn đang yêu cầu.

Đôi khi, bạn có thể muốn sử dụng thông tin này để đưa ra quyết định trong mã của mình:

if response.status_code == 200:
    print('Success!')
elif response.status_code == 404:
    print('Not Found.')

Với logic này, nếu máy chủ trả về 200mã trạng thái, chương trình của bạn sẽ in Success! . Nếu kết quả là a 404, chương trình của bạn sẽ in Not Found.

requeststiến thêm một bước trong việc đơn giản hóa quy trình này cho bạn. Nếu bạn sử dụng một Responsethể hiện trong biểu thức điều kiện, nó sẽ đánh giá Truexem mã trạng thái có nằm giữa 200và 400và Falsenếu không.

Do đó, bạn có thể đơn giản hóa ví dụ cuối cùng bằng cách viết lại ifcâu lệnh:

if response:
    print('Success!')
else:
    print('An error has occurred.')

Hãy nhớ rằng phương pháp này không xác minh rằng mã trạng thái là bằng 200. Lý do cho điều này là các mã trạng thái khác trong phạm vi 200tới 400, chẳng hạn như 204 NO CONTENTvà 304 NOT MODIFIED, cũng được coi là thành công theo nghĩa là chúng cung cấp một số phản hồi khả thi.

Ví dụ: 204câu trả lời cho bạn biết rằng phản hồi đã thành công, nhưng không có nội dung nào để trả lại trong nội dung thư.

Vì vậy, hãy đảm bảo rằng bạn chỉ sử dụng tốc ký thuận tiện này nếu bạn muốn biết yêu cầu nói chung có thành công hay không và sau đó, nếu cần, hãy xử lý phản hồi một cách thích hợp dựa trên mã trạng thái.

Giả sử bạn không muốn kiểm tra mã trạng thái của phản hồi trong một ifcâu lệnh. Thay vào đó, bạn muốn đưa ra một ngoại lệ nếu yêu cầu không thành công. Bạn có thể làm điều này bằng cách sử dụng .raise_for_status():

import requests
from requests.exceptions import HTTPError

for url in ['https://api.github.com', 'https://api.github.com/invalid']:
    try:
        response = requests.get(url)

        # If the response was successful, no Exception will be raised
        response.raise_for_status()
    except HTTPError as http_err:
        print(f'HTTP error occurred: {http_err}')  # Python 3.6
    except Exception as err:
        print(f'Other error occurred: {err}')  # Python 3.6
    else:
        print('Success!')

Nếu bạn gọi .raise_for_status(), một HTTPErrorsẽ được nâng lên cho các mã trạng thái nhất định. Nếu mã trạng thái cho biết một yêu cầu thành công, chương trình sẽ tiếp tục mà không có ngoại lệ nào được nêu ra.

Đọc thêm: Nếu bạn không quen thuộc với chuỗi f của Python 3.6 , tôi khuyến khích bạn tận dụng chúng vì chúng là một cách tuyệt vời để đơn giản hóa các chuỗi được định dạng của bạn.

Bây giờ, bạn đã biết rất nhiều về cách xử lý mã trạng thái của phản hồi mà bạn nhận được từ máy chủ. Tuy nhiên, khi bạn đưa ra một GETyêu cầu, bạn hiếm khi chỉ quan tâm đến mã trạng thái của phản hồi. Thông thường, bạn muốn xem thêm. Tiếp theo, bạn sẽ thấy cách xem dữ liệu thực tế mà máy chủ đã gửi lại trong phần nội dung của phản hồi.

Nội dung

Phản hồi của một GETyêu cầu thường có một số thông tin có giá trị, được gọi là trọng tải, trong nội dung thư. Bằng cách sử dụng các thuộc tính và phương pháp của Response, bạn có thể xem tải trọng ở nhiều định dạng khác nhau.

Để xem nội dung của phản hồi bytes, bạn sử dụng .content:

>>>

>>> response = requests.get('https://api.github.com')
>>> response.content
b'{"current_user_url":"https://api.github.com/user","current_user_authorizations_html_url":"https://github.com/settings/connections/applications{/client_id}","authorizations_url":"https://api.github.com/authorizations","code_search_url":"https://api.github.com/search/code?q={query}{&page,per_page,sort,order}","commit_search_url":"https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}","emails_url":"https://api.github.com/user/emails","emojis_url":"https://api.github.com/emojis","events_url":"https://api.github.com/events","feeds_url":"https://api.github.com/feeds","followers_url":"https://api.github.com/user/followers","following_url":"https://api.github.com/user/following{/target}","gists_url":"https://api.github.com/gists{/gist_id}","hub_url":"https://api.github.com/hub","issue_search_url":"https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}","issues_url":"https://api.github.com/issues","keys_url":"https://api.github.com/user/keys","notifications_url":"https://api.github.com/notifications","organization_repositories_url":"https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}","organization_url":"https://api.github.com/orgs/{org}","public_gists_url":"https://api.github.com/gists/public","rate_limit_url":"https://api.github.com/rate_limit","repository_url":"https://api.github.com/repos/{owner}/{repo}","repository_search_url":"https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}","current_user_repositories_url":"https://api.github.com/user/repos{?type,page,per_page,sort}","starred_url":"https://api.github.com/user/starred{/owner}{/repo}","starred_gists_url":"https://api.github.com/gists/starred","team_url":"https://api.github.com/teams","user_url":"https://api.github.com/users/{user}","user_organizations_url":"https://api.github.com/user/orgs","user_repositories_url":"https://api.github.com/users/{user}/repos{?type,page,per_page,sort}","user_search_url":"https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"}'

Mặc dù .contentcung cấp cho bạn quyền truy cập vào các byte thô của tải phản hồi, nhưng bạn thường sẽ muốn chuyển đổi chúng thành một chuỗi bằng cách sử dụng mã hóa ký tự như UTF-8 . responsesẽ làm điều đó cho bạn khi bạn truy cập .text:

>>>

>>> response.text
'{"current_user_url":"https://api.github.com/user","current_user_authorizations_html_url":"https://github.com/settings/connections/applications{/client_id}","authorizations_url":"https://api.github.com/authorizations","code_search_url":"https://api.github.com/search/code?q={query}{&page,per_page,sort,order}","commit_search_url":"https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}","emails_url":"https://api.github.com/user/emails","emojis_url":"https://api.github.com/emojis","events_url":"https://api.github.com/events","feeds_url":"https://api.github.com/feeds","followers_url":"https://api.github.com/user/followers","following_url":"https://api.github.com/user/following{/target}","gists_url":"https://api.github.com/gists{/gist_id}","hub_url":"https://api.github.com/hub","issue_search_url":"https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}","issues_url":"https://api.github.com/issues","keys_url":"https://api.github.com/user/keys","notifications_url":"https://api.github.com/notifications","organization_repositories_url":"https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}","organization_url":"https://api.github.com/orgs/{org}","public_gists_url":"https://api.github.com/gists/public","rate_limit_url":"https://api.github.com/rate_limit","repository_url":"https://api.github.com/repos/{owner}/{repo}","repository_search_url":"https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}","current_user_repositories_url":"https://api.github.com/user/repos{?type,page,per_page,sort}","starred_url":"https://api.github.com/user/starred{/owner}{/repo}","starred_gists_url":"https://api.github.com/gists/starred","team_url":"https://api.github.com/teams","user_url":"https://api.github.com/users/{user}","user_organizations_url":"https://api.github.com/user/orgs","user_repositories_url":"https://api.github.com/users/{user}/repos{?type,page,per_page,sort}","user_search_url":"https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"}'

Bởi vì việc giải mã bytescho một stryêu cầu một lược đồ mã hóa, requestssẽ cố gắng đoán mã hóa dựa trên các tiêu đề của phản hồi nếu bạn không chỉ định. Bạn có thể cung cấp mã hóa rõ ràng bằng cách cài đặt .encodingtrước khi truy cập .text:

>>>

>>> response.encoding = 'utf-8' # Optional: requests infers this internally
>>> response.text
'{"current_user_url":"https://api.github.com/user","current_user_authorizations_html_url":"https://github.com/settings/connections/applications{/client_id}","authorizations_url":"https://api.github.com/authorizations","code_search_url":"https://api.github.com/search/code?q={query}{&page,per_page,sort,order}","commit_search_url":"https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}","emails_url":"https://api.github.com/user/emails","emojis_url":"https://api.github.com/emojis","events_url":"https://api.github.com/events","feeds_url":"https://api.github.com/feeds","followers_url":"https://api.github.com/user/followers","following_url":"https://api.github.com/user/following{/target}","gists_url":"https://api.github.com/gists{/gist_id}","hub_url":"https://api.github.com/hub","issue_search_url":"https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}","issues_url":"https://api.github.com/issues","keys_url":"https://api.github.com/user/keys","notifications_url":"https://api.github.com/notifications","organization_repositories_url":"https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}","organization_url":"https://api.github.com/orgs/{org}","public_gists_url":"https://api.github.com/gists/public","rate_limit_url":"https://api.github.com/rate_limit","repository_url":"https://api.github.com/repos/{owner}/{repo}","repository_search_url":"https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}","current_user_repositories_url":"https://api.github.com/user/repos{?type,page,per_page,sort}","starred_url":"https://api.github.com/user/starred{/owner}{/repo}","starred_gists_url":"https://api.github.com/gists/starred","team_url":"https://api.github.com/teams","user_url":"https://api.github.com/users/{user}","user_organizations_url":"https://api.github.com/user/orgs","user_repositories_url":"https://api.github.com/users/{user}/repos{?type,page,per_page,sort}","user_search_url":"https://api.github.com/search/users?q={query}{&page,per_page,sort,order}"}'

Nếu bạn nhìn vào phản hồi, bạn sẽ thấy rằng nó thực sự là nội dung JSON được tuần tự hóa. Để lấy từ điển, bạn có thể lấy từ điển mà strbạn đã lấy .textvà giải mã hóa nó bằng cách sử dụng json.loads(). Tuy nhiên, một cách đơn giản hơn để thực hiện tác vụ này là sử dụng .json():

>>>

>>> response.json()
{'current_user_url': 'https://api.github.com/user', 'current_user_authorizations_html_url': 'https://github.com/settings/connections/applications{/client_id}', 'authorizations_url': 'https://api.github.com/authorizations', 'code_search_url': 'https://api.github.com/search/code?q={query}{&page,per_page,sort,order}', 'commit_search_url': 'https://api.github.com/search/commits?q={query}{&page,per_page,sort,order}', 'emails_url': 'https://api.github.com/user/emails', 'emojis_url': 'https://api.github.com/emojis', 'events_url': 'https://api.github.com/events', 'feeds_url': 'https://api.github.com/feeds', 'followers_url': 'https://api.github.com/user/followers', 'following_url': 'https://api.github.com/user/following{/target}', 'gists_url': 'https://api.github.com/gists{/gist_id}', 'hub_url': 'https://api.github.com/hub', 'issue_search_url': 'https://api.github.com/search/issues?q={query}{&page,per_page,sort,order}', 'issues_url': 'https://api.github.com/issues', 'keys_url': 'https://api.github.com/user/keys', 'notifications_url': 'https://api.github.com/notifications', 'organization_repositories_url': 'https://api.github.com/orgs/{org}/repos{?type,page,per_page,sort}', 'organization_url': 'https://api.github.com/orgs/{org}', 'public_gists_url': 'https://api.github.com/gists/public', 'rate_limit_url': 'https://api.github.com/rate_limit', 'repository_url': 'https://api.github.com/repos/{owner}/{repo}', 'repository_search_url': 'https://api.github.com/search/repositories?q={query}{&page,per_page,sort,order}', 'current_user_repositories_url': 'https://api.github.com/user/repos{?type,page,per_page,sort}', 'starred_url': 'https://api.github.com/user/starred{/owner}{/repo}', 'starred_gists_url': 'https://api.github.com/gists/starred', 'team_url': 'https://api.github.com/teams', 'user_url': 'https://api.github.com/users/{user}', 'user_organizations_url': 'https://api.github.com/user/orgs', 'user_repositories_url': 'https://api.github.com/users/{user}/repos{?type,page,per_page,sort}', 'user_search_url': 'https://api.github.com/search/users?q={query}{&page,per_page,sort,order}'}

Các typegiá trị trả lại .json()là một cuốn từ điển, vì vậy bạn có thể truy cập các giá trị trong đối tượng bằng chìa khóa.

Bạn có thể làm được nhiều điều với mã trạng thái và nội dung thư. Tuy nhiên, nếu bạn cần thêm thông tin, chẳng hạn như siêu dữ liệu về chính phản hồi, bạn sẽ cần xem xét các tiêu đề của phản hồi.

Tiêu đề

Tiêu đề phản hồi có thể cung cấp cho bạn thông tin hữu ích, chẳng hạn như loại nội dung của trọng tải phản hồi và giới hạn thời gian về thời gian lưu phản hồi vào bộ nhớ cache. Để xem các tiêu đề này, hãy truy cập .headers:

>>>

>>> response.headers
{'Server': 'GitHub.com', 'Date': 'Mon, 10 Dec 2018 17:49:54 GMT', 'Content-Type': 'application/json; charset=utf-8', 'Transfer-Encoding': 'chunked', 'Status': '200 OK', 'X-RateLimit-Limit': '60', 'X-RateLimit-Remaining': '59', 'X-RateLimit-Reset': '1544467794', 'Cache-Control': 'public, max-age=60, s-maxage=60', 'Vary': 'Accept', 'ETag': 'W/"7dc470913f1fe9bb6c7355b50a0737bc"', 'X-GitHub-Media-Type': 'github.v3; format=json', 'Access-Control-Expose-Headers': 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type', 'Access-Control-Allow-Origin': '*', 'Strict-Transport-Security': 'max-age=31536000; includeSubdomains; preload', 'X-Frame-Options': 'deny', 'X-Content-Type-Options': 'nosniff', 'X-XSS-Protection': '1; mode=block', 'Referrer-Policy': 'origin-when-cross-origin, strict-origin-when-cross-origin', 'Content-Security-Policy': "default-src 'none'", 'Content-Encoding': 'gzip', 'X-GitHub-Request-Id': 'E439:4581:CF2351:1CA3E06:5C0EA741'}

.headerstrả về một đối tượng giống như từ điển, cho phép bạn truy cập các giá trị tiêu đề bằng khóa. Ví dụ: để xem loại nội dung của tải phản hồi, bạn có thể truy cập Content-Type:

>>>

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

Tuy nhiên, có điều gì đó đặc biệt về đối tượng tiêu đề giống như từ điển này. Thông số HTTP xác định các tiêu đề không phân biệt chữ hoa chữ thường, có nghĩa là chúng tôi có thể truy cập các tiêu đề này mà không cần lo lắng về cách viết hoa của chúng:

>>>

>>> response.headers['content-type']
'application/json; charset=utf-8'

Cho dù bạn sử dụng chìa khóa 'content-type'hay 'Content-Type', bạn sẽ nhận được giá trị như nhau.

Bây giờ, bạn đã học những điều cơ bản về Response. Bạn đã thấy các thuộc tính và phương pháp hữu ích nhất của nó trong hoạt động. Hãy lùi lại một bước và xem phản hồi của bạn thay đổi như thế nào khi bạn tùy chỉnh các GETyêu cầu của mình.

Tham số chuỗi truy vấn

Một cách phổ biến để tùy chỉnh GETyêu cầu là chuyển các giá trị thông qua các tham số chuỗi truy vấn trong URL. Để làm điều này bằng cách sử dụng get(), bạn chuyển dữ liệu vào params. Ví dụ: bạn có thể sử dụng API Tìm kiếm của GitHub để tìm kiếm requeststhư viện:

import requests

# Search GitHub's repositories for requests
response = requests.get(
    'https://api.github.com/search/repositories',
    params={'q': 'requests+language:python'},
)

# Inspect some attributes of the `requests` repository
json_response = response.json()
repository = json_response['items'][0]
print(f'Repository name: {repository["name"]}')  # Python 3.6+
print(f'Repository description: {repository["description"]}')  # Python 3.6+

Bằng cách chuyển từ điển {'q': 'requests+language:python'}đến paramstham số của .get(), bạn có thể sửa đổi các kết quả trả về từ API Tìm kiếm.

Bạn có thể chuyển paramsđến get()dưới dạng một từ điển, như bạn vừa làm, hoặc dưới dạng danh sách các bộ giá trị:

>>>

>>> requests.get(
...     'https://api.github.com/search/repositories',
...     params=[('q', 'requests+language:python')],
... )

Bạn thậm chí có thể chuyển các giá trị dưới dạng bytes:

>>>

>>> requests.get(
...     'https://api.github.com/search/repositories',
...     params=b'q=requests+language:python',
... )

Chuỗi truy vấn rất hữu ích cho các GETyêu cầu tham số hóa . Bạn cũng có thể tùy chỉnh các yêu cầu của mình bằng cách thêm hoặc sửa đổi các tiêu đề bạn gửi.

Yêu cầu tiêu đề

Để tùy chỉnh tiêu đề, bạn chuyển một từ điển tiêu đề HTTP để get()sử dụng headerstham số. Ví dụ: bạn có thể thay đổi yêu cầu tìm kiếm trước đó của mình để làm nổi bật các cụm từ tìm kiếm phù hợp trong kết quả bằng cách chỉ định text-matchloại phương tiện trong Accepttiêu đề:

import requests

response = requests.get(
    'https://api.github.com/search/repositories',
    params={'q': 'requests+language:python'},
    headers={'Accept': 'application/vnd.github.v3.text-match+json'},
)

# View the new `text-matches` array which provides information
# about your search term within the results
json_response = response.json()
repository = json_response['items'][0]
print(f'Text matches: {repository["text_matches"]}')

Các Accepttiêu đề nói với máy chủ những loại nội dung ứng dụng của bạn có thể xử lý. Trong trường hợp này, vì bạn đang mong đợi các cụm từ tìm kiếm phù hợp được đánh dấu, bạn đang sử dụng giá trị tiêu đề application/vnd.github.v3.text-match+json, là Accepttiêu đề GitHub độc quyền trong đó nội dung có định dạng JSON đặc biệt.

Trước khi bạn tìm hiểu thêm các cách tùy chỉnh yêu cầu, hãy mở rộng tầm nhìn bằng cách khám phá các phương thức HTTP khác.

Các phương thức HTTP khác

Bên cạnh GET, phương thức HTTP phổ biến khác bao gồm POST, PUT, DELETE, HEAD, PATCH, và OPTIONS. requestscung cấp một phương thức, với một chữ ký tương tự get(), cho mỗi phương thức HTTP sau:

>>>

>>> requests.post('https://httpbin.org/post', data={'key':'value'})
>>> requests.put('https://httpbin.org/put', data={'key':'value'})
>>> requests.delete('https://httpbin.org/delete')
>>> requests.head('https://httpbin.org/get')
>>> requests.patch('https://httpbin.org/patch', data={'key':'value'})
>>> requests.options('https://httpbin.org/get')

Mỗi lệnh gọi hàm thực hiện một yêu cầu tới httpbindịch vụ bằng cách sử dụng phương thức HTTP tương ứng. Đối với mỗi phương pháp, bạn có thể kiểm tra phản hồi của họ giống như cách bạn đã làm trước đây:

>>>

>>> response = requests.head('https://httpbin.org/get')
>>> response.headers['Content-Type']
'application/json'

>>> response = requests.delete('https://httpbin.org/delete')
>>> json_response = response.json()
>>> json_response['args']
{}

Tiêu đề, nội dung phản hồi, mã trạng thái và hơn thế nữa được trả về Responsecho mỗi phương thức. Tiếp theo bạn sẽ có một cái nhìn sâu hơn về các POST, PUTvà PATCHcác phương pháp và tìm hiểu cách họ khác với các loại yêu cầu khác.

Nội dung thư

Theo đặc tả HTTP, POST, PUT, và ít phổ biến PATCHyêu cầu truyền dữ liệu của mình thông qua nội dung thư chứ không phải thông qua các thông số trong chuỗi truy vấn. Khi sử dụng requests, bạn sẽ chuyển tải trọng cho datatham số của hàm tương ứng .

datalấy từ điển, danh sách các bộ giá trị, byte hoặc một đối tượng giống tệp. Bạn sẽ muốn điều chỉnh dữ liệu bạn gửi trong nội dung yêu cầu của mình cho phù hợp với nhu cầu cụ thể của dịch vụ mà bạn đang tương tác.

Ví dụ: nếu loại nội dung yêu cầu của bạn là application/x-www-form-urlencoded, bạn có thể gửi dữ liệu biểu mẫu dưới dạng từ điển:

>>>

>>> requests.post('https://httpbin.org/post', data={'key':'value'})

Bạn cũng có thể gửi cùng một dữ liệu đó dưới dạng danh sách các bộ giá trị:

>>>

>>> requests.post('https://httpbin.org/post', data=[('key', 'value')])

Tuy nhiên, nếu bạn cần gửi dữ liệu JSON, bạn có thể sử dụng jsontham số. Khi bạn chuyển dữ liệu JSON qua json, requestssẽ tuần tự hóa dữ liệu của bạn và thêm Content-Typetiêu đề chính xác cho bạn.

httpbin.org là một tài nguyên tuyệt vời được tạo ra bởi tác giả của requests, Kenneth Reitz . Đó là một dịch vụ chấp nhận các yêu cầu kiểm tra và phản hồi với dữ liệu về các yêu cầu. Ví dụ: bạn có thể sử dụng nó để kiểm tra một POSTyêu cầu cơ bản :

>>>

>>> response = requests.post('https://httpbin.org/post', json={'key':'value'})
>>> json_response = response.json()
>>> json_response['data']
'{"key": "value"}'
>>> json_response['headers']['Content-Type']
'application/json'

Bạn có thể thấy từ phản hồi rằng máy chủ đã nhận được dữ liệu và tiêu đề yêu cầu của bạn khi bạn gửi chúng. requestscũng cung cấp thông tin này cho bạn dưới dạng a PreparedRequest.

Kiểm tra yêu cầu của bạn

Khi bạn thực hiện một yêu cầu, requeststhư viện sẽ chuẩn bị yêu cầu trước khi thực sự gửi nó đến máy chủ đích. Chuẩn bị yêu cầu bao gồm những thứ như xác thực tiêu đề và tuần tự hóa nội dung JSON.

Bạn có thể xem PreparedRequestbằng cách truy cập .request:

>>>

>>> response = requests.post('https://httpbin.org/post', json={'key':'value'})
>>> response.request.headers['Content-Type']
'application/json'
>>> response.request.url
'https://httpbin.org/post'
>>> response.request.body
b'{"key": "value"}'

Kiểm tra PreparedRequestcung cấp cho bạn quyền truy cập vào tất cả các loại thông tin về yêu cầu đang được thực hiện như trọng tải, URL, tiêu đề, xác thực và hơn thế nữa.

Cho đến nay, bạn đã thực hiện rất nhiều loại yêu cầu khác nhau, nhưng chúng đều có một điểm chung: chúng là những yêu cầu chưa được xác thực đối với các API công khai. Nhiều dịch vụ bạn có thể gặp sẽ muốn bạn xác thực theo một cách nào đó.

Xác thực

Xác thực giúp dịch vụ hiểu bạn là ai. Thông thường, bạn cung cấp thông tin xác thực của mình cho máy chủ bằng cách chuyển dữ liệu qua Authorizationtiêu đề hoặc tiêu đề tùy chỉnh do dịch vụ xác định. Tất cả các hàm yêu cầu mà bạn đã thấy cho đến thời điểm này đều cung cấp một tham số được gọi là auth, cho phép bạn chuyển thông tin đăng nhập của mình.

Một ví dụ về API yêu cầu xác thực là API người dùng được xác thực của GitHub . Điểm cuối này cung cấp thông tin về hồ sơ của người dùng đã được xác thực. Để thực hiện yêu cầu đối với API người dùng được xác thực, bạn có thể chuyển tên người dùng và mật khẩu GitHub của mình trong một bộ mã tới get():

>>>

>>> from getpass import getpass
>>> requests.get('https://api.github.com/user', auth=('username', getpass()))

Yêu cầu đã thành công nếu thông tin xác thực bạn đã chuyển trong tuple đến authlà hợp lệ. Nếu bạn cố gắng thực hiện yêu cầu này mà không có thông tin đăng nhập, bạn sẽ thấy rằng mã trạng thái là 401 Unauthorized:

>>>

>>> requests.get('https://api.github.com/user')

Khi bạn chuyển tên người dùng và mật khẩu của mình trong một bộ vào auththam số, bạn requestsđang áp dụng thông tin đăng nhập bằng cách sử dụng lược đồ xác thực quyền truy cập Cơ bản của HTTP .

Do đó, bạn có thể đưa ra yêu cầu tương tự bằng cách chuyển thông tin xác thực Cơ bản rõ ràng bằng cách sử dụng HTTPBasicAuth:

>>>

>>> from requests.auth import HTTPBasicAuth
>>> from getpass import getpass
>>> requests.get(
...     'https://api.github.com/user',
...     auth=HTTPBasicAuth('username', getpass())
... )

Mặc dù bạn không cần phải xác thực rõ ràng đối với Xác thực cơ bản, nhưng bạn có thể muốn xác thực bằng một phương pháp khác. requestscung cấp các phương pháp xác thực khác như HTTPDigestAuthvà HTTPProxyAuth.

Bạn thậm chí có thể cung cấp cơ chế xác thực của riêng mình. Để làm như vậy, trước tiên bạn phải tạo một lớp con của AuthBase. Sau đó, bạn triển khai __call__():

import requests
from requests.auth import AuthBase

class TokenAuth(AuthBase):
    """Implements a custom authentication scheme."""

    def __init__(self, token):
        self.token = token

    def __call__(self, r):
        """Attach an API token to a custom auth header."""
        r.headers['X-TokenAuth'] = f'{self.token}'  # Python 3.6+
        return r


requests.get('https://httpbin.org/get', auth=TokenAuth('12345abcde-token'))

Tại đây, TokenAuthcơ chế tùy chỉnh của bạn nhận được mã thông báo, sau đó đưa mã thông báo đó vào X-TokenAuthtiêu đề yêu cầu của bạn.

Cơ chế xác thực kém có thể dẫn đến lỗ hổng bảo mật, vì vậy trừ khi một dịch vụ yêu cầu cơ chế xác thực tùy chỉnh vì lý do nào đó, bạn sẽ luôn muốn sử dụng lược đồ xác thực đã thử và đúng như Basic hoặc OAuth.

Trong khi bạn đang suy nghĩ về bảo mật, hãy xem xét xử lý Chứng chỉ SSL bằng cách sử dụng requests.

Xác minh chứng chỉ SSL

Bất kỳ lúc nào dữ liệu bạn đang cố gắng gửi hoặc nhận là nhạy cảm, bảo mật là rất quan trọng. Cách bạn giao tiếp với các trang web an toàn qua HTTP là thiết lập kết nối được mã hóa bằng SSL, có nghĩa là việc xác minh Chứng chỉ SSL của máy chủ mục tiêu là rất quan trọng.

Tin tốt là nó requestslàm điều này cho bạn theo mặc định. Tuy nhiên, có một số trường hợp bạn có thể muốn thay đổi hành vi này.

Nếu bạn muốn tắt xác minh Chứng chỉ SSL, bạn chuyển Falseđến verifytham số của hàm yêu cầu:

>>>

>>> requests.get('https://api.github.com', verify=False)
InsecureRequestWarning: Unverified HTTPS request is being made. Adding certificate verification is strongly advised. See: https://urllib3.readthedocs.io/en/latest/advanced-usage.html#ssl-warnings
  InsecureRequestWarning)

requests thậm chí cảnh báo bạn khi bạn đưa ra một yêu cầu không an toàn để giúp bạn giữ an toàn cho dữ liệu của mình!

Lưu ý: requestssử dụng một gói được gọicertifi để cung cấp cho Tổ chức phát hành chứng chỉ. Điều này cho requestsbiết nó có thể tin tưởng vào cơ quan nào. Do đó, bạn nên cập nhật certifithường xuyên để giữ cho các kết nối của mình an toàn nhất có thể.

Hiệu suất

Khi sử dụng requests, đặc biệt là trong môi trường ứng dụng sản xuất, điều quan trọng là phải xem xét các tác động về hiệu suất. Các tính năng như kiểm soát thời gian chờ, phiên và giới hạn thử lại có thể giúp bạn giữ cho ứng dụng của mình hoạt động trơn tru.

Hết giờ

Khi bạn thực hiện một yêu cầu nội tuyến đối với một dịch vụ bên ngoài, hệ thống của bạn sẽ cần phải đợi phản hồi trước khi tiếp tục. Nếu ứng dụng của bạn đợi phản hồi đó quá lâu, các yêu cầu tới dịch vụ của bạn có thể sao lưu, trải nghiệm người dùng của bạn có thể bị ảnh hưởng hoặc các công việc nền của bạn có thể bị treo.

Theo mặc định, requestssẽ đợi phản hồi vô thời hạn, vì vậy bạn hầu như luôn phải chỉ định khoảng thời gian chờ để ngăn những điều này xảy ra. Để đặt thời gian chờ của yêu cầu, hãy sử dụng timeouttham số. timeoutcó thể là số nguyên hoặc số thực thể hiện số giây chờ phản hồi trước khi hết thời gian:

>>>

>>> requests.get('https://api.github.com', timeout=1)

>>> requests.get('https://api.github.com', timeout=3.05)

Trong yêu cầu đầu tiên, yêu cầu sẽ hết thời gian chờ sau 1 giây. Trong yêu cầu thứ hai, yêu cầu sẽ hết thời gian chờ sau 3,05 giây.

Bạn cũng có thể chuyển một bộ tuple tới timeoutvới phần tử đầu tiên là thời gian chờ kết nối (thời gian nó cho phép máy khách thiết lập kết nối với máy chủ) và phần tử thứ hai là thời gian chờ đọc (thời gian nó sẽ đợi phản hồi khi bạn khách hàng đã thiết lập kết nối):

>>>

>>> requests.get('https://api.github.com', timeout=(2, 5))

Nếu yêu cầu thiết lập kết nối trong vòng 2 giây và nhận dữ liệu trong vòng 5 giây kể từ khi kết nối được thiết lập, thì phản hồi sẽ được trả về như trước đó. Nếu hết thời gian yêu cầu, thì hàm sẽ đưa ra một Timeoutngoại lệ:

import requests
from requests.exceptions import Timeout

try:
    response = requests.get('https://api.github.com', timeout=1)
except Timeout:
    print('The request timed out')
else:
    print('The request did not time out')

Chương trình của bạn có thể bắt được Timeoutngoại lệ và phản hồi tương ứng.

Đối tượng phiên

Cho đến bây giờ, bạn đã xử lý requestscác API cấp cao như get()và post(). Các hàm này là những phần tóm tắt của những gì đang diễn ra khi bạn thực hiện các yêu cầu của mình. Chúng ẩn các chi tiết triển khai chẳng hạn như cách các kết nối được quản lý để bạn không phải lo lắng về chúng.

Bên dưới những phần trừu tượng đó là một lớp được gọi Session. Nếu bạn cần tinh chỉnh quyền kiểm soát của mình đối với cách các yêu cầu đang được thực hiện hoặc cải thiện hiệu suất của các yêu cầu, bạn có thể cần sử dụng Sessiontrực tiếp một phiên bản.

Phiên được sử dụng để duy trì các thông số trên các yêu cầu. Ví dụ: nếu bạn muốn sử dụng cùng một xác thực cho nhiều yêu cầu, bạn có thể sử dụng một phiên:

import requests
from getpass import getpass

# By using a context manager, you can ensure the resources used by
# the session will be released after use
with requests.Session() as session:
    session.auth = ('username', getpass())

    # Instead of requests.get(), you'll use session.get()
    response = session.get('https://api.github.com/user')

# You can inspect the response just like you did before
print(response.headers)
print(response.json())

Mỗi khi bạn thực hiện một yêu cầu session, khi nó đã được khởi tạo bằng thông tin xác thực, thông tin xác thực đó sẽ được duy trì.

Việc tối ưu hóa hiệu suất chính của các phiên ở dạng kết nối liên tục. Khi ứng dụng của bạn tạo kết nối với máy chủ bằng cách sử dụng a Session, ứng dụng sẽ giữ kết nối đó trong một nhóm kết nối. Khi ứng dụng của bạn muốn kết nối lại với cùng một máy chủ, ứng dụng sẽ sử dụng lại kết nối từ nhóm thay vì thiết lập một kết nối mới.

Số lần thử tối đa

Khi một yêu cầu không thành công, bạn có thể muốn ứng dụng của mình thử lại cùng một yêu cầu. Tuy nhiên, requestssẽ không làm điều này cho bạn theo mặc định. Để áp dụng chức năng này, bạn cần triển khai Bộ điều hợp truyền tải tùy chỉnh .

Bộ điều hợp Giao thông cho phép bạn xác định một tập hợp các cấu hình cho mỗi dịch vụ mà bạn đang tương tác. Ví dụ: giả sử bạn muốn tất cả các yêu cầu https://api.github.comthử lại ba lần trước khi cuối cùng tăng a ConnectionError. Bạn sẽ xây dựng Bộ điều hợp truyền tải, đặt max_retriesthông số của nó và gắn nó vào một bộ điều hợp hiện có Session:

import requests
from requests.adapters import HTTPAdapter
from requests.exceptions import ConnectionError

github_adapter = HTTPAdapter(max_retries=3)

session = requests.Session()

# Use `github_adapter` for all requests to endpoints that start with this URL
session.mount('https://api.github.com', github_adapter)

try:
    session.get('https://api.github.com')
except ConnectionError as ce:
    print(ce)

Khi bạn gắn kết HTTPAdapter, github_adapterđể session, sessionsẽ tuân thủ cấu hình của nó cho mỗi yêu cầu để https://api.github.com.

Thời gian chờ, Bộ điều hợp truyền tải và phiên là để giữ cho mã của bạn hiệu quả và ứng dụng của bạn có khả năng phục hồi.

Phần kết luận

Bạn đã trải qua một chặng đường dài trong việc tìm hiểu về requeststhư viện mạnh mẽ của Python .

Bây giờ bạn có thể:

• Yêu cầu Make sử dụng một loạt các phương pháp HTTP khác nhau như GET, POST, vàPUT
• Tùy chỉnh yêu cầu của bạn bằng cách sửa đổi tiêu đề, xác thực, chuỗi truy vấn và nội dung thư
• Kiểm tra dữ liệu bạn gửi đến máy chủ và dữ liệu máy chủ gửi lại cho bạn
• Làm việc với xác minh Chứng chỉ SSL
• Sử dụng requestshiệu quả sử dụng max_retries, timeout, phiên, và Giao thông vận tải Adapters

Bởi vì bạn đã học cách sử dụng requests, bạn được trang bị để khám phá thế giới rộng lớn của các dịch vụ web và xây dựng các ứng dụng tuyệt vời bằng cách sử dụng dữ liệu hấp dẫn mà họ cung cấp.