static_file() throws away response headers

[bbradshaw]

Trying to figure out why this toy code wasn't working:

@app.route('/')
def get_basic_file():
        response.set_cookie('basic_cookie', 1)
    return static_file('index.html', 'path')

It seems the static_file() method never looks at the original response object.

[bbradshaw]

So, it's possible to work around the issue like:

@app.route('/')
def get_basic_file():
    this_response = static_file('index.html', 'path')
    this_response.set_cookie('basic_cookie', 1)
    return this_response

But that isn't documented and seems to go against the general 'automagic' feel of this module, IMHO.

[camconn]

I looked around in the bottle docs, and the BaseResponse.set_cookie behavior is well defined.

However, static_file is only documented in bottle.py right now, and has no reference in the docs even though it's used several times.

# Starting at line 2460
def static_file(filename, root,
                mimetype='auto',
                download=False,
                charset='UTF-8'):
    """ Open a file in a safe way and return :exc:`HTTPResponse` with status
        code 200, 305, 403 or 404. The ``Content-Type``, ``Content-Encoding``,
        ``Content-Length`` and ``Last-Modified`` headers are set if possible.
        Special support for ``If-Modified-Since``, ``Range`` and ``HEAD``
        requests.
        :param filename: Name or path of the file to send.
        :param root: Root path for file lookups. Should be an absolute directory
            path.
        :param mimetype: Defines the content-type header (default: guess from
            file extension)
        :param download: If True, ask the browser to open a `Save as...` dialog
            instead of opening the file with the associated program. You can
            specify a custom filename as a string. If not specified, the
            original filename is used (default: False).
        :param charset: The charset to use for files with a ``text/*``
            mime-type. (default: UTF-8)
    """

    ...

This definitely needs to be added to the docs though. I'll write up a PR documenting this.

[birlorg]

It's in the docs now, and as of version 0.12.19 this still happens.

a fix, in static_file, replace the headers=dict() line with headers=response.headers

That will solve this issue.