Script Development / Return File DFF.RESP_FILE

When the returned content is a "file on disk," you can use DFF.RESP_FILE(...) for detailed control.

Parameter	Type	Required / Default Value	Description
file_path	str	Required	Specifies the path to the returned file (relative to the resource file directory).
status_code	int	200	Same as the parameter with the same name in DFF.RESP(...).
headers	dict	None	Same as the parameter with the same name in DFF.RESP(...).
allow_304	bool	False	Same as the parameter with the same name in DFF.RESP(...).
auto_delete	bool	False	When set to True, the file will be automatically deleted from the disk after download.
download	bool / str	True	Downloads the file by default and saves it with the same name as the original file. When set to False, instructs the browser to open the file directly if possible. When set to a string, uses the specified value as the downloaded filename.

DFF.RESP_FILE(...) will automatically populate the HTTP Content-Type header based on the file extension, defaulting to file_path. If a download string is specified, the download value will be used as the filename.

The 'resource file directory' refers to the /data/resources folder within the container, which will be mounted to the host machine's disk after normal deployment to achieve persistent storage.

@DFF.API('Case 1')
def case_1():
    '''
    Download the user-guide.pdf file from the resource file directory.
    '''
    return DFF.RESP_FILE('user-guide.pdf')

@DFF.API('Case 2')
def case_2():
    '''
    Open the `user-guide.pdf` file from the resource directory in the browser.
    '''
    return DFF.RESP_FILE('user-guide.pdf', download=False)

@DFF.API('Case 3')
def case_3():
    '''
    Open the index.html page from the resource directory in the browser.
    '''
    return DFF.RESP_FILE('index.html', download=False)

@DFF.API('Case 4')
def case_4():
    '''
    Download the servey.xlsx file from the resource file directory and save it as 'Survey Form.xlsx'.
    '''
    return DFF.RESP_FILE('servey.xlsx', download='调查表。xlsx')

@DFF.API('Case 5')
def case_5():
    '''
    Specify additional response headers.
    '''
    headers = {
        'X-Author': 'Tom',
    }
    return DFF.RESP_FILE('user-guide.pdf', headers=headers)