PR feedback; one default for 1k page size

Author: tsift

python/lib/sift_client/_internal/low_level_wrappers/assets.py

@@ -15,13 +15,12 @@
 from sift.assets.v1.assets_pb2_grpc import AssetServiceStub
 
 from sift_client._internal.low_level_wrappers.base import (
+    DEFAULT_PAGE_SIZE,
     LowLevelClientBase,
 )
 from sift_client.sift_types.asset import Asset, AssetUpdate
 from sift_client.transport import GrpcClient, WithGrpcClient
 
-ASSETS_DEFAULT_PAGE_SIZE = 1000
-
 
 class AssetsLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the AssetsAPI.
@@ -48,7 +47,7 @@ async def list_all_assets(
         query_filter: str | None = None,
         order_by: str | None = None,
         max_results: int | None = None,
-        page_size: int | None = ASSETS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
     ) -> list[Asset]:
         """List all results matching the given query.
 
@@ -72,7 +71,7 @@ async def list_all_assets(
 
     async def list_assets(
         self,
-        page_size: int | None = ASSETS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         order_by: str | None = None,

python/lib/sift_client/_internal/low_level_wrappers/base.py

@@ -3,6 +3,9 @@
 from abc import ABC
 from typing import Any, Callable
 
+DEFAULT_PAGE_SIZE = 1000
+"""Default page size to use for pagination."""
+
 
 class LowLevelClientBase(ABC):
     @staticmethod

python/lib/sift_client/_internal/low_level_wrappers/calculated_channels.py

@@ -17,7 +17,7 @@
 )
 from sift.calculated_channels.v2.calculated_channels_pb2_grpc import CalculatedChannelServiceStub
 
-from sift_client._internal.low_level_wrappers.base import LowLevelClientBase
+from sift_client._internal.low_level_wrappers.base import DEFAULT_PAGE_SIZE, LowLevelClientBase
 from sift_client.sift_types.calculated_channel import (
     CalculatedChannel,
     CalculatedChannelCreate,
@@ -27,8 +27,6 @@
 
 logger = logging.getLogger(__name__)
 
-CALCULATED_CHANNELS_DEFAULT_PAGE_SIZE = 1000
-
 
 class CalculatedChannelsLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the CalculatedChannelsAPI.
@@ -93,7 +91,7 @@ async def list_all_calculated_channels(
         query_filter: str | None = None,
         order_by: str | None = None,
         max_results: int | None = None,
-        page_size: int | None = CALCULATED_CHANNELS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         organization_id: str | None = None,
     ) -> list[CalculatedChannel]:
         """List all calculated channels matching the given query.
