API

use jsonify instead of json.dumps for JSON output

Docs > Code Analysis > Static Analysis Rules > use jsonify instead of json.dumps for JSON output

Metadata

ID: python-flask/use-jsonify

Language: Python

Severity: Notice

Category: Best Practices

Description

With the flask framework, jsonify helps you write API endpoints that return JSON data.

Learn More

Python Flask: jsonify()

Non-Compliant Code Examples

@app.route("/article")
def get_article():
    article = get_article_by_id(request.args.get("id"))
    return json.dumps(article) # use flask.jsonify instead of json.dumps

Compliant Code Examples

from flask import jsonify

@app.route("/article")
def get_article():
    article = get_article_by_id(request.args.get("id"))
    return jsonify(article)

How to use this rule

1
2
rulesets:
  - python-flask     # Rules to enforce Python flask.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products