App Engine Python SDK  v1.6.9 rev.445
The Python runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
google.appengine.tools.appengine_rpc.AbstractRpcServer Class Reference
Inheritance diagram for google.appengine.tools.appengine_rpc.AbstractRpcServer:
google.appengine.tools.appengine_rpc.HttpRpcServer google.appengine.tools.appengine_rpc.HttpRpcServerWithOAuth2Suggestion

Public Member Functions

def __init__
 
def Send
 

Public Attributes

 scheme
 
 ignore_certs
 
 host
 
 host_override
 
 auth_function
 
 source
 
 authenticated
 
 auth_tries
 
 debug_data
 
 rpc_tries
 
 account_type
 
 extra_headers
 
 save_cookies
 
 cookie_jar
 
 opener
 

Static Public Attributes

 SUGGEST_OAUTH2 = False
 
string RUNTIME = "python"
 

Detailed Description

Provides a common interface for a simple RPC server.

Constructor & Destructor Documentation

def google.appengine.tools.appengine_rpc.AbstractRpcServer.__init__ (   self,
  host,
  auth_function,
  user_agent,
  source,
  host_override = None,
  extra_headers = None,
  save_cookies = False,
  auth_tries = 3,
  account_type = None,
  debug_data = True,
  secure = True,
  ignore_certs = False,
  rpc_tries = 3 
)
Creates a new HttpRpcServer.

Args:
  host: The host to send requests to.
  auth_function: A function that takes no arguments and returns an
(email, password) tuple when called. Will be called if authentication
is required.
  user_agent: The user-agent string to send to the server. Specify None to
omit the user-agent header.
  source: The source to specify in authentication requests.
  host_override: The host header to send to the server (defaults to host).
  extra_headers: A dict of extra headers to append to every request. Values
supplied here will override other default headers that are supplied.
  save_cookies: If True, save the authentication cookies to local disk.
If False, use an in-memory cookiejar instead.  Subclasses must
implement this functionality.  Defaults to False.
  auth_tries: The number of times to attempt auth_function before failing.
  account_type: One of GOOGLE, HOSTED_OR_GOOGLE, or None for automatic.
  debug_data: Whether debugging output should include data contents.
  secure: If the requests sent using Send should be sent over HTTPS.
  ignore_certs: If the certificate mismatches should be ignored.
  rpc_tries: The number of rpc retries upon http server error (i.e.
Response code >= 500 and < 600) before failing.

Member Function Documentation

def google.appengine.tools.appengine_rpc.AbstractRpcServer.Send (   self,
  request_path,
  payload = "",
  content_type = "application/octet-stream",
  timeout = None,
  kwargs 
)
Sends an RPC and returns the response.

Args:
  request_path: The path to send the request to, eg /api/appversion/create.
  payload: The body of the request, or None to send an empty request.
  content_type: The Content-Type header to use.
  timeout: timeout in seconds; default None i.e. no timeout.
(Note: for large requests on OS X, the timeout doesn't work right.)
  kwargs: Any keyword arguments are converted into query string parameters.

Returns:
  The response body, as a string.

The documentation for this class was generated from the following file: