Export Task
- class labelbox.schema.export_task.ExportTask(task: Task, is_export_v2: bool = False)[source]
Bases:
object
An adapter class for working with task objects, providing extended functionality and convenient access to task-related information.
This class wraps a Task object, allowing you to interact with tasks of this type. It offers methods to retrieve task results, errors, and metadata, as well as properties for accessing task details such as UID, status, and creation time.
- property completion_percentage
Returns the completion percentage of the task.
- property created_at
Returns the time the task was created.
- property created_by
Returns the user who created the task.
- property deleted
Returns whether the task is deleted.
- property errors
Returns the errors of the task.
- property errors_url
Returns the errors URL of the task.
- get_stream(converter: JsonConverter = JsonConverter(), stream_type: StreamType = StreamType.RESULT) Stream[JsonConverterOutput] [source]
- get_stream(converter: FileConverter, stream_type: StreamType = StreamType.RESULT) Stream[FileConverterOutput]
Returns the result of the task.
- get_total_file_size(stream_type: StreamType) int | None [source]
Returns the total file size for a specific task.
- get_total_lines(stream_type: StreamType) int | None [source]
Returns the total file size for a specific task.
- property metadata
Returns the metadata of the task.
- property name
Returns the name of the task.
- property organization
Returns the organization of the task.
- property result
Returns the result of the task.
- property result_url
Returns the result URL of the task.
- property status
Returns the status of the task.
- property type
Returns the type of the task.
- property uid
Returns the uid of the task.
- property updated_at
Returns the last time the task was updated.
- class labelbox.schema.export_task.FileConverter(file_path: str)[source]
Bases:
Converter
[FileConverterOutput
]Converts data to a file.
- convert(input_args: ConverterInputArgs) Iterator[FileConverterOutput] [source]
Converts the data. Returns an iterator that yields the converted data.
- Parameters:
current_offset – The global offset indicating the position of the data within the exported files. It represents a cumulative offset in characters across multiple files.
raw_data – The raw data to convert.
- Yields:
Iterator[OutputT] – The converted data.
- class labelbox.schema.export_task.FileConverterOutput(file_path: Path, total_size: int, total_lines: int, current_offset: int, current_line: int, bytes_written: int)[source]
Bases:
object
Output with statistics about the written file.
- class labelbox.schema.export_task.JsonConverter(*args, **kwds)[source]
Bases:
Converter
[JsonConverterOutput
]Converts JSON data.
- convert(input_args: ConverterInputArgs) Iterator[JsonConverterOutput] [source]
Converts the data. Returns an iterator that yields the converted data.
- Parameters:
current_offset – The global offset indicating the position of the data within the exported files. It represents a cumulative offset in characters across multiple files.
raw_data – The raw data to convert.
- Yields:
Iterator[OutputT] – The converted data.
- class labelbox.schema.export_task.JsonConverterOutput(current_offset: int, current_line: int, json_str: str)[source]
Bases:
object
Output with the JSON string.
- class labelbox.schema.export_task.Stream(ctx: _TaskContext, reader: _Reader, converter: Converter)[source]
Bases:
Generic
[OutputT
]Streams data from a Reader.