Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

# -*- coding: utf-8 -*- 

 

""" 

requests.api 

~~~~~~~~~~~~ 

 

This module implements the Requests API. 

 

:copyright: (c) 2012 by Kenneth Reitz. 

:license: Apache2, see LICENSE for more details. 

 

""" 

 

from . import sessions 

 

 

def request(method, url, **kwargs): 

    """Constructs and sends a :class:`Request <Request>`. 

    Returns :class:`Response <Response>` object. 

 

    :param method: method for the new :class:`Request` object. 

    :param url: URL for the new :class:`Request` object. 

    :param params: (optional) Dictionary or bytes to be sent in the query string for the :class:`Request`. 

    :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. 

    :param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`. 

    :param cookies: (optional) Dict or CookieJar object to send with the :class:`Request`. 

    :param files: (optional) Dictionary of 'name': file-like-objects (or {'name': ('filename', fileobj)}) for multipart encoding upload. 

    :param auth: (optional) Auth tuple to enable Basic/Digest/Custom HTTP Auth. 

    :param timeout: (optional) Float describing the timeout of the request in seconds. 

    :param allow_redirects: (optional) Boolean. Set to True if POST/PUT/DELETE redirect following is allowed. 

    :param proxies: (optional) Dictionary mapping protocol to the URL of the proxy. 

    :param verify: (optional) if ``True``, the SSL cert will be verified. A CA_BUNDLE path can also be provided. 

    :param stream: (optional) if ``False``, the response content will be immediately downloaded. 

    :param cert: (optional) if String, path to ssl client cert file (.pem). If Tuple, ('cert', 'key') pair. 

 

    Usage:: 

 

      >>> import requests 

      >>> req = requests.request('GET', 'http://httpbin.org/get') 

      <Response [200]> 

    """ 

 

    session = sessions.Session() 

    return session.request(method=method, url=url, **kwargs) 

 

 

def get(url, **kwargs): 

    """Sends a GET request. Returns :class:`Response` object. 

 

    :param url: URL for the new :class:`Request` object. 

    :param \*\*kwargs: Optional arguments that ``request`` takes. 

    """ 

 

    kwargs.setdefault('allow_redirects', True) 

    return request('get', url, **kwargs) 

 

 

def options(url, **kwargs): 

    """Sends a OPTIONS request. Returns :class:`Response` object. 

 

    :param url: URL for the new :class:`Request` object. 

    :param \*\*kwargs: Optional arguments that ``request`` takes. 

    """ 

 

    kwargs.setdefault('allow_redirects', True) 

    return request('options', url, **kwargs) 

 

 

def head(url, **kwargs): 

    """Sends a HEAD request. Returns :class:`Response` object. 

 

    :param url: URL for the new :class:`Request` object. 

    :param \*\*kwargs: Optional arguments that ``request`` takes. 

    """ 

 

    kwargs.setdefault('allow_redirects', False) 

    return request('head', url, **kwargs) 

 

 

def post(url, data=None, **kwargs): 

    """Sends a POST request. Returns :class:`Response` object. 

 

    :param url: URL for the new :class:`Request` object. 

    :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. 

    :param \*\*kwargs: Optional arguments that ``request`` takes. 

    """ 

 

    return request('post', url, data=data, **kwargs) 

 

 

def put(url, data=None, **kwargs): 

    """Sends a PUT request. Returns :class:`Response` object. 

 

    :param url: URL for the new :class:`Request` object. 

    :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. 

    :param \*\*kwargs: Optional arguments that ``request`` takes. 

    """ 

 

    return request('put', url, data=data, **kwargs) 

 

 

def patch(url, data=None, **kwargs): 

    """Sends a PATCH request. Returns :class:`Response` object. 

 

    :param url: URL for the new :class:`Request` object. 

    :param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`. 

    :param \*\*kwargs: Optional arguments that ``request`` takes. 

    """ 

 

    return request('patch', url,  data=data, **kwargs) 

 

 

def delete(url, **kwargs): 

    """Sends a DELETE request. Returns :class:`Response` object. 

 

    :param url: URL for the new :class:`Request` object. 

    :param \*\*kwargs: Optional arguments that ``request`` takes. 

    """ 

 

    return request('delete', url, **kwargs)