Skip to content

REST: Add pagination support for list_views #3349

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

Open
ebyhr wants to merge 2 commits into
base: main
Choose a base branch
from
+106 −6
Open

REST: Add pagination support for list_views #3349

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
43c3d69
REST: Add pagination support for list_views
ebyhr May 9, 2026
efcbf5b
fixup! REST: Add pagination support for list_views
ebyhr May 11, 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
28 changes: 22 additions & 6 deletions pyiceberg/catalog/rest/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,7 @@ class ListTablesResponse(IcebergBaseModel):

class ListViewsResponse(IcebergBaseModel):
identifiers: list[ListViewResponseEntry] = Field()
next_page_token: str | None = Field(default=None, alias="next-page-token")


_PLANNING_RESPONSE_ADAPTER = TypeAdapter(PlanningResponse)
Expand Down Expand Up @@ -1102,12 +1103,27 @@ def list_views(self, namespace: str | Identifier) -> list[Identifier]:
return []
namespace_tuple = self._check_valid_namespace_identifier(namespace)
namespace_concat = self._encode_namespace_path(namespace_tuple)
response = self._session.get(self.url(Endpoints.list_views, namespace=namespace_concat))
try:
response.raise_for_status()
except HTTPError as exc:
_handle_non_200_response(exc, {404: NoSuchNamespaceError})
return [(*view.namespace, view.name) for view in ListViewsResponse.model_validate_json(response.text).identifiers]

all_identifiers: list[Identifier] = []
page_token: str | None = None

url = self.url(Endpoints.list_views, namespace=namespace_concat)
while True:
params = {"pageToken": page_token} if page_token else None
response = self._session.get(url, params=params)
try:
response.raise_for_status()
except HTTPError as exc:
_handle_non_200_response(exc, {404: NoSuchNamespaceError})

parsed = ListViewsResponse.model_validate_json(response.text)
all_identifiers.extend([(*view.namespace, view.name) for view in parsed.identifiers])

if not parsed.next_page_token:
break
page_token = parsed.next_page_token

return all_identifiers

@retry(**_RETRY_ARGS)
def commit_table(
Expand Down
84 changes: 84 additions & 0 deletions tests/catalog/test_rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,90 @@ def test_list_views_200(rest_mock: Mocker) -> None:
assert RestCatalog("rest", uri=TEST_URI, token=TEST_TOKEN).list_views(namespace) == [("examples", "fooshare")]


def test_list_views_paginated_200(rest_mock: Mocker) -> None:
Copy link
Copy Markdown
Member

@geruh geruh May 10, 2026

Choose a reason for hiding this comment

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

Can we add some tests for an ommitted field and null for the next_page_token, and ensure the behavior is the same?

Copy link
Copy Markdown
Member Author

@ebyhr ebyhr May 11, 2026

Choose a reason for hiding this comment

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

This test (test_list_views_paginated_200) verifies the omitted next-page-token field. Added another test with "next-page-token": None.

Let me know if you want me to add more tests.

namespace = "examples"
# First page with next-page-token
rest_mock.get(
f"{TEST_URI}v1/namespaces/{namespace}/views",
json={
"identifiers": [
{"namespace": ["examples"], "name": "view1"},
{"namespace": ["examples"], "name": "view2"},
],
"next-page-token": "page2token",
},
status_code=200,
request_headers=TEST_HEADERS,
)
# Second page with next-page-token
rest_mock.get(
f"{TEST_URI}v1/namespaces/{namespace}/views?pageToken=page2token",
json={
"identifiers": [
{"namespace": ["examples"], "name": "view3"},
],
"next-page-token": "page3token",
},
status_code=200,
request_headers=TEST_HEADERS,
)
# Third page without next-page-token (last page)
rest_mock.get(
f"{TEST_URI}v1/namespaces/{namespace}/views?pageToken=page3token",
json={
"identifiers": [
{"namespace": ["examples"], "name": "view4"},
],
},
status_code=200,
request_headers=TEST_HEADERS,
)

result = RestCatalog("rest", uri=TEST_URI, token=TEST_TOKEN).list_views(namespace)
assert result == [
("examples", "view1"),
("examples", "view2"),
("examples", "view3"),
("examples", "view4"),
]


def test_list_views_paginated_200_none_next_page_token(rest_mock: Mocker) -> None:
namespace = "examples"
# First page with next-page-token
rest_mock.get(
f"{TEST_URI}v1/namespaces/{namespace}/views",
json={
"identifiers": [
{"namespace": ["examples"], "name": "view1"},
{"namespace": ["examples"], "name": "view2"},
],
"next-page-token": "page2token",
},
status_code=200,
request_headers=TEST_HEADERS,
)
# The last page with NONE next-page-token
rest_mock.get(
f"{TEST_URI}v1/namespaces/{namespace}/views?pageToken=page2token",
json={
"identifiers": [
{"namespace": ["examples"], "name": "view3"},
],
"next-page-token": None,
},
status_code=200,
request_headers=TEST_HEADERS,
)

result = RestCatalog("rest", uri=TEST_URI, token=TEST_TOKEN).list_views(namespace)
assert result == [
("examples", "view1"),
("examples", "view2"),
("examples", "view3"),
]


def test_list_views_200_sigv4(rest_mock: Mocker) -> None:
namespace = "examples"
rest_mock.get(
Expand Down
Loading