polarion_rest_api_client.clients package

Submodules

polarion_rest_api_client.clients.base_classes module

Base classes for client implementations on project Level.

class polarion_rest_api_client.clients.base_classes.BaseClient(project_id: str, client: polarion_client.PolarionClient)

Bases: ABC

The overall base client for all project related clients.

unset_to_none(value: Unset) → None
unset_to_none(value: UT) → UT

Return None if value is Unset, else the value.

class polarion_rest_api_client.clients.base_classes.ItemsClient(project_id: str, client: polarion_client.PolarionClient)

Bases: BaseClient, Generic[T], ABC

A client for items of a project, which can be created or requested.

create(items: T | list[T])

Create one or multiple items.

delete(items: T | list[T])

Delete one or multiple items.

abstractmethod get(*args, **kwargs) → T | None

Get a specific single item.

get_all(*args, **kwargs) → list[T]

Return all matching items using get_multi with auto pagination.

abstractmethod get_multi(*args: Any, page_size: int = 100, page_number: int = 1, **kwargs: Any) → tuple[list[T], bool]

Get multiple matching items for a specific page.

In addition, a flag whether a next page is available is returned.

class polarion_rest_api_client.clients.base_classes.SingleUpdatableItemsMixin

Bases: Generic[T]

Mixin to split batches into single items.

class polarion_rest_api_client.clients.base_classes.StatusItemClient(project_id: str, client: polarion_client.PolarionClient, delete_status: str | None = None)

Bases: UpdatableItemsClient, Generic[ST], ABC

A client for items, which have a status.

We support to set a specific status for these instead of deleting them. This status has to be provided on initialization.

delete(items: ST | list[ST])

Delete the item if no delete_status was set, else update status.

item_cls: type[ST]
class polarion_rest_api_client.clients.base_classes.UpdatableItemsClient(project_id: str, client: polarion_client.PolarionClient)

Bases: ItemsClient, Generic[T], ABC

A client for items which can also be updated.

update(items: T | list[T])

Update the provided item or items.

polarion_rest_api_client.clients.documents module

Implementation of the documents client.

class polarion_rest_api_client.clients.documents.Documents(project_id: str, client: polarion_client.PolarionClient)

Bases: SingleUpdatableItemsMixin[Document], UpdatableItemsClient[Document]

A client to work with documents in Polarion.

get(space_id: str, document_name: str, fields: dict[str, str] | None = None, include: str | None | Unset = None, revision: str | None | Unset = None) → Document | None

Return the document with the given document_name and space_id.

get_multi(*args, page_size=100, page_number=1, **kwargs) → tuple[list[Document], bool]

Return a list of documents - Not implemented yet.

polarion_rest_api_client.clients.projects module

A client for a specific project, using the session of PolarionClient.

class polarion_rest_api_client.clients.projects.ProjectClient(project_id: str, client: polarion_client.PolarionClient, delete_status: str | None = None)

Bases: BaseClient

A client for a specific project.

exists()

Return True, if the clients project exists.

polarion_rest_api_client.clients.test_records module

class polarion_rest_api_client.clients.test_records.TestRecords(project_id: str, client: polarion_client.PolarionClient)

Bases: SingleUpdatableItemsMixin[TestRecord], UpdatableItemsClient[TestRecord]

get(*args, **kwargs) → TestRecord

Get a specific single item.

get_multi(test_run_id: str, *, page_size: int = 100, page_number: int = 1, fields: dict[str, str] | None = None) → tuple[list[TestRecord], bool]

Get multiple matching items for a specific page.

In addition, a flag whether a next page is available is returned.

polarion_rest_api_client.clients.test_runs module

class polarion_rest_api_client.clients.test_runs.TestRuns(project_id: str, client: polarion_client.PolarionClient)

Bases: SingleUpdatableItemsMixin[TestRun], UpdatableItemsClient[TestRun]

get(*args, **kwargs) → TestRun

Get a specific single item.

get_multi(query: str = '', *, page_size: int = 100, page_number: int = 1, fields: dict[str, str] | None = None) → tuple[list[TestRun], bool]

Return the test runs on a defined page matching the given query.

In addition, a flag whether a next page is available is returned. Define a fields dictionary as described in the Polarion API documentation to get certain fields.

polarion_rest_api_client.clients.test_steps module

class polarion_rest_api_client.clients.test_steps.TestSteps(project_id: str, client: polarion_client.PolarionClient)

Bases: UpdatableItemsClient[TestStep]

get(*args, **kwargs) → TestStep

Get a specific single item.

get_multi(work_item_id: str, *, page_size: int = 100, page_number: int = 1, fields: dict[str, str] | None = None) → tuple[list[TestStep], bool]

Get multiple matching items for a specific page.

In addition, a flag whether a next page is available is returned.

polarion_rest_api_client.clients.work_item_attachments module

Implementations of WorkItemAttachment relates functions.

class polarion_rest_api_client.clients.work_item_attachments.WorkItemAttachments(project_id: str, client: polarion_client.PolarionClient)

Bases: SingleUpdatableItemsMixin[WorkItemAttachment], UpdatableItemsClient[WorkItemAttachment]

A class to handle WorkItemAttachments.

get(*args, **kwargs) → WorkItemAttachment

Return a specific attachment - not Implemented yet.

get_multi(work_item_id: str, *, page_size: int = 100, page_number: int = 1, fields: dict[str, str] | None = None) → tuple[list[WorkItemAttachment], bool]

Return the attachments for a given work item on a defined page.

In addition, a flag whether a next page is available is returned. Define a fields dictionary as described in the Polarion API documentation to get certain fields.

polarion_rest_api_client.clients.work_items module

Implementation of a client providing work item specific functions.

class polarion_rest_api_client.clients.work_items.WorkItems(project_id: str, client: polarion_client.PolarionClient, delete_status: str | None = None)

Bases: SingleUpdatableItemsMixin, StatusItemClient

A project specific client for work item operations.

create(items: WorkItem | list[WorkItem])

Create WorkItems and respect the max body size of the server.

get(work_item_id: str, work_item_cls: type[WT], revision: str | None = None) → WT | None
get(work_item_id: str, *, revision: str | None = None) → WorkItem | None

Return one specific work item with all fields.

This also includes all linked work items and attachments. If there are to many of these to get them in one request, the truncated flags for linked_work_items and attachments will be set to True.

get_multi(query: str = '', *, page_size: int = 100, page_number: int = 1, fields: dict[str, str] | None = None, work_item_cls: type[WT]) → tuple[list[WT], bool]
get_multi(query: str = '', *, page_size: int = 100, page_number: int = 1, fields: dict[str, str] | None = None) → tuple[list[WorkItem], bool]

Return the work items on a defined page matching the given query.

In addition, a flag whether a next page is available is returned. Define a fields dictionary as described in the Polarion API documentation to get certain fields.

Module contents

Implementations for all project specific clients.