do not use format string with logging functions

Documentos > Code Analysis > Static Analysis Rules > do not use format string with logging functions

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: python-best-practices/logging-no-format

Language: Python

Severity: Notice

Category: Best Practices

Description

Avoid using format string with the format method when logging information.

Non-Compliant Code Examples

import logging
import shlex

logging.info("error {0} {1}".format(plop, plip))  # use instead logging.info("error %s", plop)

Compliant Code Examples

import logging

logging.info("wfwef")

How to use this rule

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

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