Add google.auth.oauth2client - helpers for oauth2client migration #70

theacodes · 2016-11-02T02:38:47Z

Resolves #38

@dhermes please let me know what you think about exposing this as google.auth.oauth2client, and feel free to suggest a better name (oauth2client_compat?)

google/auth/oauth2client.py

@@ -0,0 +1,133 @@
+# Copyright 2015 Google Inc.


google/auth/oauth2client.py

+    import oauth2client.service_account
+    _HAS_OAUTH2CLIENT = True
+except ImportError:  # pragma: NO COVER
+    _HAS_OAUTH2CLIENT = False


google/auth/oauth2client.py

+
+
+def _convert_oauth2_credentials(credentials):
+    """Converts to :class:`google.oauth2.credentials.Credentials`."""


google/auth/oauth2client.py

+
+
+def _convert_service_account_credentials(credentials):
+    """Converts to :class:`google.oauth2.service_account.Credentials`."""


google/auth/oauth2client.py

+def _convert_service_account_credentials(credentials):
+    """Converts to :class:`google.oauth2.service_account.Credentials`."""
+    info = credentials.serialization_data
+    info['token_uri'] = credentials.token_uri


google/auth/oauth2client.py

+        google.auth.credentials.Credentials: The converted credentials.
+
+    Raises:
+        EnvironmentError: If oauth2client is not installed.


google/auth/oauth2client.py

+    if not _HAS_OAUTH2CLIENT:
+        raise EnvironmentError(
+            'oauth2client is not installed and is required in order to convert'
+            'credentials.')


google/auth/oauth2client.py

