StdFileAPI

class deepfos.api.platform.StdFileAPI(root: deepfos.api.base.RootAPI)

delete_file(fileUplod)

文件删除接口

根据文件路径删除文件信息

参数

fileUplod – FileDelete

返回类型

Union[int, Awaitable[int]]

download(id, sendLog=None)

文件下载接口

文件id必填，通过id获取文件路径，获取文件内容

参数

• id – str

• sendLog – Optional[bool]

返回类型

Union[Any, Awaitable[Any]]

download_for_system()

文件下载接口-文件信息来源:system

文件id必填，通过id获取文件路径，获取文件内容

返回类型

Union[Any, Awaitable[Any]]

upload(file_type, file_name, file)

文件上传接口

参数

• file_type (str) – 文件类型，可用值: ATT(用户上传附件), DL(下载数据时生成的文件), INF(接口导入数据时生成的文件), LOG(日志中的附件), UPL(用户上传数据时的文件)

• file_name (str) – 文件名

• file (Union[str, bytes]) – 文件内容

上传文件至下载中心示例

from datetime import datetime

from deepfos.api.platform import PlatformAPI
from deepfos.api.space import SpaceAPI
from deepfos.api.models.space import SpFileBusinessRecordSaveDto
from deepfos.options import OPTION

# . 准备文件上传接口
file_cli = PlatformAPI().file

# . 准备空间下载中心记录接口
business_record_cli = SpaceAPI().business

# . 上传文件后，在下载中心生成一条可供下载的记录
with open('t.txt', 'rb') as fp:
    res = file_cli.upload(file_type='DL', file_name='t.txt', file=fp.read())

    business_record_cli.save(
        SpFileBusinessRecordSaveDto(
            app=OPTION.api.header['app'],
            space=OPTION.api.header['space'],
            fileName='t.txt',
            createTime=datetime.now().strftime('%Y-%m-%d %H:%M:%S'),
            fileId=res.id,
            unit='B',
            fileSize=res.fileSize,
            status='SUCCESS'
        )
    )

返回类型

Union[FileUplodRes, Awaitable[FileUplodRes]]

upload_content(form)

以内容方式上传文件

以内容方式上传文件：相同文件名不可重复上传

参数

form – UploadBodyForm

返回类型

Union[FileUplodRes, Awaitable[FileUplodRes]]