Hướng dẫn python requests list - danh sách yêu cầu python
Nội dung chính Nội dung chính Bắt đầu với requests Các 4thư 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.
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 Bắt đầu với requestsCác 4thư 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 4phả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 4mộ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 Yêu cầu GETTù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. Phản hồiBâ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 4trong ứng dụng của mình!Đị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. Mã trạng tháiBâ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 4trong ứng dụng của mình!Hãy bắt đầu bằng cách cài đặt 4thư 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: >>>
2trả về a 4, 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:
Với logic này, nếu máy chủ trả về 4mã trạng thái, chương trình của bạn sẽ in 6 . Nếu kết quả là a 7, chương trình của bạn sẽ in 8.
4tiế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 3thể hiện trong biểu thức điều kiện, nó sẽ đánh giá 1xem mã trạng thái có nằm giữa 4và 3và 4nế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 5câu lệnh:
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 4. Lý do cho điều này là các mã trạng thái khác trong phạm vi 4tới 3, chẳng hạn như 9và 0, 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ụ: 1câ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 5câ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 3:
Nếu bạn gọi 3, một 5sẽ đượ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 2yê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 dungPhản hồi của một 2yê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 3, 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 9, bạn sử dụng 0:>>>
Mặc dù 0cung 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 . 6sẽ làm điều đó cho bạn khi bạn truy cập 3:>>>
Bởi vì việc giải mã 9cho một 5yêu cầu một lược đồ mã hóa, 4sẽ 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 7trước khi truy cập 3:>>>
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à 5bạn đã lấy 3và giải mã hóa nó bằng cách sử dụng 01. 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 02: >>> 0Các 03giá trị trả lại 02là 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 05:>>> 1 05trả 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 07:>>> 2Tuy 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: >>> 3Cho dù bạn sử dụng chìa khóa 08hay 09, 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ề 3. 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 2yêu cầu của mình.Tham số chuỗi truy vấnMột cách phổ biến để tùy chỉnh 2yê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 2, bạn chuyển dữ liệu vào 14. Ví dụ: bạn có thể sử dụng API Tìm kiếm của GitHub để tìm kiếm 4thư viện: 4Bằng cách chuyển từ điển 16đến 14tham số của 18, 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 14đến 2dướ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ị:>>> 5Bạn thậm chí có thể chuyển các giá trị dưới dạng 9:>>> 6Chuỗi truy vấn rất hữu ích cho các 2yê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 để 2sử dụng 24tham 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 25loại phương tiện trong 26tiêu đề: 7Các 26tiê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 đề 28, là 26tiê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ácBên cạnh 2, phương thức HTTP phổ biến khác bao gồm 4, 32, 33, 34, 35, và 36. 4cung cấp một phương thức, với một chữ ký tương tự 2, cho mỗi phương thức HTTP sau:>>> 8Mỗi lệnh gọi hàm thực hiện một yêu cầu tới 39dị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:>>> 9Tiêu đề, nội dung phản hồi, mã trạng thái và hơn thế nữa được trả về 3cho 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 4, 32và 35cá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, 4, 32, và ít phổ biến 35yê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 4, bạn sẽ chuyển tải trọng cho 48tham số của hàm tương ứng . 48lấ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à 50, bạn có thể gửi dữ liệu biểu mẫu dưới dạng từ điển:>>> 0Bạ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ị: >>> 1Tuy nhiên, nếu bạn cần gửi dữ liệu JSON, bạn có thể sử dụng 51tham số. Khi bạn chuyển dữ liệu JSON qua 51, 4sẽ tuần tự hóa dữ liệu của bạn và thêm 07tiê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 4, 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 4yêu cầu cơ bản :>>> 2Bạ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. 4cũng cung cấp thông tin này cho bạn dưới dạng a 58.Kiểm tra yêu cầu của bạnKhi bạn thực hiện một yêu cầu, 4thư 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 58bằng cách truy cập 61:
>>> 3Kiểm tra 58cung 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ựcXá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 63tiê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à 64, 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 2:>>> 4Yêu cầu đã thành công nếu thông tin xác thực bạn đã chuyển trong tuple đến 64là 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à 67:>>> 5Khi 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 64tham số, bạn 4đ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 70:>>> 6Mặ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. 4cung cấp các phương pháp xác thực khác như 72và 73.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 74. Sau đó, bạn triển khai 75: 7Tại đây, 76cơ 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 77tiê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 4.Xác minh chứng chỉ SSLBấ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ó 4là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 4đến 81tham số của hàm yêu cầu:>>> 8 4 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 ý: 4sử dụng một gói được gọi 84 để cung cấp cho Tổ chức phát hành chứng chỉ. Điều này cho 4biết nó có thể tin tưởng vào cơ quan nào. Do đó, bạn nên cập nhật 84thườ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ấtKhi sử dụng 4, đặ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, 4sẽ đợ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 89tham số. 89có 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:>>> 9Trong 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 89vớ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):>>> 0Trong 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. 1Bạn cũng có thể chuyển một bộ tuple tới 89vớ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):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 >>> requests.get('https://api.github.com')
|