Index: docs/epy/apiclient.discovery-module.html =================================================================== new file mode 100644 --- /dev/null +++ b/docs/epy/apiclient.discovery-module.html @@ -0,0 +1,698 @@ + + + +
+Trees | + + +Indices | + + +Help | + ++ |
---|
+ | + +
+ |
+
+Client for discovery based APIs + +A client library for Google's discovery based APIs. + ++ +
Author: + jcgregorio@google.com (Joe Gregorio) +
+
+
|
+|||
+ + |
+
|
+ ||
+ + |
+
|
+ ||
+ + |
+
|
+ ||
+ + |
+
|
+ ||
+ + |
+
|
+ ||
+ + |
+
|
+ ||
+ + |
+
|
+ ||
+ + |
+
|
+ ||
+ + |
+
|
+
+
|
+|||
+ + |
+ logger = logging.getLogger(__name__)
+ |
+ ||
+ + |
+ URITEMPLATE = re.compile(r'\{
+ |
+ ||
+ + |
+ VARNAME = re.compile(r'
+ |
+ ||
+ + |
+ DISCOVERY_URI =
+ |
+ ||
+ + |
+ DEFAULT_METHOD_DOC =
+ |
+ ||
+ + |
+ STACK_QUERY_PARAMETERS =
+ |
+ ||
+ + |
+ RESERVED_WORDS =
+ |
+ ||
+ + |
+ MULTIPLIERS =
+ |
+ ||
+ + |
+ __package__ =
+ |
+
+
|
+
+
+Adds a query parameter to a url. + +Replaces the current value if it already exists in the URL. + +Args: + url: string, url to add the query parameter to. + name: string, query parameter name. + value: string, query parameter value. + +Returns: + Updated query parameter. Does not update the url if value is None. + ++
|
+
+Converts key names into parameter names. + +For example, converting "max-results" -> "max_results" + ++
|
+
+Construct a Resource for interacting with an API. + +Construct a Resource object for interacting with +an API. The serviceName and version are the +names from the Discovery service. + +Args: + serviceName: string, name of the service + version: string, the version of the service + http: httplib2.Http, An instance of httplib2.Http or something that acts + like it that HTTP requests will be made through. + discoveryServiceUrl: string, a URI Template that points to + the location of the discovery service. It should have two + parameters {api} and {apiVersion} that when filled in + produce an absolute URI to the discovery document for + that service. + developerKey: string, key obtained + from https://code.google.com/apis/console + model: apiclient.Model, converts to and from the wire format + requestBuilder: apiclient.http.HttpRequest, encapsulator for + an HTTP request + +Returns: + A Resource object with methods for interacting with + the service. + ++
|
+
+Create a Resource for interacting with an API. + +Same as `build()`, but constructs the Resource object +from a discovery document that is it given, as opposed to +retrieving one over HTTP. + +Args: + service: string, discovery document + base: string, base URI for all HTTP requests, usually the discovery URI + future: string, discovery document with future capabilities + auth_discovery: dict, information about the authentication the API supports + http: httplib2.Http, An instance of httplib2.Http or something that acts + like it that HTTP requests will be made through. + developerKey: string, Key for controlling API usage, generated + from the API Console. + model: Model class instance that serializes and + de-serializes requests and responses. + requestBuilder: Takes an http request and packages it up to be executed. + +Returns: + A Resource object with methods for interacting with + the service. + ++
|
+
+Convert value to a string based on JSON Schema type. + +See http://tools.ietf.org/html/draft-zyp-json-schema-03 for more details on +JSON Schema. + +Args: + value: any, the value to convert + schema_type: string, the type that value should be interpreted as + +Returns: + A string representation of 'value' based on the schema_type. + ++
|
+
|
+
+ DISCOVERY_URI+ +
|
+ STACK_QUERY_PARAMETERS+ +
|
+ RESERVED_WORDS+ +
|
+ MULTIPLIERS+ +
|
Trees | + + +Indices | + + +Help | + ++ |
---|
+ Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 + | ++ http://epydoc.sourceforge.net + | +