Merge util.py and _helpers.py #579

pferate · 2016-08-01T20:21:50Z

A new file, _helpers.py, was created without realizing that utils.py existed for the same purpose.

Resolves: #251, (partially) #428 (partial duplicate of #251)

dhermes · 2016-08-01T20:24:38Z

@pferate I am the originator of _helpers and it was very much intentional. If you are merging them then utils should go away since it is public.

Also, I seem to recall there being an issue with the LICENSE on that file since it came from Guido on the protorpc project

pferate · 2016-08-01T20:27:07Z

Thanks for the info. I guess I misunderstood your comment from #251:

That's my fault for creating _helpers and not realizing util was there.

and assumed that the code in _helpers should go into utils.

dhermes · 2016-08-01T21:15:41Z

Ahh that's a failure of my memory then, the thing I wrote at that time is the real truth.

The goal is a smaller surface area, not a larger one and none of the functions in _helpers are in the API surface area, so big 👍 there.

In addition to nuking util.py, I'd love to see a plan for deprecating use of the positional decorator.

theacodes · 2016-08-01T21:34:47Z

In addition to nuking util.py, I'd love to see a plan for deprecating use of the positional decorator.

File a bug and put it in the 4.0.0 milestone.

theacodes · 2016-08-01T21:35:22Z

In general, I'd prefer less public stuff in this library.

dhermes · 2016-08-01T21:36:13Z

File a bug and put it in the 4.0.0 milestone.

I apparently already filed #428 for just this and you and @pferate got it in the right milestone

nathanielmanistaatgoogle · 2016-08-02T23:41:27Z

... so is this pull request actionable or should it be closed? Is this where util.py should be killed off?

theacodes · 2016-08-03T16:58:12Z

I don't see anything in utils that want to be public. Should merge utils into _helpers and remove utils?

dhermes · 2016-08-03T17:39:15Z

Yes that

pferate · 2016-08-03T18:06:13Z

OK, I'll update this PR. With _helpers being private, should all of the functions and global variables within it be private as well? Or would that already be handled from the private module?

dhermes · 2016-08-03T18:15:17Z

That is @nathanielmanistaatgoogle's territory (of having more refined opinions than others). IIUC he prefers that imported functions be public, and since the module is non-public, that will be very much OK. (I would suggest holding off of renames like _helpers._from_bytes for a separate PR.)

theacodes · 2016-08-03T18:18:29Z

I also would prefer _helpers.from_bytes instead of _helpers._from_bytes.

Basically, functions that start with _ are module-private and modules that start with _ are package-private. A package-private module still has a right to have module-private attributes.

pferate · 2016-08-03T18:23:41Z

Thanks!

pferate · 2016-08-04T16:29:04Z

PR has been updated (utils -> _helpers).

oauth2client/_helpers.py

+        return scopes
+
+
+def _add_query_parameter(url, name, value):


theacodes · 2016-08-04T17:09:30Z

This change looks mostly good to me, @nathanielmanistaatgoogle to do the final review.

oauth2client/_helpers.py

+    'guido@google.com (Guido van Rossum)',
+]
+
+__all__ = [


nathanielmanistaatgoogle · 2016-08-04T17:34:05Z

Done with my first round of review.

tests/test__helpers.py

+
+        # 1 positional arg, 1 keyword-only arg.
+        @_helpers.positional(1)
+        def fn(pos, kwonly=None):


A new file, `_helpers.py`, was created without realizing that `utils.py` existed for the same purpose. Moving all to `_helpers.py`.

pferate · 2016-08-04T21:17:40Z

PR has been updated. I will be creating another PR to remove the _ from functions in _helpers.

googlebot added the cla: yes label Aug 1, 2016

pferate force-pushed the refactor_helpers branch 2 times, most recently from 7337915 to 328b200 Compare August 4, 2016 16:13

pferate force-pushed the refactor_helpers branch from 328b200 to 943ff6c Compare August 4, 2016 16:33

theacodes reviewed Aug 4, 2016
View reviewed changes

oauth2client/_helpers.py

return scopes

def _add_query_parameter(url, name, value):

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

theacodes assigned nathanielmanistaatgoogle Aug 4, 2016

nathanielmanistaatgoogle reviewed Aug 4, 2016
View reviewed changes

oauth2client/_helpers.py

'guido@google.com (Guido van Rossum)',

]

