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.9.2.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

flake8_flask-0.9.2-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8-flask-0.9.2.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0b5 CPython/3.7.2 Darwin/19.2.0

File hashes

Hashes for flake8-flask-0.9.2.tar.gz
Algorithm Hash digest
SHA256 4fd666934d2994d14ff579655d4202c285577f3dc82e3f3cfacb4feadd909326
MD5 82e3e352351360b316340cf10c0418ca
BLAKE2b-256 af7411fa1d6f0fa0a4b4068691430373a0f67fde52c04c9136012d07ca0b6693

See more details on using hashes here.

File details

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

File metadata

  • Download URL: flake8_flask-0.9.2-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.0b5 CPython/3.7.2 Darwin/19.2.0

File hashes

Hashes for flake8_flask-0.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f05358864c506b079d5f7f6e36ffecb24ec40b9c7cf0379576a322a88f605a3f
MD5 51d23c5b64dd6d148624c1d6f7fda37a
BLAKE2b-256 9f29e9ea90e92a10c0c381bd7dd6065caa583880545607981a491011da0a76bf

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