Fix generation for methods with abnormal page token conventions #330

tcoffee-google · 2017-01-13T23:13:18Z

Addresses googleapis/gapic-generator#692.

tcoffee-google · 2017-01-13T23:14:38Z

tcoffee-google · 2017-01-13T23:17:40Z

Note this fix should be submitted in concert with googleapis/gapic-generator#880.

googleapiclient/discovery.py

  """Creates any _next methods for attaching to a Resource.

  The _next methods allow for easy iteration through list() responses.

  Args:
    methodName: string, name of the method to use.
+    pageToken: string, name of request page token field.
+    nextPageToken: string, name of response page token field.


googleapiclient/discovery.py

+
+    if isPageTokenParameter:
+        # Replace pageToken value in URI
+        parsed = list(urlparse(request.uri))


googleapiclient/discovery.py

-    # Add _next() methods
-    # Look for response bodies in schema that contain nextPageToken, and methods
-    # that take a pageToken parameter.
+    # Add _next() methods iff one of the names 'pageToken' or 'nextPageToken'


googleapiclient/discovery.py

-          hasPageToken = 'pageToken' in methodDesc.get('parameters', {})
-          if hasNextPageToken and hasPageToken:
-            fixedMethodName, method = createNextMethod(methodName + '_next')
+        nextPageToken = pageTokenName(


googleapiclient/discovery.py

            self._set_dynamic_attr(fixedMethodName,
                                   method.__get__(self, self.__class__))
+
+
+pageTokenNames = ('pageToken', 'nextPageToken')


googleapiclient/discovery.py

+
+pageTokenNames = ('pageToken', 'nextPageToken')
+
+def pageTokenName(fields):


googleapiclient/discovery.py

+                             method.__get__(self, self.__class__))
+
+
+def findPageTokenName(fields):


googleapiclient/discovery.py

+  return next((tokenName for tokenName in _PAGE_TOKEN_NAMES
+              if tokenName in fields), None)
+
+def methodProperties(methodDesc, schema, name):


googleapiclient/model.py

@@ -348,7 +348,7 @@ def no_content_response(self):
 def makepatch(original, modified):
  """Create a patch object.

-  Some methods support PATCH, an efficient way to send updates to a resource.
+  Some methods support PATCH, an efficient way to send updates to a presource.


googleapiclient/schema.py

@@ -161,13 +161,13 @@ def prettyPrintSchema(self, schema):
    # Return with trailing comma and newline removed.
    return self._prettyPrintSchema(schema, dent=1)[:-2]

-  def get(self, name):
+  def get(self, name, default=None):


theacodes · 2017-01-17T21:24:58Z

@lukesneeringer @landrito I'd love to have one of you take a look.

Large changes like this on this ancient codebase make me uneasy.

googleapiclient/discovery.py

-        raise TypeError('Missing required parameter "%s"' % name)
+        # temporary workaround for non-paging methods incorrectly requiring
+        # page token parameter (cf. drive.changes.watch vs. drive.changes.list)
+        if name not in _PAGE_TOKEN_NAMES or _findPageTokenName(


googleapiclient/discovery.py

@@ -945,24 +957,26 @@ def methodNext(self, previous_request, previous_response):
    # Retrieve nextPageToken from previous_response
    # Use as pageToken in previous_request to create new request.

-    if 'nextPageToken' not in previous_response or not previous_response['nextPageToken']:
+    if (nextPageTokenName not in previous_response or
+        not previous_response[nextPageTokenName]):


googleapiclient/discovery.py

+    First name that is either 'pageToken' or 'nextPageToken' if one exists,
+    otherwise None.
+  """
+  return next((tokenName for tokenName in _PAGE_TOKEN_NAMES


vchudnov-g · 2017-01-25T01:41:28Z

ping

tcoffee-google · 2017-02-09T00:37:14Z

Any further comments on this?

lukesneeringer · 2017-02-10T00:32:46Z

No further comments. Thanks!

tcoffee-google · 2017-02-10T17:37:57Z

@jonparrott @lukesneeringer can you please approve changes to enable submission? Thanks!

Fix generation for methods with abnormal page token conventions

b7301dc

Addresses googleapis/gapic-generator#692.

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Jan 13, 2017

theacodes suggested changes Jan 17, 2017

View reviewed changes

Address PR feedback

901c71c

theacodes suggested changes Jan 17, 2017

View reviewed changes

Address PR feedback

1d143a0

Re-fix typo

f33fbc8

lukesneeringer suggested changes Jan 20, 2017

View reviewed changes

tcoffee-google added 2 commits January 25, 2017 09:13

Address PR feedback

15dbf18

Address PR feedback

89fea86

lukesneeringer approved these changes Feb 10, 2017

View reviewed changes

theacodes approved these changes Feb 10, 2017

View reviewed changes

theacodes merged commit 20af04d into googleapis:master Feb 10, 2017

tcoffee-google deleted the fix_odd_paging_methods branch February 10, 2017 23:25

tcoffee-google mentioned this pull request Feb 10, 2017

Check all languages for cases where pageToken is in the request body googleapis/gapic-generator#692

Closed


		pageTokenNames = ('pageToken', 'nextPageToken')

		def pageTokenName(fields):

		method.__get__(self, self.__class__))


		def findPageTokenName(fields):

Fix generation for methods with abnormal page token conventions #330

Fix generation for methods with abnormal page token conventions #330

Conversation

tcoffee-google commented Jan 13, 2017

tcoffee-google commented Jan 13, 2017

tcoffee-google commented Jan 13, 2017

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.

This comment was marked as spam.

This comment was marked as spam.

theacodes commented Jan 17, 2017

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.

vchudnov-g commented Jan 25, 2017

tcoffee-google commented Feb 9, 2017

lukesneeringer commented Feb 10, 2017

tcoffee-google commented Feb 10, 2017