fal.toolkit.file package

Submodules

fal.toolkit.file.file module

class fal.toolkit.file.file.CompressedFile(**data)

Bases: File

content_type: Optional[str]

extract_dir: Optional[str]

file_data: Optional[bytes]

file_name: Optional[str]

file_size: Optional[int]

glob(pattern)

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

url: str

class fal.toolkit.file.file.File(**data)

Bases: BaseModel

as_bytes()

Return type:

bytes

content_type: Optional[str]

file_data: Optional[bytes]

file_name: Optional[str]

file_size: Optional[int]

classmethod from_bytes(data, content_type=None, file_name=None, repository='fal_v3', fallback_repository=['cdn', 'fal'], request=None, save_kwargs=None, fallback_save_kwargs=None)

Return type:

File

classmethod from_path(path, content_type=None, repository='fal_v3', multipart=None, fallback_repository=['cdn', 'fal'], request=None, save_kwargs=None, fallback_save_kwargs=None)

Return type:

File

model_config: ClassVar[ConfigDict] = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

save(path, overwrite=False)

Return type:

Path

url: str

fal.toolkit.file.file.request_lifecycle_preference(request)

Return type:

dict[str, str] | None

fal.toolkit.file.types module

class fal.toolkit.file.types.FileData(data, content_type=None, file_name=None)

Bases: object

content_type: str

data: bytes

file_name: str

class fal.toolkit.file.types.FileRepository

Bases: object

save(data, multipart=None, multipart_threshold=None, multipart_chunk_size=None, multipart_max_concurrency=None, object_lifecycle_preference=None)

Return type:

str

save_file(file_path, content_type, multipart=None, multipart_threshold=None, multipart_chunk_size=None, multipart_max_concurrency=None, object_lifecycle_preference=None)

Return type:

tuple[str, FileData | None]

Module contents