__all__ = [

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

This comment was marked as spam.

Sign in to view

pferate reviewed Aug 4, 2016
View reviewed changes

tests/test__helpers.py

# 1 positional arg, 1 keyword-only arg.

@_helpers.positional(1)

def fn(pos, kwonly=None):

This comment was marked as spam.

Sign in to view

pferate force-pushed the refactor_helpers branch from 943ff6c to 3bfeb69 Compare August 4, 2016 18:18

Merge util.py and _helpers.py

2f5c53b

A new file, `_helpers.py`, was created without realizing that `utils.py` existed for the same purpose. Moving all to `_helpers.py`.

pferate force-pushed the refactor_helpers branch from 3bfeb69 to 2f5c53b Compare August 4, 2016 21:11

pferate mentioned this pull request Aug 4, 2016

Adds support for RFC7636 PKCE #588

Merged

nathanielmanistaatgoogle merged commit 248dc6c into googleapis:master Aug 5, 2016

pferate deleted the refactor_helpers branch August 10, 2016 17:32

keliomer mentioned this pull request Oct 18, 2016

PyDrive not working with oauth2client version 4.0 googlearchive/PyDrive#78

Closed

google-admin unassigned nathanielmanistaatgoogle Sep 11, 2018

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge util.py and _helpers.py #579

Merge util.py and _helpers.py #579

pferate commented Aug 1, 2016 •

edited

Loading

dhermes commented Aug 1, 2016

pferate commented Aug 1, 2016 •

edited

Loading

dhermes commented Aug 1, 2016

theacodes commented Aug 1, 2016

theacodes commented Aug 1, 2016

dhermes commented Aug 1, 2016

nathanielmanistaatgoogle commented Aug 2, 2016

theacodes commented Aug 3, 2016

dhermes commented Aug 3, 2016

pferate commented Aug 3, 2016

dhermes commented Aug 3, 2016

theacodes commented Aug 3, 2016 •

edited

Loading

pferate commented Aug 3, 2016

pferate commented Aug 4, 2016

This comment was marked as spam.

This comment was marked as spam.

theacodes commented Aug 4, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

nathanielmanistaatgoogle commented Aug 4, 2016

This comment was marked as spam.

pferate commented Aug 4, 2016

Merge util.py and _helpers.py #579

Merge util.py and _helpers.py #579

Conversation

pferate commented Aug 1, 2016 • edited Loading

dhermes commented Aug 1, 2016

pferate commented Aug 1, 2016 • edited Loading

dhermes commented Aug 1, 2016

theacodes commented Aug 1, 2016

theacodes commented Aug 1, 2016

dhermes commented Aug 1, 2016

nathanielmanistaatgoogle commented Aug 2, 2016

theacodes commented Aug 3, 2016

dhermes commented Aug 3, 2016

pferate commented Aug 3, 2016

dhermes commented Aug 3, 2016

theacodes commented Aug 3, 2016 • edited Loading

pferate commented Aug 3, 2016

pferate commented Aug 4, 2016

This comment was marked as spam.

This comment was marked as spam.

theacodes commented Aug 4, 2016

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

nathanielmanistaatgoogle commented Aug 4, 2016

This comment was marked as spam.

pferate commented Aug 4, 2016

pferate commented Aug 1, 2016 •

edited

Loading

pferate commented Aug 1, 2016 •

edited

Loading

theacodes commented Aug 3, 2016 •

edited

Loading