Rename AvailableTask to Task

Author: Hironsan

doccano_client/client.py

@@ -5,8 +5,8 @@
 
 from doccano_client.models.comment import Comment
 from doccano_client.models.data_download import Option as DataExportOption
-from doccano_client.models.data_upload import AvailableTask
 from doccano_client.models.data_upload import Option as DataImportOption
+from doccano_client.models.data_upload import Task
 from doccano_client.models.example import Example
 from doccano_client.models.label import (
     BoundingBox,
@@ -708,17 +708,20 @@ def upload(
         self,
         project_id: int,
         file_paths: List[str],
-        task: AvailableTask,
+        task: Task,
         format: str,
         column_data: str = "text",
         column_label: str = "label",
     ) -> TaskStatus:
-        """Upload a file.
+        """Upload a file. `task` is one of the
+        `DocumentClassification`, `SequenceLabeling`, `Seq2seq`, `Speech2text`,
+        `ImageClassification`, `BoundingBox`, `Segmentation`, `ImageCaptioning`,
+        , `IntentDetectionAndSlotFilling`, and `RelationExtraction`.
 
         Args:
             project_id (int): The id of the project.
             file_paths (List[str]): The list of the file paths.
-            task (AvailableTask): The task of the upload.
+            task (Task): The task of the upload.
             format (str): The format of the upload.
             column_data (str): The column name of the data.
             column_label (str): The column name of the label.

doccano_client/models/data_upload.py

@@ -13,7 +13,7 @@ class Option(BaseModel):
     properties: Dict[str, Any]
 
 
-class AvailableTask(str, Enum):
+class Task(str, Enum):
     DOCUMENT_CLASSIFICATION = "DocumentClassification"
     SEQUENCE_LABELING = "SequenceLabeling"
     SEQ2SEQ = "Seq2seq"

doccano_client/repositories/data_upload.py

@@ -5,7 +5,7 @@
 
 from requests_toolbelt import MultipartEncoder
 
-from doccano_client.models.data_upload import AvailableTask, Option
+from doccano_client.models.data_upload import Option, Task
 from doccano_client.repositories.base import BaseRepository
 
 
@@ -56,13 +56,13 @@ def delete(self, upload_id: str):
         headers = {"Content-Type": "text/plain", "Accept": "*/*"}
         self._client.delete(resource, data=upload_id, headers=headers)
 
-    def ingest(self, project_id: int, upload_ids: List[str], task: AvailableTask, format: str, **kwargs) -> str:
+    def ingest(self, project_id: int, upload_ids: List[str], task: Task, format: str, **kwargs) -> str:
         """Ingest the uploaded files into the project
 
         Args:
             project_id (int): The id of the project
             upload_ids (List[str]): The ids of the uploaded files
-            task (AvailableTask): The project's task name
+            task (Task): The project's task name
             format (str): The format of the uploaded files
             **kwargs: Additional keyword arguments like column_data and column_label
 

doccano_client/usecase/data_upload.py

@@ -1,6 +1,6 @@
 from typing import List
 
-from doccano_client.models.data_upload import AvailableTask, Option
+from doccano_client.models.data_upload import Option, Task
 from doccano_client.models.task_status import TaskStatus
 from doccano_client.repositories.data_upload import DataUploadRepository
 from doccano_client.repositories.task_status import TaskStatusRepository
@@ -26,7 +26,7 @@ def upload(
         self,
         project_id: int,
         file_paths: List[str],
-        task: AvailableTask,
+        task: Task,
         format: str,
         column_data: str = "text",
         column_label: str = "label",
@@ -36,7 +36,7 @@ def upload(
         Args:
             project_id (int): The id of the project
             file_paths (List[str]): The list of the file paths
-            task (AvailableTask): The task of the upload
+            task (Task): The task of the upload
             format (str): The format of the upload
             column_data (str): The column name of the data
             column_label (str): The column name of the label