PageRenderTime 141ms CodeModel.GetById 111ms app.highlight 5ms RepoModel.GetById 15ms app.codeStats 0ms

/apiclient/sample_tools.py

https://code.google.com/p/google-api-python-client/
Python | 93 lines | 61 code | 8 blank | 24 comment | 3 complexity | 71bf2e426547f5bda6e4851933831761 MD5 | raw file
 1# Copyright (C) 2013 Google Inc.
 2#
 3# Licensed under the Apache License, Version 2.0 (the "License");
 4# you may not use this file except in compliance with the License.
 5# You may obtain a copy of the License at
 6#
 7#      http://www.apache.org/licenses/LICENSE-2.0
 8#
 9# Unless required by applicable law or agreed to in writing, software
10# distributed under the License is distributed on an "AS IS" BASIS,
11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12# See the License for the specific language governing permissions and
13# limitations under the License.
14
15"""Utilities for making samples.
16
17Consolidates a lot of code commonly repeated in sample applications.
18"""
19
20__author__ = 'jcgregorio@google.com (Joe Gregorio)'
21__all__ = ['init']
22
23
24import argparse
25import httplib2
26import os
27
28from apiclient import discovery
29from oauth2client import client
30from oauth2client import file
31from oauth2client import tools
32
33
34def init(argv, name, version, doc, filename, scope=None, parents=[]):
35  """A common initialization routine for samples.
36
37  Many of the sample applications do the same initialization, which has now
38  been consolidated into this function. This function uses common idioms found
39  in almost all the samples, i.e. for an API with name 'apiname', the
40  credentials are stored in a file named apiname.dat, and the
41  client_secrets.json file is stored in the same directory as the application
42  main file.
43
44  Args:
45    argv: list of string, the command-line parameters of the application.
46    name: string, name of the API.
47    version: string, version of the API.
48    doc: string, description of the application. Usually set to __doc__.
49    file: string, filename of the application. Usually set to __file__.
50    parents: list of argparse.ArgumentParser, additional command-line flags.
51    scope: string, The OAuth scope used.
52
53  Returns:
54    A tuple of (service, flags), where service is the service object and flags
55    is the parsed command-line flags.
56  """
57  if scope is None:
58    scope = 'https://www.googleapis.com/auth/' + name
59
60  # Parser command-line arguments.
61  parent_parsers = [tools.argparser]
62  parent_parsers.extend(parents)
63  parser = argparse.ArgumentParser(
64      description=doc,
65      formatter_class=argparse.RawDescriptionHelpFormatter,
66      parents=parent_parsers)
67  flags = parser.parse_args(argv[1:])
68
69  # Name of a file containing the OAuth 2.0 information for this
70  # application, including client_id and client_secret, which are found
71  # on the API Access tab on the Google APIs
72  # Console <http://code.google.com/apis/console>.
73  client_secrets = os.path.join(os.path.dirname(filename),
74                                'client_secrets.json')
75
76  # Set up a Flow object to be used if we need to authenticate.
77  flow = client.flow_from_clientsecrets(client_secrets,
78      scope=scope,
79      message=tools.message_if_missing(client_secrets))
80
81  # Prepare credentials, and authorize HTTP object with them.
82  # If the credentials don't exist or are invalid run through the native client
83  # flow. The Storage object will ensure that if successful the good
84  # credentials will get written back to a file.
85  storage = file.Storage(name + '.dat')
86  credentials = storage.get()
87  if credentials is None or credentials.invalid:
88    credentials = tools.run_flow(flow, storage, flags)
89  http = credentials.authorize(http = httplib2.Http())
90
91  # Construct a service object via the discovery service.
92  service = discovery.build(name, version, http=http)
93  return (service, flags)