docs: Document raised exceptions in client methods

Replace `:raises: TODO` placeholders with actual exception documentation
in RawSynchronousFlyteClient and SynchronousFlyteClient methods.

The documented exceptions are based on the RetryExceptionWrapperInterceptor
which converts gRPC status codes to Flyte exceptions:
- FlyteAuthenticationException (UNAUTHENTICATED)
- FlyteEntityNotExistException (NOT_FOUND)
- FlyteEntityAlreadyExistsException (ALREADY_EXISTS)
- FlyteInvalidInputException (INVALID_ARGUMENT)
- FlyteSystemException (other errors)

This improves API documentation and helps users understand what
exceptions to expect when using the client methods.

Author: andreahlert

flytekit/clients/friendly.py

@@ -106,7 +106,9 @@ def list_task_ids_paginated(self, project, domain, limit=100, token=None, sort_b
             If you previously retrieved a page response with token="foo" and you want the next page,
             specify token="foo". Please see the notes for this function about the caveats of the paginated API.
         :param flytekit.models.admin.common.Sort sort_by: [Optional] If provided, the results will be sorted.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: list[flytekit.models.common.NamedEntityIdentifier], Text
         """
         identifier_list = super(SynchronousFlyteClient, self).list_task_ids_paginated(
@@ -146,7 +148,9 @@ def list_tasks_paginated(self, identifier, limit=100, token=None, filters=None,
         :param list[flytekit.models.filters.Filter] filters: [Optional] If specified, the filters will be applied to
             the query.  If the filter is not supported, an exception will be raised.
         :param flytekit.models.admin.common.Sort sort_by: [Optional] If provided, the results will be sorted.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: list[flytekit.models.task.Task], Text
         """
         task_list = super(SynchronousFlyteClient, self).list_tasks_paginated(
@@ -172,7 +176,10 @@ def get_task(self, id):
         This returns a single task for a given identifier.
 
         :param flytekit.models.core.identifier.Identifier id: The ID representing a given task.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteEntityNotExistException: If the task does not exist.
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: flytekit.models.task.Task
         """
         return _task.Task.from_flyte_idl(
@@ -231,7 +238,9 @@ def list_workflow_ids_paginated(self, project, domain, limit=100, token=None, so
             If you previously retrieved a page response with token="foo" and you want the next page,
             specify token="foo". Please see the notes for this function about the caveats of the paginated API.
         :param flytekit.models.admin.common.Sort sort_by: [Optional] If provided, the results will be sorted.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: list[flytekit.models.common.NamedEntityIdentifier], Text
         """
         identifier_list = super(SynchronousFlyteClient, self).list_workflow_ids_paginated(
@@ -271,7 +280,9 @@ def list_workflows_paginated(self, identifier, limit=100, token=None, filters=No
         :param list[flytekit.models.filters.Filter] filters: [Optional] If specified, the filters will be applied to
             the query.  If the filter is not supported, an exception will be raised.
         :param flytekit.models.admin.common.Sort sort_by: [Optional] If provided, the results will be sorted.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: list[flytekit.models.admin.workflow.Workflow], Text
         """
         wf_list = super(SynchronousFlyteClient, self).list_workflows_paginated(
@@ -297,7 +308,10 @@ def get_workflow(self, id):
         This returns a single workflow for a given ID.
 
         :param flytekit.models.core.identifier.Identifier id: The ID representing a given task.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteEntityNotExistException: If the workflow does not exist.
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: flytekit.models.admin.workflow.Workflow
         """
         return _workflow.Workflow.from_flyte_idl(
@@ -383,7 +397,9 @@ def list_launch_plan_ids_paginated(self, project, domain, limit=100, token=None,
             If you previously retrieved a page response with token="foo" and you want the next page,
             specify token="foo". Please see the notes for this function about the caveats of the paginated API.
         :param flytekit.models.admin.common.Sort sort_by: [Optional] If provided, the results will be sorted.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: list[flytekit.models.common.NamedEntityIdentifier], Text
         """
         identifier_list = super(SynchronousFlyteClient, self).list_launch_plan_ids_paginated(
@@ -423,7 +439,9 @@ def list_launch_plans_paginated(self, identifier, limit=100, token=None, filters
         :param list[flytekit.models.filters.Filter] filters: [Optional] If specified, the filters will be applied to
             the query.  If the filter is not supported, an exception will be raised.
         :param flytekit.models.admin.common.Sort sort_by: [Optional] If provided, the results will be sorted.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: list[flytekit.models.launch_plan.LaunchPlan], str
         """
         lp_list = super(SynchronousFlyteClient, self).list_launch_plans_paginated(
@@ -467,7 +485,9 @@ def list_active_launch_plans_paginated(
             If you previously retrieved a page response with token="foo" and you want the next page,
             specify token="foo". Please see the notes for this function about the caveats of the paginated API.
         :param flytekit.models.admin.common.Sort sort_by: [Optional] If provided, the results will be sorted.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: list[flytekit.models.launch_plan.LaunchPlan], str
         """
         lp_list = super(SynchronousFlyteClient, self).list_active_launch_plans_paginated(
@@ -615,7 +635,9 @@ def list_executions_paginated(self, project, domain, limit=100, token=None, filt
         :param list[flytekit.models.filters.Filter] filters: [Optional] If specified, the filters will be applied to
             the query.  If the filter is not supported, an exception will be raised.
         :param flytekit.models.admin.common.Sort sort_by: [Optional] If provided, the results will be sorted.
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         :rtype: (list[flytekit.models.execution.Execution], Text)
         """
         exec_list = super(SynchronousFlyteClient, self).list_executions_paginated(

flytekit/clients/raw.py

@@ -124,7 +124,9 @@ def list_task_ids_paginated(self, identifier_list_request):
 
         :param: flyteidl.admin.common_pb2.NamedEntityIdentifierListRequest identifier_list_request:
         :rtype: flyteidl.admin.common_pb2.NamedEntityIdentifierList
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         """
         return self._stub.ListTaskIds(identifier_list_request, metadata=self._metadata)
 
@@ -143,7 +145,9 @@ def list_tasks_paginated(self, resource_list_request):
 
         :param: flyteidl.admin.common_pb2.ResourceListRequest resource_list_request:
         :rtype: flyteidl.admin.task_pb2.TaskList
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         """
         return self._stub.ListTasks(resource_list_request, metadata=self._metadata)
 
@@ -153,7 +157,10 @@ def get_task(self, get_object_request):
 
         :param: flyteidl.admin.common_pb2.ObjectGetRequest get_object_request:
         :rtype: flyteidl.admin.task_pb2.Task
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteEntityNotExistException: If the task does not exist.
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         """
         return self._stub.GetTask(get_object_request, metadata=self._metadata)
 
@@ -212,7 +219,9 @@ def list_workflow_ids_paginated(self, identifier_list_request):
 
         :param: flyteidl.admin.common_pb2.NamedEntityIdentifierListRequest identifier_list_request:
         :rtype: flyteidl.admin.common_pb2.NamedEntityIdentifierList
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         """
         return self._stub.ListWorkflowIds(identifier_list_request, metadata=self._metadata)
 
@@ -231,7 +240,9 @@ def list_workflows_paginated(self, resource_list_request):
 
         :param: flyteidl.admin.common_pb2.ResourceListRequest resource_list_request:
         :rtype: flyteidl.admin.workflow_pb2.WorkflowList
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         """
         return self._stub.ListWorkflows(resource_list_request, metadata=self._metadata)
 
@@ -241,7 +252,10 @@ def get_workflow(self, get_object_request):
 
         :param: flyteidl.admin.common_pb2.ObjectGetRequest get_object_request:
         :rtype: flyteidl.admin.workflow_pb2.Workflow
-        :raises: TODO
+        :raises flytekit.exceptions.user.FlyteEntityNotExistException: If the workflow does not exist.
+        :raises flytekit.exceptions.user.FlyteAuthenticationException: If the request is not authenticated.
+        :raises flytekit.exceptions.user.FlyteInvalidInputException: If the request contains invalid parameters.
+        :raises flytekit.exceptions.system.FlyteSystemException: If an unexpected error occurs.
         """
         return self._stub.GetWorkflow(get_object_request, metadata=self._metadata)