cirro-api-client 1.7.0__tar.gz → 1.7.2__tar.gz

{cirro_api_client-1.7.0 → cirro_api_client-1.7.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cirro_api_client
-Version: 1.7.0
+Version: 1.7.2
 Summary: A client library for accessing Cirro
 License: MIT
 Keywords: Cirro

cirro_api_client-1.7.2/cirro_api_client/v1/api/dashboards/delete_dashboard.py

@@ -0,0 +1,109 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...types import Response
+
+
+def _get_kwargs(
+    project_id: str,
+    dashboard_id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "delete",
+        "url": "/projects/{project_id}/dashboards/{dashboard_id}".format(
+            project_id=quote(str(project_id), safe=""),
+            dashboard_id=quote(str(dashboard_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> Any | None:
+    if response.status_code == 204:
+        return None
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    dashboard_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Delete dashboard
+
+     Deletes a dashboard
+
+    Args:
+        project_id (str):
+        dashboard_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        dashboard_id=dashboard_id,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio_detailed(
+    project_id: str,
+    dashboard_id: str,
+    *,
+    client: Client,
+) -> Response[Any]:
+    """Delete dashboard
+
+     Deletes a dashboard
+
+    Args:
+        project_id (str):
+        dashboard_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Any]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        dashboard_id=dashboard_id,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)

cirro_api_client-1.7.2/cirro_api_client/v1/api/execution/get_task_lineage.py

@@ -0,0 +1,194 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import Client
+from ...models.get_task_lineage_response import GetTaskLineageResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    project_id: str,
+    dataset_id: str,
+    task_id: str,
+) -> dict[str, Any]:
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/projects/{project_id}/execution/{dataset_id}/tasks/{task_id}/lineage".format(
+            project_id=quote(str(project_id), safe=""),
+            dataset_id=quote(str(dataset_id), safe=""),
+            task_id=quote(str(task_id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: Client, response: httpx.Response) -> GetTaskLineageResponse | None:
+    if response.status_code == 200:
+        response_200 = GetTaskLineageResponse.from_dict(response.json())
+
+        return response_200
+
+    errors.handle_error_response(response, client.raise_on_unexpected_status)
+
+
+def _build_response(*, client: Client, response: httpx.Response) -> Response[GetTaskLineageResponse]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    dataset_id: str,
+    task_id: str,
+    *,
+    client: Client,
+) -> Response[GetTaskLineageResponse]:
+    """Get task lineage
+
+     Gets detailed lineage information on the individual Nextflow task
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        task_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetTaskLineageResponse]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        dataset_id=dataset_id,
+        task_id=task_id,
+    )
+
+    response = client.get_httpx_client().request(
+        auth=client.get_auth(),
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    project_id: str,
+    dataset_id: str,
+    task_id: str,
+    *,
+    client: Client,
+) -> GetTaskLineageResponse | None:
+    """Get task lineage
+
+     Gets detailed lineage information on the individual Nextflow task
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        task_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetTaskLineageResponse
+    """
+
+    try:
+        return sync_detailed(
+            project_id=project_id,
+            dataset_id=dataset_id,
+            task_id=task_id,
+            client=client,
+        ).parsed
+    except errors.NotFoundException:
+        return None
+
+
+async def asyncio_detailed(
+    project_id: str,
+    dataset_id: str,
+    task_id: str,
+    *,
+    client: Client,
+) -> Response[GetTaskLineageResponse]:
+    """Get task lineage
+
+     Gets detailed lineage information on the individual Nextflow task
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        task_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[GetTaskLineageResponse]
+    """
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+        dataset_id=dataset_id,
+        task_id=task_id,
+    )
+
+    response = await client.get_async_httpx_client().request(auth=client.get_auth(), **kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    project_id: str,
+    dataset_id: str,
+    task_id: str,
+    *,
+    client: Client,
+) -> GetTaskLineageResponse | None:
+    """Get task lineage
+
+     Gets detailed lineage information on the individual Nextflow task
+
+    Args:
+        project_id (str):
+        dataset_id (str):
+        task_id (str):
+        client (Client): instance of the API client
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        GetTaskLineageResponse
+    """
+
+    try:
+        return (
+            await asyncio_detailed(
+                project_id=project_id,
+                dataset_id=dataset_id,
+                task_id=task_id,
+                client=client,
+            )
+        ).parsed
+    except errors.NotFoundException:
+        return None

cirro_api_client-1.7.0/cirro_api_client/v1/api/sheets/query_namespace_data.py → cirro_api_client-1.7.2/cirro_api_client/v1/api/sheets/query_data.py

@@ -57,9 +57,10 @@ def sync_detailed(
     client: Client,
     body: SheetQueryRequest,
 ) -> Response[SheetQueryResponse]:
-    """Run raw SQL against the project's sheets.
+    """Run a raw SQL query against the project's sheets
 
-     Returns executed SQL results.
+     Runs a read-only SQL query and returns a page of its results. Unqualified table names resolve across
+    every namespace in the project.
 
     Args:
         project_id (str):
@@ -93,9 +94,10 @@ def sync(
     client: Client,
     body: SheetQueryRequest,
 ) -> SheetQueryResponse | None:
-    """Run raw SQL against the project's sheets.
+    """Run a raw SQL query against the project's sheets
 
-     Returns executed SQL results.
+     Runs a read-only SQL query and returns a page of its results. Unqualified table names resolve across
+    every namespace in the project.
 
     Args:
         project_id (str):
@@ -126,9 +128,10 @@ async def asyncio_detailed(
     client: Client,
     body: SheetQueryRequest,
 ) -> Response[SheetQueryResponse]:
-    """Run raw SQL against the project's sheets.
+    """Run a raw SQL query against the project's sheets
 
-     Returns executed SQL results.
+     Runs a read-only SQL query and returns a page of its results. Unqualified table names resolve across
+    every namespace in the project.
 
     Args:
         project_id (str):
@@ -159,9 +162,10 @@ async def asyncio(
     client: Client,
     body: SheetQueryRequest,
 ) -> SheetQueryResponse | None:
-    """Run raw SQL against the project's sheets.
+    """Run a raw SQL query against the project's sheets
 
-     Returns executed SQL results.
+     Runs a read-only SQL query and returns a page of its results. Unqualified table names resolve across
+    every namespace in the project.
 
     Args:
         project_id (str):

{cirro_api_client-1.7.0 → cirro_api_client-1.7.2}/cirro_api_client/v1/models/__init__.py

@@ -106,6 +106,8 @@ from .generate_sftp_credentials_request import GenerateSftpCredentialsRequest
 from .get_execution_logs_response import GetExecutionLogsResponse
 from .get_project_summary_response_200 import GetProjectSummaryResponse200
 from .get_task_files_response import GetTaskFilesResponse
+from .get_task_lineage_response import GetTaskLineageResponse
+from .get_task_lineage_response_lineage import GetTaskLineageResponseLineage
 from .governance_access_type import GovernanceAccessType
 from .governance_classification import GovernanceClassification
 from .governance_contact import GovernanceContact
@@ -237,7 +239,6 @@ from .sheet_job import SheetJob
 from .sheet_job_type import SheetJobType
 from .sheet_query_request import SheetQueryRequest
 from .sheet_query_response import SheetQueryResponse
-from .sheet_query_response_rows_item import SheetQueryResponseRowsItem
 from .sheet_sort import SheetSort
 from .sheet_type import SheetType
 from .sheet_update_response import SheetUpdateResponse
@@ -391,6 +392,8 @@ __all__ = (
     "GetExecutionLogsResponse",
     "GetProjectSummaryResponse200",
     "GetTaskFilesResponse",
+    "GetTaskLineageResponse",
+    "GetTaskLineageResponseLineage",
     "GovernanceAccessType",
     "GovernanceClassification",
     "GovernanceContact",
@@ -522,7 +525,6 @@ __all__ = (
     "SheetJobType",
     "SheetQueryRequest",
     "SheetQueryResponse",
-    "SheetQueryResponseRowsItem",
     "SheetSort",
     "SheetType",
     "SheetUpdateResponse",

{cirro_api_client-1.7.0 → cirro_api_client-1.7.2}/cirro_api_client/v1/models/file_def.py

@@ -16,7 +16,8 @@ class FileDef:
     """
     Attributes:
         file_type (FileType):
-        storage_uri (str): Full S3 URI to the source file.
+        storage_uri (str): Full S3 URI to the source file. For an ingest, it must be under the sheet's staging upload
+            path.
     """
 
     file_type: FileType

cirro_api_client-1.7.2/cirro_api_client/v1/models/get_task_lineage_response.py

@@ -0,0 +1,74 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import TYPE_CHECKING, Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+from ..types import UNSET, Unset
+
+if TYPE_CHECKING:
+    from ..models.get_task_lineage_response_lineage import GetTaskLineageResponseLineage
+
+
+T = TypeVar("T", bound="GetTaskLineageResponse")
+
+
+@_attrs_define
+class GetTaskLineageResponse:
+    """
+    Attributes:
+        lineage (GetTaskLineageResponseLineage | Unset): Lineage specific to the executor
+    """
+
+    lineage: GetTaskLineageResponseLineage | Unset = UNSET
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+        lineage: dict[str, Any] | Unset = UNSET
+        if not isinstance(self.lineage, Unset):
+            lineage = self.lineage.to_dict()
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+        field_dict.update({})
+        if lineage is not UNSET:
+            field_dict["lineage"] = lineage
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        from ..models.get_task_lineage_response_lineage import GetTaskLineageResponseLineage
+
+        d = dict(src_dict)
+        _lineage = d.pop("lineage", UNSET)
+        lineage: GetTaskLineageResponseLineage | Unset
+        if isinstance(_lineage, Unset):
+            lineage = UNSET
+        else:
+            lineage = GetTaskLineageResponseLineage.from_dict(_lineage)
+
+        get_task_lineage_response = cls(
+            lineage=lineage,
+        )
+
+        get_task_lineage_response.additional_properties = d
+        return get_task_lineage_response
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

cirro_api_client-1.7.2/cirro_api_client/v1/models/get_task_lineage_response_lineage.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any, TypeVar
+
+from attrs import define as _attrs_define
+from attrs import field as _attrs_field
+
+T = TypeVar("T", bound="GetTaskLineageResponseLineage")
+
+
+@_attrs_define
+class GetTaskLineageResponseLineage:
+    """Lineage specific to the executor"""
+
+    additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
+
+    def to_dict(self) -> dict[str, Any]:
+
+        field_dict: dict[str, Any] = {}
+        field_dict.update(self.additional_properties)
+
+        return field_dict
+
+    @classmethod
+    def from_dict(cls: type[T], src_dict: Mapping[str, Any]) -> T:
+        d = dict(src_dict)
+        get_task_lineage_response_lineage = cls()
+
+        get_task_lineage_response_lineage.additional_properties = d
+        return get_task_lineage_response_lineage
+
+    @property
+    def additional_keys(self) -> list[str]:
+        return list(self.additional_properties.keys())
+
+    def __getitem__(self, key: str) -> Any:
+        return self.additional_properties[key]
+
+    def __setitem__(self, key: str, value: Any) -> None:
+        self.additional_properties[key] = value
+
+    def __delitem__(self, key: str) -> None:
+        del self.additional_properties[key]
+
+    def __contains__(self, key: str) -> bool:
+        return key in self.additional_properties

{cirro_api_client-1.7.0 → cirro_api_client-1.7.2}/cirro_api_client/v1/models/run_analysis_request.py

@@ -43,6 +43,7 @@ class RunAnalysisRequest:
         environment_type (EnvironmentType | None | Unset): The type of execution environment to run the workflow in, if
             not specified, the default for the pipeline is used
         tags (list[Tag] | None | Unset): List of tags to apply to the dataset
+        disable_cache (bool | None | Unset): Disables the task run cache Default: False.
     """
 
     name: str
@@ -58,6 +59,7 @@ class RunAnalysisRequest:
     compute_environment_id: None | str | Unset = UNSET
     environment_type: EnvironmentType | None | Unset = UNSET
     tags: list[Tag] | None | Unset = UNSET
+    disable_cache: bool | None | Unset = False
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
 
     def to_dict(self) -> dict[str, Any]:
@@ -137,6 +139,12 @@ class RunAnalysisRequest:
         else:
             tags = self.tags
 
+        disable_cache: bool | None | Unset
+        if isinstance(self.disable_cache, Unset):
+            disable_cache = UNSET
+        else:
+            disable_cache = self.disable_cache
+
         field_dict: dict[str, Any] = {}
         field_dict.update(self.additional_properties)
         field_dict.update(
@@ -164,6 +172,8 @@ class RunAnalysisRequest:
             field_dict["environmentType"] = environment_type
         if tags is not UNSET:
             field_dict["tags"] = tags
+        if disable_cache is not UNSET:
+            field_dict["disableCache"] = disable_cache
 
         return field_dict
 
@@ -302,6 +312,15 @@ class RunAnalysisRequest:
 
         tags = _parse_tags(d.pop("tags", UNSET))
 
+        def _parse_disable_cache(data: object) -> bool | None | Unset:
+            if data is None:
+                return data
+            if isinstance(data, Unset):
+                return data
+            return cast(bool | None | Unset, data)
+
+        disable_cache = _parse_disable_cache(d.pop("disableCache", UNSET))
+
         run_analysis_request = cls(
             name=name,
             process_id=process_id,
@@ -316,6 +335,7 @@ class RunAnalysisRequest:
             compute_environment_id=compute_environment_id,
             environment_type=environment_type,
             tags=tags,
+            disable_cache=disable_cache,
         )
 
         run_analysis_request.additional_properties = d

{cirro_api_client-1.7.0 → cirro_api_client-1.7.2}/cirro_api_client/v1/models/sheet_query_request.py

@@ -15,16 +15,13 @@ T = TypeVar("T", bound="SheetQueryRequest")
 class SheetQueryRequest:
     """
     Attributes:
-        query (str): Raw SQL query to run.
-        namespace_name (None | str | Unset): Deprecated: no longer scopes name resolution — every namespace is on the
-            engine's search path. Example: default.
+        query (str): Raw SQL query to run. Unqualified table names resolve across every namespace in the project.
         limit (int | None | Unset): Maximum rows to return. Responses also have a size limit: with wide rows a large
             page can fail with a 502 — lower the limit if so. Default: 1000.
         page (int | None | Unset): Page to return Default: 1.
     """
 
     query: str
-    namespace_name: None | str | Unset = UNSET
     limit: int | None | Unset = 1000
     page: int | None | Unset = 1
     additional_properties: dict[str, Any] = _attrs_field(init=False, factory=dict)
@@ -32,12 +29,6 @@ class SheetQueryRequest:
     def to_dict(self) -> dict[str, Any]:
         query = self.query
 
-        namespace_name: None | str | Unset
-        if isinstance(self.namespace_name, Unset):
-            namespace_name = UNSET
-        else:
-            namespace_name = self.namespace_name
-
         limit: int | None | Unset
         if isinstance(self.limit, Unset):
             limit = UNSET
@@ -57,8 +48,6 @@ class SheetQueryRequest:
                 "query": query,
             }
         )
-        if namespace_name is not UNSET:
-            field_dict["namespaceName"] = namespace_name
         if limit is not UNSET:
             field_dict["limit"] = limit
         if page is not UNSET:
@@ -71,15 +60,6 @@ class SheetQueryRequest:
         d = dict(src_dict)
         query = d.pop("query")
 
-        def _parse_namespace_name(data: object) -> None | str | Unset:
-            if data is None:
-                return data
-            if isinstance(data, Unset):
-                return data
-            return cast(None | str | Unset, data)
-
-        namespace_name = _parse_namespace_name(d.pop("namespaceName", UNSET))
-
         def _parse_limit(data: object) -> int | None | Unset:
             if data is None:
                 return data
@@ -100,7 +80,6 @@ class SheetQueryRequest:
 
         sheet_query_request = cls(
             query=query,
-            namespace_name=namespace_name,
             limit=limit,
             page=page,
         )