@@ -119,7 +117,7 @@ async def list_all_calculated_channels(
     async def list_calculated_channels(
         self,
         *,
-        page_size: int | None = CALCULATED_CHANNELS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         order_by: str | None = None,
@@ -200,7 +198,7 @@ async def list_calculated_channel_versions(
         calculated_channel_id: str | None = None,
         client_key: str | None = None,
         organization_id: str | None = None,
-        page_size: int | None = CALCULATED_CHANNELS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         order_by: str | None = None,

python/lib/sift_client/_internal/low_level_wrappers/jobs.py

@@ -19,12 +19,10 @@
 )
 from sift.jobs.v1.jobs_pb2_grpc import JobServiceStub
 
-from sift_client._internal.low_level_wrappers.base import LowLevelClientBase
+from sift_client._internal.low_level_wrappers.base import DEFAULT_PAGE_SIZE, LowLevelClientBase
 from sift_client.sift_types.job import Job
 from sift_client.transport import GrpcClient, WithGrpcClient
 
-JOBS_DEFAULT_PAGE_SIZE = 1000
-
 
 class JobsLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the JobService API.
@@ -43,7 +41,7 @@ def __init__(self, grpc_client: GrpcClient):
     async def list_jobs(
         self,
         *,
-        page_size: int | None = JOBS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         organization_id: str | None = None,
@@ -85,7 +83,7 @@ async def list_all_jobs(
         query_filter: str | None = None,
         organization_id: str | None = None,
         order_by: str | None = None,
-        page_size: int | None = JOBS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         max_results: int | None = None,
     ) -> list[Job]:
         """List all jobs, handling pagination automatically.

python/lib/sift_client/_internal/low_level_wrappers/remote_files.py

@@ -18,6 +18,7 @@
 from sift.remote_files.v1.remote_files_pb2_grpc import RemoteFileServiceStub
 
 from sift_client._internal.low_level_wrappers.base import (
+    DEFAULT_PAGE_SIZE,
     LowLevelClientBase,
 )
 from sift_client.transport import GrpcClient, WithGrpcClient
@@ -26,8 +27,6 @@
     from sift_client.client import SiftClient
     from sift_client.sift_types.file_attachment import FileAttachment, FileAttachmentUpdate
 
-REMOTE_FILES_DEFAULT_PAGE_SIZE = 1000
-
 
 class RemoteFilesLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the RemoteFilesAPI.
@@ -66,7 +65,7 @@ async def list_all_remote_files(
         self,
         query_filter: str | None = None,
         max_results: int | None = None,
-        page_size: int | None = REMOTE_FILES_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         order_by: str | None = None,
         sift_client: SiftClient | None = None,
     ) -> list[FileAttachment]:
@@ -93,7 +92,7 @@ async def list_all_remote_files(
 
     async def list_remote_files(
         self,
-        page_size: int | None = REMOTE_FILES_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         order_by: str | None = None,

python/lib/sift_client/_internal/low_level_wrappers/rules.py

@@ -37,7 +37,7 @@
 )
 from sift.rules.v1.rules_pb2_grpc import RuleServiceStub
 
-from sift_client._internal.low_level_wrappers.base import LowLevelClientBase
+from sift_client._internal.low_level_wrappers.base import DEFAULT_PAGE_SIZE, LowLevelClientBase
 from sift_client._internal.low_level_wrappers.reports import ReportsLowLevelClient
 from sift_client._internal.util.timestamp import to_pb_timestamp
 from sift_client._internal.util.util import count_non_none
@@ -58,8 +58,6 @@
 # Configure logging
 logger = logging.getLogger(__name__)
 
-DEFAULT_RULE_PAGE_SIZE = 1000
-
 
 class RulesLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the RulesAPI.
@@ -497,7 +495,7 @@ async def list_all_rules(
         filter_query: str | None = None,
         order_by: str | None = None,
         max_results: int | None = None,
-        page_size: int | None = DEFAULT_RULE_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
     ) -> list[Rule]:
         """List all rules."""
         return await self._handle_pagination(

python/lib/sift_client/_internal/low_level_wrappers/runs.py

@@ -18,7 +18,7 @@
 )
 from sift.runs.v2.runs_pb2_grpc import RunServiceStub
 
-from sift_client._internal.low_level_wrappers.base import LowLevelClientBase
+from sift_client._internal.low_level_wrappers.base import DEFAULT_PAGE_SIZE, LowLevelClientBase
 from sift_client._internal.util.timestamp import to_pb_timestamp
 from sift_client.sift_types.run import Run, RunCreate, RunUpdate
 from sift_client.transport import WithGrpcClient
@@ -31,8 +31,6 @@
 # Configure logging
 logger = logging.getLogger(__name__)
 
-RUNS_DEFAULT_PAGE_SIZE = 1000
-
 
 class RunsLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the RunsAPI.
@@ -68,7 +66,7 @@ async def get_run(self, run_id: str) -> Run:
     async def list_runs(
         self,
         *,
-        page_size: int | None = RUNS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         order_by: str | None = None,
@@ -106,7 +104,7 @@ async def list_all_runs(
         *,
         query_filter: str | None = None,
         order_by: str | None = None,
-        page_size: int | None = RUNS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         max_results: int | None = None,
     ) -> list[Run]:
         """List all runs with optional filtering.

python/lib/sift_client/_internal/low_level_wrappers/tags.py

@@ -11,7 +11,7 @@
 )
 from sift.tags.v2.tags_pb2_grpc import TagServiceStub
 
-from sift_client._internal.low_level_wrappers.base import LowLevelClientBase
+from sift_client._internal.low_level_wrappers.base import DEFAULT_PAGE_SIZE, LowLevelClientBase
 from sift_client.sift_types.tag import Tag
 from sift_client.transport import WithGrpcClient
 
@@ -21,8 +21,6 @@
 # Configure logging
 logger = logging.getLogger(__name__)
 
-TAGS_DEFAULT_PAGE_SIZE = 1000
-
 
 class TagsLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the TagsAPI.
@@ -61,7 +59,7 @@ async def create_tag(self, name: str) -> Tag:
     async def list_tags(
         self,
         *,
-        page_size: int | None = TAGS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         order_by: str | None = None,
@@ -99,7 +97,7 @@ async def list_all_tags(
         *,
         query_filter: str | None = None,
         order_by: str | None = None,
-        page_size: int | None = TAGS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         max_results: int | None = None,
     ) -> list[Tag]:
         """List all tags with optional filtering.

python/lib/sift_client/_internal/low_level_wrappers/test_results.py

@@ -33,7 +33,7 @@
 )
 from sift.test_reports.v1.test_reports_pb2_grpc import TestReportServiceStub
 
-from sift_client._internal.low_level_wrappers.base import LowLevelClientBase
+from sift_client._internal.low_level_wrappers.base import DEFAULT_PAGE_SIZE, LowLevelClientBase
 from sift_client.sift_types.test_report import (
     TestMeasurement,
     TestMeasurementCreate,
@@ -53,10 +53,6 @@
 # Configure logging
 logger = logging.getLogger(__name__)
 
-TEST_REPORTS_DEFAULT_PAGE_SIZE = 1000
-TEST_STEPS_DEFAULT_PAGE_SIZE = 1000
-TEST_MEASUREMENTS_DEFAULT_PAGE_SIZE = 1000
-
 
 class TestResultsLowLevelClient(LowLevelClientBase, WithGrpcClient):
     """Low-level client for the TestResultsAPI.
@@ -133,7 +129,7 @@ async def get_test_report(self, test_report_id: str) -> TestReport:
     async def list_test_reports(
         self,
         *,
-        page_size: int | None = TEST_REPORTS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         order_by: str | None = None,
@@ -171,7 +167,7 @@ async def list_all_test_reports(
         *,
         query_filter: str | None = None,
         order_by: str | None = None,
-        page_size: int | None = TEST_REPORTS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         max_results: int | None = None,
     ) -> list[TestReport]:
         """List all test reports with optional filtering.
@@ -280,7 +276,7 @@ async def list_all_test_steps(
         query_filter: str | None = None,
         order_by: str | None = None,
         max_results: int | None = None,
-        page_size: int | None = TEST_STEPS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
     ) -> list[TestStep]:
         """List all test steps with optional filtering.
 
@@ -375,7 +371,7 @@ async def create_test_measurements(
     async def list_test_measurements(
         self,
         *,
-        page_size: int | None = TEST_MEASUREMENTS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
         page_token: str | None = None,
         query_filter: str | None = None,
         order_by: str | None = None,
@@ -416,7 +412,7 @@ async def list_all_test_measurements(
         query_filter: str | None = None,
         order_by: str | None = None,
         max_results: int | None = None,
-        page_size: int | None = TEST_MEASUREMENTS_DEFAULT_PAGE_SIZE,
+        page_size: int | None = DEFAULT_PAGE_SIZE,
     ) -> list[TestMeasurement]:
         """List all test measurements with optional filtering.