Package apiclient :: Module http |
[hide private]
[frames] | no frames]

# Module http

source code

    Classes to encapsulate a single HTTP request.

    The classes implement a command pattern, with every
    object supporting an execute() method that does the
    actuall HTTP request.

Author: jcgregorio@google.com (Joe Gregorio)

Classes | [hide private]
| MediaUploadProgress Status of a resumable upload.
| MediaDownloadProgress Status of a resumable download.
| MediaUpload Describes a media object to upload.
| MediaIoBaseUpload A MediaUpload for a io.Base objects.
| MediaFileUpload A MediaUpload for a file.
| MediaInMemoryUpload MediaUpload for a chunk of bytes.
| MediaIoBaseDownload "Download media resources.
| _StreamSlice Truncated stream.
| HttpRequest Encapsulates a single HTTP request.
| BatchHttpRequest Batches multiple HttpRequest objects into a single HTTP request.
| HttpRequestMock Mock of HttpRequest.
| RequestMockBuilder A simple mock of HttpRequest
| HttpMock Mock of httplib2.Http
| HttpMockSequence Mock of httplib2.Http

Functions | [hide private]
set_user_agent(http, user_agent) Set the user-agent on every request. | source code
tunnel_patch(http) Tunnel PATCH requests over POST. | source code

Variables | [hide private]
| DEFAULT_CHUNK_SIZE = `512* 1024`
| MAX_URI_LENGTH = `2048`

Function Details | [hide private]

### set_user_agent(http, user_agent) | source code
    Set the user-agent on every request.

    Args:
       http - An instance of httplib2.Http
           or something that acts like it.
       user_agent: string, the value for the user-agent header.

    Returns:
       A modified instance of http that was passed in.

    Example:

      h = httplib2.Http()
      h = set_user_agent(h, "my-app-name/6.0")

    Most of the time the user-agent will be set doing auth, this is for the rare
    cases where you are accessing an unauthenticated endpoint.

### tunnel_patch(http) | source code
    Tunnel PATCH requests over POST.
    Args:
       http - An instance of httplib2.Http
           or something that acts like it.

    Returns:
       A modified instance of http that was passed in.

    Example:

      h = httplib2.Http()
      h = tunnel_patch(h, "my-app-name/6.0")

    Useful if you are running on a platform that doesn't support PATCH.
    Apply this last if you are using OAuth 1.0, as changing the method
    will result in a different signature.