Index: third_party/oauth2client/tools.py
|
diff --git a/third_party/oauth2client/tools.py b/third_party/oauth2client/tools.py
|
index 12c68bf0f0f3819d4c25675d2a3140a6ad436274..3df1bbede4f702e96791ef2ebeba01447be8a636 100644
|
--- a/third_party/oauth2client/tools.py
|
+++ b/third_party/oauth2client/tools.py
|
@@ -1,4 +1,4 @@
|
-# Copyright (C) 2013 Google Inc.
|
+# Copyright 2014 Google Inc. All rights reserved.
|
#
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
# you may not use this file except in compliance with the License.
|
@@ -19,27 +19,22 @@ generated credentials in a common file that is used by other example apps in
|
the same directory.
|
"""
|
|
+from __future__ import print_function
|
+
|
__author__ = 'jcgregorio@google.com (Joe Gregorio)'
|
__all__ = ['argparser', 'run_flow', 'run', 'message_if_missing']
|
|
-
|
-import BaseHTTPServer
|
-import argparse
|
-import httplib2
|
import logging
|
-import os
|
import socket
|
import sys
|
-import webbrowser
|
|
-from oauth2client import client
|
-from oauth2client import file
|
-from oauth2client import util
|
+from third_party.six.moves import BaseHTTPServer
|
+from third_party.six.moves import urllib
|
+from third_party.six.moves import input
|
+
|
+from . import client
|
+from . import util
|
|
-try:
|
- from urlparse import parse_qsl
|
-except ImportError:
|
- from cgi import parse_qsl
|
|
_CLIENT_SECRETS_MESSAGE = """WARNING: Please configure OAuth 2.0
|
|
@@ -52,20 +47,27 @@ with information from the APIs Console <https://code.google.com/apis/console>.
|
|
"""
|
|
-# run_parser is an ArgumentParser that contains command-line options expected
|
+def _CreateArgumentParser():
|
+ try:
|
+ import argparse
|
+ except ImportError:
|
+ return None
|
+ parser = argparse.ArgumentParser(add_help=False)
|
+ parser.add_argument('--auth_host_name', default='localhost',
|
+ help='Hostname when running a local web server.')
|
+ parser.add_argument('--noauth_local_webserver', action='store_true',
|
+ default=False, help='Do not run a local web server.')
|
+ parser.add_argument('--auth_host_port', default=[8080, 8090], type=int,
|
+ nargs='*', help='Port web server should listen on.')
|
+ parser.add_argument('--logging_level', default='ERROR',
|
+ choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'],
|
+ help='Set the logging level of detail.')
|
+ return parser
|
+
|
+# argparser is an ArgumentParser that contains command-line options expected
|
# by tools.run(). Pass it in as part of the 'parents' argument to your own
|
# ArgumentParser.
|
-argparser = argparse.ArgumentParser(add_help=False)
|
-argparser.add_argument('--auth_host_name', default='localhost',
|
- help='Hostname when running a local web server.')
|
-argparser.add_argument('--noauth_local_webserver', action='store_true',
|
- default=False, help='Do not run a local web server.')
|
-argparser.add_argument('--auth_host_port', default=[8080, 8090], type=int,
|
- nargs='*', help='Port web server should listen on.')
|
-argparser.add_argument('--logging_level', default='ERROR',
|
- choices=['DEBUG', 'INFO', 'WARNING', 'ERROR',
|
- 'CRITICAL'],
|
- help='Set the logging level of detail.')
|
+argparser = _CreateArgumentParser()
|
|
|
class ClientRedirectServer(BaseHTTPServer.HTTPServer):
|
@@ -84,72 +86,75 @@ class ClientRedirectHandler(BaseHTTPServer.BaseHTTPRequestHandler):
|
into the servers query_params and then stops serving.
|
"""
|
|
- def do_GET(s):
|
+ def do_GET(self):
|
"""Handle a GET request.
|
|
Parses the query parameters and prints a message
|
if the flow has completed. Note that we can't detect
|
if an error occurred.
|
"""
|
- s.send_response(200)
|
- s.send_header("Content-type", "text/html")
|
- s.end_headers()
|
- query = s.path.split('?', 1)[-1]
|
- query = dict(parse_qsl(query))
|
- s.server.query_params = query
|
- s.wfile.write("<html><head><title>Authentication Status</title></head>")
|
- s.wfile.write("<body><p>The authentication flow has completed.</p>")
|
- s.wfile.write("</body></html>")
|
+ self.send_response(200)
|
+ self.send_header("Content-type", "text/html")
|
+ self.end_headers()
|
+ query = self.path.split('?', 1)[-1]
|
+ query = dict(urllib.parse.parse_qsl(query))
|
+ self.server.query_params = query
|
+ self.wfile.write(b"<html><head><title>Authentication Status</title></head>")
|
+ self.wfile.write(b"<body><p>The authentication flow has completed.</p>")
|
+ self.wfile.write(b"</body></html>")
|
|
def log_message(self, format, *args):
|
"""Do not log messages to stdout while running as command line program."""
|
- pass
|
|
|
@util.positional(3)
|
def run_flow(flow, storage, flags, http=None):
|
"""Core code for a command-line application.
|
|
- The run() function is called from your application and runs through all the
|
- steps to obtain credentials. It takes a Flow argument and attempts to open an
|
- authorization server page in the user's default web browser. The server asks
|
- the user to grant your application access to the user's data. If the user
|
- grants access, the run() function returns new credentials. The new credentials
|
- are also stored in the Storage argument, which updates the file associated
|
- with the Storage object.
|
+ The ``run()`` function is called from your application and runs
|
+ through all the steps to obtain credentials. It takes a ``Flow``
|
+ argument and attempts to open an authorization server page in the
|
+ user's default web browser. The server asks the user to grant your
|
+ application access to the user's data. If the user grants access,
|
+ the ``run()`` function returns new credentials. The new credentials
|
+ are also stored in the ``storage`` argument, which updates the file
|
+ associated with the ``Storage`` object.
|
|
It presumes it is run from a command-line application and supports the
|
following flags:
|
|
- --auth_host_name: Host name to use when running a local web server
|
- to handle redirects during OAuth authorization.
|
- (default: 'localhost')
|
+ ``--auth_host_name`` (string, default: ``localhost``)
|
+ Host name to use when running a local web server to handle
|
+ redirects during OAuth authorization.
|
+
|
+ ``--auth_host_port`` (integer, default: ``[8080, 8090]``)
|
+ Port to use when running a local web server to handle redirects
|
+ during OAuth authorization. Repeat this option to specify a list
|
+ of values.
|
+
|
+ ``--[no]auth_local_webserver`` (boolean, default: ``True``)
|
+ Run a local web server to handle redirects during OAuth authorization.
|
+
|
|
- --auth_host_port: Port to use when running a local web server to handle
|
- redirects during OAuth authorization.;
|
- repeat this option to specify a list of values
|
- (default: '[8080, 8090]')
|
- (an integer)
|
|
- --[no]auth_local_webserver: Run a local web server to handle redirects
|
- during OAuth authorization.
|
- (default: 'true')
|
|
- The tools module defines an ArgumentParser the already contains the flag
|
- definitions that run() requires. You can pass that ArgumentParser to your
|
- ArgumentParser constructor:
|
+ The tools module defines an ``ArgumentParser`` the already contains the flag
|
+ definitions that ``run()`` requires. You can pass that ``ArgumentParser`` to your
|
+ ``ArgumentParser`` constructor::
|
|
- parser = argparse.ArgumentParser(description=__doc__,
|
- formatter_class=argparse.RawDescriptionHelpFormatter,
|
- parents=[tools.run_parser])
|
- flags = parser.parse_args(argv)
|
+ parser = argparse.ArgumentParser(description=__doc__,
|
+ formatter_class=argparse.RawDescriptionHelpFormatter,
|
+ parents=[tools.argparser])
|
+ flags = parser.parse_args(argv)
|
|
Args:
|
flow: Flow, an OAuth 2.0 Flow to step through.
|
- storage: Storage, a Storage to store the credential in.
|
- flags: argparse.ArgumentParser, the command-line flags.
|
- http: An instance of httplib2.Http.request
|
- or something that acts like it.
|
+ storage: Storage, a ``Storage`` to store the credential in.
|
+ flags: ``argparse.Namespace``, The command-line flags. This is the
|
+ object returned from calling ``parse_args()`` on
|
+ ``argparse.ArgumentParser`` as described above.
|
+ http: An instance of ``httplib2.Http.request`` or something that
|
+ acts like it.
|
|
Returns:
|
Credentials, the obtained credential.
|
@@ -163,20 +168,20 @@ def run_flow(flow, storage, flags, http=None):
|
try:
|
httpd = ClientRedirectServer((flags.auth_host_name, port),
|
ClientRedirectHandler)
|
- except socket.error, e:
|
+ except socket.error:
|
pass
|
else:
|
success = True
|
break
|
flags.noauth_local_webserver = not success
|
if not success:
|
- print 'Failed to start a local webserver listening on either port 8080'
|
- print 'or port 9090. Please check your firewall settings and locally'
|
- print 'running programs that may be blocking or using those ports.'
|
- print
|
- print 'Falling back to --noauth_local_webserver and continuing with',
|
- print 'authorization.'
|
- print
|
+ print('Failed to start a local webserver listening on either port 8080')
|
+ print('or port 9090. Please check your firewall settings and locally')
|
+ print('running programs that may be blocking or using those ports.')
|
+ print()
|
+ print('Falling back to --noauth_local_webserver and continuing with')
|
+ print('authorization.')
|
+ print()
|
|
if not flags.noauth_local_webserver:
|
oauth_callback = 'http://%s:%s/' % (flags.auth_host_name, port_number)
|
@@ -186,21 +191,22 @@ def run_flow(flow, storage, flags, http=None):
|
authorize_url = flow.step1_get_authorize_url()
|
|
if not flags.noauth_local_webserver:
|
+ import webbrowser
|
webbrowser.open(authorize_url, new=1, autoraise=True)
|
- print 'Your browser has been opened to visit:'
|
- print
|
- print ' ' + authorize_url
|
- print
|
- print 'If your browser is on a different machine then exit and re-run this'
|
- print 'application with the command-line parameter '
|
- print
|
- print ' --noauth_local_webserver'
|
- print
|
+ print('Your browser has been opened to visit:')
|
+ print()
|
+ print(' ' + authorize_url)
|
+ print()
|
+ print('If your browser is on a different machine then exit and re-run this')
|
+ print('application with the command-line parameter ')
|
+ print()
|
+ print(' --noauth_local_webserver')
|
+ print()
|
else:
|
- print 'Go to the following link in your browser:'
|
- print
|
- print ' ' + authorize_url
|
- print
|
+ print('Go to the following link in your browser:')
|
+ print()
|
+ print(' ' + authorize_url)
|
+ print()
|
|
code = None
|
if not flags.noauth_local_webserver:
|
@@ -210,19 +216,19 @@ def run_flow(flow, storage, flags, http=None):
|
if 'code' in httpd.query_params:
|
code = httpd.query_params['code']
|
else:
|
- print 'Failed to find "code" in the query parameters of the redirect.'
|
+ print('Failed to find "code" in the query parameters of the redirect.')
|
sys.exit('Try running with --noauth_local_webserver.')
|
else:
|
- code = raw_input('Enter verification code: ').strip()
|
+ code = input('Enter verification code: ').strip()
|
|
try:
|
credential = flow.step2_exchange(code, http=http)
|
- except client.FlowExchangeError, e:
|
+ except client.FlowExchangeError as e:
|
sys.exit('Authentication has failed: %s' % e)
|
|
storage.put(credential)
|
credential.set_store(storage)
|
- print 'Authentication successful.'
|
+ print('Authentication successful.')
|
|
return credential
|
|
@@ -233,11 +239,11 @@ def message_if_missing(filename):
|
return _CLIENT_SECRETS_MESSAGE % filename
|
|
try:
|
- from old_run import run
|
- from old_run import FLAGS
|
+ from oauth2client.old_run import run
|
+ from oauth2client.old_run import FLAGS
|
except ImportError:
|
def run(*args, **kwargs):
|
raise NotImplementedError(
|
'The gflags library must be installed to use tools.run(). '
|
'Please install gflags or preferrably switch to using '
|
- 'tools.run_flow().')
|
+ 'tools.run_flow().')
|
|