Skip to main content

Static analysis checks for Flask, by r2c. Available in our free program analysis tool, Bento. (ht

Project description

flake8-flask

flake8-flask is a plugin for flake8 with checks specifically for the flask framework, written by r2c

Installation

pip install flake8-flask

Validate the install using --version.

> flake8 --version
3.7.9 (flake8-flask: 0.2.1, mccabe: 0.6.1, pycodestyle: 2.5.0, pyflakes: 2.1.1)

List of warnings

r2c-flask-send-file-open: This check detects the use of a file-like object in flask.send_file without either mimetype or attachment_filename keyword arguments. send_file will throw a ValueError in this situation.

r2c-flask-secure-set-cookie: This check detects calls to response.set_cookie that do not have secure, httponly, and samesite set. This follows the guidance in the Flask documentation.

r2c-flask-unescaped-file-extension: Flask will not autoescape Jinja templates that do not have .html, .htm, .xml, or .xhtml as extensions. This check will alert you if you do not have one of these extensions. This check will also do its best to detect if context variables are escaped if a non-escaped extension is used.

r2c-flask-use-blueprint-for-modularity: This check recommends using Blueprint when there are too many route handlers in a single file. Blueprint encourages modularity and can greatly simplify how large applications work and provide a central means for Flask extensions to register operations on applications.

r2c-flask-use-jsonify: flask.jsonify() is a Flask helper method which handles the correct settings for returning JSON from Flask routes. This check catches uses of json.dumps() returned from Flask routes and encourages flask.jsonify() instead.

r2c-flask-missing-jwt-token: This check alerts when @jwt_required, @jwt_optional, @fresh_jwt_required, and @jwt_refresh_token_required decorators are missing in files where flask_jwt, flask_jwt_extended, or flask_jwt_simple packages are imported.

Have an idea for a check? Reach out to us at https://r2c.dev!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

flake8-flask-0.8.3.tar.gz (10.9 kB view details)

Uploaded Source

Built Distribution

flake8_flask-0.8.3-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file flake8-flask-0.8.3.tar.gz.

File metadata

  • Download URL: flake8-flask-0.8.3.tar.gz
  • Upload date:
  • Size: 10.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/3.7.5 Darwin/18.7.0

File hashes

Hashes for flake8-flask-0.8.3.tar.gz
Algorithm Hash digest
SHA256 16c1c18c9ea0f177667d868209e3da2f30c7d7f71272f68f5f59322d4d0885b7
MD5 07748f12373d8bb94903019e13f4f9db
BLAKE2b-256 fb54292a8c325582cc37eaac9742b26418cab9825878ff35b24452ac47e584ef

See more details on using hashes here.

File details

Details for the file flake8_flask-0.8.3-py3-none-any.whl.

File metadata

  • Download URL: flake8_flask-0.8.3-py3-none-any.whl
  • Upload date:
  • Size: 15.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0 CPython/3.7.5 Darwin/18.7.0

File hashes

Hashes for flake8_flask-0.8.3-py3-none-any.whl
Algorithm Hash digest
SHA256 214d0dbd4968d14d9e7ee488ec714caa0936044e0fa41d9a9a43dbd95a3d8444
MD5 410d916a86a9d2e2b9c0f88306d75f05
BLAKE2b-256 b0092e3615825d1d3237e48274bbd251479a39561abad2b5ab252a0b158c6202

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page