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	Description
file_path	str	Required	Specifies the path of the file to return (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	By default, the file is downloaded with the same name as the original file When set to False, the browser will try to open the file directly When set to a string, the specified value will be used as the download filename

DFF.RESP_FILE(...) automatically fills in the HTTP Content-Type header based on the file extension. By default, it uses the file_path. When a download string is specified, it uses that value as the filename for download.

The 'Resource File Directory' refers to the /data/resources folder in the container. After normal deployment, this folder is mounted to the host disk for 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():
    '''
    Let the browser open the `user-guide.pdf` file from the resource directory online
    '''
    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.xlsx' 
    '''
    return DFF.RESP_FILE('servey.xlsx', download='Survey.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)