Skip to content

chore: Python pagination support #733

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kridai merged 9 commits into from
Jan 20, 2026
Merged

chore: Python pagination support #733

Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ae103b9
feat: add python token pagination support
kridai Dec 4, 2025
155ba71
feat: add python token pagination support
kridai Dec 4, 2025
d0a9955
feat: add python token pagination support
kridai Dec 4, 2025
5fe6646
feat: add python token pagination support
kridai Dec 4, 2025
1b12577
feat: add python token pagination support
kridai Dec 4, 2025
5c3172f
feat: update generation logic to propagate params
kridai Dec 10, 2025
e4c149c
Merge branch 'twilio_api_standards_changes' into pyhon-pagination-sup…
kridai Dec 10, 2025
69812a3
Merge branch 'twilio_api_standards_changes' into pyhon-pagination-sup…
kridai Jan 19, 2026
8bb6408
chore: fix merge conflict update pagination
kridai Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 34 additions & 9 deletions src/main/resources/twilio-python/listOperations.handlebars
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -598,8 +598,20 @@
items = [record async for record in generator]
return ApiResponse(data=items, status_code=status_code, headers=headers)

def page(self, {{#allParams}}
{{#startsWith paramName text='page_size'}}{{else}}{{#startsWith paramName text='page_token'}}{{else}}{{paramName}}: Union[{{{dataType}}}, object] = values.unset,{{/startsWith}}{{/startsWith}}{{/allParams}}
def page(self, {{#isApiV1}}{{#allParams}}
{{paramName}}: Union[{{{dataType}}}, object] = values.unset,{{/allParams}}
) -> {{apiName}}Page:
"""
Retrieve a single page of {{instanceName}} records from the API.
Request is executed immediately
{{#allParams}}
:param {{paramName}}: {{{description}}}{{/allParams}}
:returns: Page of {{instanceName}}
"""
data = values.of({ {{#allParams}}
'{{{baseName}}}': {{#if vendorExtensions.x-serialize}}{{vendorExtensions.x-serialize}}({{paramName}}{{#if isArray}}, lambda e: e){{else}}){{/if}}{{else}}{{paramName}}{{/if}},{{/allParams}}
}){{/isApiV1}}{{^isApiV1}}{{#allParams}}
{{#startsWith paramName text='page_size'}}{{else}}{{paramName}}: Union[{{{dataType}}}, object] = values.unset,{{/startsWith}}{{/allParams}}
page_token: Union[str, object] = values.unset,
page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
Expand All @@ -620,7 +632,7 @@
'PageToken': page_token,
'Page': page_number,
'PageSize': page_size,
})
}){{/isApiV1}}

headers = values.of({
{{#headerParams}}'{{{baseName}}}': {{paramName}},
Expand All @@ -634,11 +646,23 @@
{{/vendorExtensions.successProduce}}

response = self._version.page(method='{{vendorExtensions.x-http-method}}', uri=self._uri, params=data, headers=headers){{#isApiV1}}
return {{apiName}}Page(self._version, response, uri=self._uri{{#if listPathParams}}, self._solution{{/if}}){{/isApiV1}}{{^isApiV1}}
return {{apiName}}Page(self._version, response, uri=self._uri, params=data{{#if listPathParams}}, self._solution{{/if}}){{/isApiV1}}{{^isApiV1}}
return {{apiName}}Page(self._version, response{{#if listPathParams}}, self._solution{{/if}}){{/isApiV1}}

async def page_async(self, {{#allParams}}
{{#startsWith paramName text='page_size'}}{{else}}{{paramName}}: Union[{{{dataType}}}, object] = values.unset,{{/startsWith}}{{/allParams}}
async def page_async(self, {{#isApiV1}}{{#allParams}}
{{paramName}}: Union[{{{dataType}}}, object] = values.unset,{{/allParams}}
) -> {{apiName}}Page:
"""
Asynchronously retrieve a single page of {{instanceName}} records from the API.
Request is executed immediately
{{#allParams}}
:param {{paramName}}: {{{description}}}{{/allParams}}
:returns: Page of {{instanceName}}
"""
data = values.of({ {{#allParams}}
'{{{baseName}}}': {{#if vendorExtensions.x-serialize}}{{vendorExtensions.x-serialize}}({{paramName}}{{#if isArray}}, lambda e: e){{else}}){{/if}}{{else}}{{paramName}}{{/if}},{{/allParams}}
}){{/isApiV1}}{{^isApiV1}}{{#allParams}}
{{#startsWith paramName text='page_size'}}{{else}}{{paramName}}: Union[{{{dataType}}}, object] = values.unset,{{/startsWith}}{{/allParams}}
page_token: Union[str, object] = values.unset,
Copy link
Contributor

@tiwarishubham635 tiwarishubham635 Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider the case when page_token, page_size params are present in the spec file too, like this.

Copy link
Contributor Author

@kridai kridai Jan 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these params are supported for token paginations. see the generated file https://github.com/twilio/twilio-python/pull/906/changes#diff-b0150af2b6d9e9ad8b9c685530aae36aeb5f35a0a6b67be43a92c02124bb6c2aR174-R177

page_number: Union[int, object] = values.unset,
page_size: Union[int, object] = values.unset,
Expand All @@ -659,7 +683,7 @@
'PageToken': page_token,
'Page': page_number,
'PageSize': page_size,
})
}){{/isApiV1}}

headers = values.of({
{{#headerParams}}'{{{baseName}}}': {{paramName}},
Expand All @@ -672,8 +696,9 @@
headers["Accept"] = "{{{mediaType}}}"
{{/produces}}

response = await self._version.page_async(method='{{vendorExtensions.x-http-method}}', uri=self._uri, params=data, headers=headers)
return {{apiName}}Page(self._version, response{{#if listPathParams}}, self._solution{{/if}})
response = await self._version.page_async(method='{{vendorExtensions.x-http-method}}', uri=self._uri, params=data, headers=headers){{#isApiV1}}
return {{apiName}}Page(self._version, response, uri=self._uri, params=data{{#if listPathParams}}, self._solution{{/if}}){{/isApiV1}}{{^isApiV1}}
return {{apiName}}Page(self._version, response{{#if listPathParams}}, self._solution{{/if}}){{/isApiV1}}

def page_with_http_info(self, {{#allParams}}
{{#startsWith paramName text='page_size'}}{{else}}{{#startsWith paramName text='page_token'}}{{else}}{{paramName}}: Union[{{{dataType}}}, object] = values.unset,{{/startsWith}}{{/startsWith}}{{/allParams}}
Expand Down