Flask check: Proper use of send file open

This check will detect the use of open([filename], [mode]) passed in to flask.send_file without the appropriate keyword args -- either mimetype or attachment_filename. open(...) without these keywords throws a ValueError at runtime.


Flask, as of v0.12, no longer infers the name attribute of file-like objects because the name attribute is not guaranteed. See pallets/flask#104 for the discussion.

Now, sending a file-like object in send_file without specifying either mimetype= or attachment_filename= keyword arguments will raise a ValueError (albeit with a helpful message!).

This check alerts on the usage of a file-like object without satisfying the other conditions, preventing a runtime error.

For example, the following snippet,

import flask
def send_file():
    f = open("test.db", 'r')
    rv = flask.send_file(f)

Has the following stack trace.

[2019-10-30 10:25:14,695] ERROR in app: Exception on /send_file [GET]
  [cut for brevity...]
  File "example.py", line 5, in send_file
    rv = flask.send_file(f)
  File "/usr/local/lib/python3.7/site-packages/flask/helpers.py", line 593, in send_file
    "Unable to infer MIME-type because no filename is available. "
ValueError: Unable to infer MIME-type because no filename is available. Please set either `attachment_filename`, pass a filepath to `filename_or_fp` or set your own MIME-type via `mimetype`.

This check will catch this pattern.

$> flake8 --select=R2C202 example.py
example.py:5:10: R2C202 passing a file-like object to flask.send_file without a mimetype or attachment_filename will raise a ValueError