+        return _CLASS_CONVERSION_MAP[credentials_class](credentials)
+    except KeyError:
+        raise ValueError(
+            'Unable to convert {} to a google-auth credentials class.'.format(


scripts/run_pylint.py

@@ -56,7 +56,7 @@
    },
    'BASIC': {
        'method-rgx': '[a-z_][a-z0-9_]{2,40}$',
-        'function-rgx': '[a-z_][a-z0-9_]{2,40}$',
+        'function-rgx': '[a-z_][a-z0-9_]{2,45}$',


tests/test_oauth2client.py

+
+
+def test_import_has_app_engine(mock_oauth2client_gae_imports):
+    reload_module(_oauth2client)


dhermes · 2016-11-02T03:04:18Z

please let me know what you think about exposing this as google.auth.oauth2client, and feel free to suggest a better name (oauth2client_compat?)

The very first thing I thought when I saw the first file (docs/reference/google.auth.oauth2client.rst) was: "aw man why is it public?"

My reflex says make it non-public.

If you make it non-public, the name is less relevant. _oauth2client is fine
If you make it public, I prefer oauth2client_compat

theacodes · 2016-11-02T03:08:54Z

If I make it non-public, how would I expose the 'convert' function?

On Tue, Nov 1, 2016, 8:04 PM Danny Hermes notifications@github.com wrote:

please let me know what you think about exposing this as
google.auth.oauth2client, and feel free to suggest a better name (
oauth2client_compat?)

The very first thing I thought when I saw the first file (
docs/reference/google.auth.oauth2client.rst) was: "aw man why is it
public?"

My reflex says make it non-public.

If you make it non-public, the name is less relevant. _oauth2client
is fine

If you make it public, I prefer oauth2client_compat

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
#70 (comment),
or mute the thread
https://github.com/notifications/unsubscribe-auth/AAPUcxBZ0vUtS_R-wv3SZoB32zj9oXKKks5q5_2ygaJpZM4KmzNC
.

dhermes · 2016-11-02T03:15:23Z

If I make it non-public, how would I expose the convert function?

Just force the non-public module to show up in the Sphinx generated docs and then put a big warning in the module docstring that the module is intentionally non-public and not intended for typical users / new users. Then let them ~~eat cake~~ import the non-public module.

theacodes · 2016-11-02T06:08:29Z

@dhermes I'm rather just leave it out of the docs in that case. Cool with you?

dhermes · 2016-11-02T06:11:22Z

@jonparrott I suppose it's cool with me, though you should still have very good and useful docstrings (especially the module docstring).

theacodes · 2016-11-02T06:12:04Z

(especially the module docstring).

Anything you'd add to the module docstring?

dhermes · 2016-11-02T06:14:59Z

Essentially

put a big warning in the module docstring that the module is intentionally non-public and not intended for typical users / new users

theacodes

@dhermes I've made it private and addressed all comments.

google/auth/oauth2client.py

@@ -0,0 +1,133 @@
+# Copyright 2015 Google Inc.


google/auth/oauth2client.py

+    import oauth2client.service_account
+    _HAS_OAUTH2CLIENT = True
+except ImportError:  # pragma: NO COVER
+    _HAS_OAUTH2CLIENT = False


google/auth/oauth2client.py

+
+
+def _convert_oauth2_credentials(credentials):
+    """Converts to :class:`google.oauth2.credentials.Credentials`."""


google/auth/oauth2client.py

+
+
+def _convert_service_account_credentials(credentials):
+    """Converts to :class:`google.oauth2.service_account.Credentials`."""


google/auth/oauth2client.py

+def _convert_service_account_credentials(credentials):
+    """Converts to :class:`google.oauth2.service_account.Credentials`."""
+    info = credentials.serialization_data
+    info['token_uri'] = credentials.token_uri


google/auth/oauth2client.py

+        google.auth.credentials.Credentials: The converted credentials.
+
+    Raises:
+        EnvironmentError: If oauth2client is not installed.


google/auth/oauth2client.py

+    if not _HAS_OAUTH2CLIENT:
+        raise EnvironmentError(
+            'oauth2client is not installed and is required in order to convert'
+            'credentials.')


google/auth/oauth2client.py

+        return _CLASS_CONVERSION_MAP[credentials_class](credentials)
+    except KeyError:
+        raise ValueError(
+            'Unable to convert {} to a google-auth credentials class.'.format(


scripts/run_pylint.py

@@ -56,7 +56,7 @@
    },
    'BASIC': {
        'method-rgx': '[a-z_][a-z0-9_]{2,40}$',
-        'function-rgx': '[a-z_][a-z0-9_]{2,40}$',
+        'function-rgx': '[a-z_][a-z0-9_]{2,45}$',


tests/test_oauth2client.py

+
+
+def test_import_has_app_engine(mock_oauth2client_gae_imports):
+    reload_module(_oauth2client)


theacodes · 2016-11-03T03:32:03Z

@dhermes you've approved, but I changed a lot since, care to take another look? ("No" is also acceptable as this is a completely private module)

theacodes added this to the 1.0.0 milestone Nov 2, 2016

theacodes assigned dhermes Nov 2, 2016

dhermes approved these changes Nov 2, 2016

View reviewed changes

theacodes commented Nov 2, 2016

View reviewed changes

dhermes approved these changes Nov 3, 2016

View reviewed changes

Jon Wayne Parrott added 2 commits November 2, 2016 23:39

Add google.auth.oauth2client - helpers for oauth2client migration

5e005e1

Address review comments

e3abc8a

theacodes force-pushed the oauth2client-converter branch from 7f3a240 to e3abc8a Compare November 3, 2016 06:39

theacodes merged commit a896d2a into master Nov 3, 2016

theacodes deleted the oauth2client-converter branch November 3, 2016 06:42

theacodes unassigned dhermes Oct 11, 2018



		def _convert_oauth2_credentials(credentials):
		"""Converts to :class:`google.oauth2.credentials.Credentials`."""



		def _convert_service_account_credentials(credentials):
		"""Converts to :class:`google.oauth2.service_account.Credentials`."""



		def test_import_has_app_engine(mock_oauth2client_gae_imports):
		reload_module(_oauth2client)

Add google.auth.oauth2client - helpers for oauth2client migration #70

Add google.auth.oauth2client - helpers for oauth2client migration #70

Conversation

theacodes commented Nov 2, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

dhermes commented Nov 2, 2016

theacodes commented Nov 2, 2016

dhermes commented Nov 2, 2016

theacodes commented Nov 2, 2016

dhermes commented Nov 2, 2016

theacodes commented Nov 2, 2016

dhermes commented Nov 2, 2016

theacodes left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

theacodes commented Nov 3, 2016