External Files

class ExternalFileStatusEnum

Bases: str, Enum

The state of an external file

available = 'available'

processing = 'processing'

__init__(*args, **kwds)

class ExternalFileTypeEnum

Bases: str, Enum

The state of an external file

dataset_attachment = 'dataset_attachment'

project_attachment = 'project_attachment'

__init__(*args, **kwds)

class ExternalFileUploadBase

Bases: BaseModel

Fields

Field	Type	Required	Default
description	str	Yes
file_name	str	Yes
provenance	dict[str, Any]	Yes

file_name: str

description: str

provenance: dict[str, Any]

class ExternalFile

Bases: BaseModel

Fields

Field	Type	Required	Default
created_on	datetime	Yes
description	str | None	Yes
file_name	str	Yes
file_size	int	Yes
file_type	ExternalFileTypeEnum	Yes
id	int	Yes
provenance	dict[str, Any]	Yes
sha256sum	str	Yes
status	ExternalFileStatusEnum	Yes

id: int

file_type: ExternalFileTypeEnum

created_on: datetime

status: ExternalFileStatusEnum

file_name: str

description: str | None

provenance: dict[str, Any]

sha256sum: str

file_size: int

propagate_client(client)

get_direct_url()

download(destination_path, overwrite=False)

Downloads an external file to the given path

The file size and checksum will be checked against the metadata stored on the server

Parameters:

• destination_path (str) – Full path to the destination file (including filename)

• overwrite (bool) – If True, allow for overwriting an existing file. If False, and a file already exists at the given destination path, an exception will be raised.

Return type:

None

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialize private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) – The BaseModel instance.

• context (Any) – The context.

Return type:

None