Basics HTTP. requests. Ryan E. Freckleton. PySprings. May 24, 2016

Transcription

1 PySprings May 24, 2016

2 >>> import r e q u e s t s >>> r = r e q u e s t s. g e t ( h t t p s : / / a p i. g i t h u b. com/ u s e r, auth=( u s e r, p a s s ) ) >>> r. status_code 401 >>> r. h e a d e r s [ content t y p e ] a p p l i c a t i o n / j s o n ; c h a r s e t=u t f 8 >>> r. e n c o d i n g u t f 8 >>> r. t e x t u {" message " : " Bad c r e d e n t i a l s "," documentation_url " : " h t t p s : / / d e v e l o p e r. g i t h u b. com/ v3 "} >>> r. j s o n ( ) {u documentation_url : u h t t p s : / / d e v e l o p e r. g i t h u b. com/ v3, u message : u Bad c r e d e n t i a l s }

3 hypertext transfer protocol Line oriented Synchronous Request GET / /1.1 Accept : */* Accept - Encoding : gzip, deflate Connection : keep - alive Host : example. com User - Agent : ie /0.9.3

4 Response / OK Accept Ranges : b y t e s Cache C o n t r o l : max age = Content Encoding : g z i p Content Length : 606 Content Type : t e x t / html Date : Tue, 24 May : 2 2 : 1 9 GMT Etag : " g z i p " E x p i r e s : Tue, 31 May : 2 2 : 1 9 GMT Last M o d i f i e d : F r i, 09 Aug : 5 4 : 3 5 GMT S e r v e r : ECS ( dfw /278C) Vary : Accept Encoding X Cache : HIT x ec custom e r r o r : 1 <! doctype html>...

5 in Detail Request request line GET }{{} verb header field URI {}}{ / /1.1 }{{} protocol field name {}}{ Host : example.com }{{} field value

6 Response response line /1.1 }{{} protocol header field status code {}}{ 200 }{{} OK reason field name {}}{ Content Encoding : gzip }{{} field value

7 Example Verbs verbs (GET, POST, HEAD, OPTIONS, PATCH, POST, PUT, DELETE) map to functions. import r =. options ( http :// httpbin. org / get / ) print (r. headers [ Allow ]) # HEAD, OPTIONS, GET

8 Parameters Values in the params keyword argument automatically get encoded into URLs. Example import params = { text : Help me, woman! there is an angry bee within my hat who is not my friend. } r =. get ( http :// isithackday. com / arrpi. php, params = params ) print (r. text ) # Help me, wench! there be an angry bee within my hat who be not my mate.

9 Example Headers can be added through the headers keyword parameter. E.g. import headers = { user - agent : pysprings - example ) } r =. get ( http :// reddit. com /r/ aww / hot. json, headers = headers ) print (r. json ()) r. json () #... lots of json

10 Request Authentication handles authentication through the AuthBase class. There are several existing version (OAuth1, Basic Authentication, Kerberos). Example import r =. get ( http :// httpbin. org / basic - auth / user / passwd, auth =. auth. BasicAuth ( user, passwd )) print (r. json ()) # { authenticated : True, user : user }

11 Request Redirects are automatically handled by and stored in the history attribute of responses. Example import r =. get ( http :// github. com ) print (r. url ) print (r. status_code ) print (r. history ) # https :// github. com / # 200 # [< Response [301] >]

12 Web APIs reddit Yahoo weather It s this for that More from reddit