Skip to main content

aip_sdk.iter_test_plans

aip_sdk.iter_test_plans(*, workspace_id: str | None = None, per_page: int = 100, client: APIClient | None = None) -> Iterator[TestPlanSummary]

Iterate every test plan in a workspace at its latest version, auto-paginating.

Parameters

  • workspace_id str | None: Workspace to list from. Falls back to the client's configured workspace.
  • per_page int: Page size used internally for each request (1-100).
  • client APIClient | None: Explicit API client. Uses the default client when omitted.

Yields

  • TestPlanSummary: Each plan at its latest published version, as a TestPlanSummary, across as many pages
  • TestPlanSummary: as it takes. Not a point-in-time snapshot: a plan published or edited mid-iteration can
  • TestPlanSummary: shift rows across a page boundary.

Raises

  • NoWorkspaceSelectedError: No workspace was given and the client has none configured. Raised at this call, before any request.
  • InvalidArgumentError: per_page is out of range. Raised at this call, before any request.
  • AuthError: Credentials are missing, invalid, or expired.
  • ForbiddenError: The caller is not a member of the workspace.
  • NotFoundError: The workspace does not exist.
  • ResponseParseError: A platform response did not match the shape this SDK version expects. Usually means the platform is running a newer release; upgrading resolves it.
  • APIError: Any other error from the platform.

Examples

import aip_sdk as aip

names = sorted(record.name for record in aip.iter_test_plans(workspace_id="ws_001"))