Python Warning Classes Corresponding to Pylint Rules

• Introduction
• Python Warning Classes from Pylint SARIF
• Built-in Python Warning Classes
• Enabling and Disabling

Introduction

This page describes the CodeSonar warning classes that are assigned to warnings imported from a SARIF file produced by Pylint.

For information on setting up your CodeSonar project to incorporate Python source code and the corresponding Pylint results, see Including Python Components in a CodeSonar Project.

Python Warning Classes from Pylint Rules

When CodeSonar imports a SARIF file, it determines a corresponding CodeSonar warning class for each rule object in the SARIF rules. If a given warning class does not already exist, the SARIF importer creates it.

There is special handling for SARIF files produced by Pylint.

• CodeSonar ships with a large number of built-in Python warning classes corresponding to messages from Pylint version v3.0.3. Each of these classes has the following properties.
  • The Name is generated using a Pylint-specific mechanism.
  • The Categories include a mnemonic (in the PYTHON.* branch of the CodeSonar mnemonic hierarchy) and a Pylint:<id> category.
• In cases where there is no existing warning class corresponding to a particular rule object in the SARIF rules, the SARIF importer creates a new warning class.
  • The Name is generated using the same Pylint-specific mechanism used for the built-in language warning classes.
  • The Categories include a Pylint:<id> category, but no mnemonic.

Pylint-specific handling for warning class names and categories

Example

Suppose the imported SARIF file includes a rule object like the following.

# ...
    "rules":[
        # ...
      {
          "id": "C0103",
          "name": "invalid-name",
        # ...
      },
      # ...
    ], 
# ...

(This corresponds to the Pylint invalid-name message.)

1. CodeSonar computes the corresponding warning class name: "Invalid Name (Pylint)".
2. If there is not already a warning class with this name, CodeSonar creates the warning class.
   The new warning class will have one associated category: Pylint:C0103.
3. CodeSonar creates a "Invalid Name (Pylint)" warning instance for each result entry in the SARIF that has "ruleID": "C0103".

SARIF files produced by Pylint

CodeSonar will consider a SARIF file to be produced by Pylint in the following cases.

• The SARIF file was produced and imported via a codesonar python_scan.py invocation.
• The file is imported with a codesonar import_sarif.py invocation that specifies -analyzer pylint.
• The file is imported with a codesonar import_sarif.py invocation that does not specify -analyzer, and the SARIF importer can determine from the file contents that it was produced by Pylint.

Built-in Python Warning Classes

These warning classes correspond to messages from Pylint version v3.0.3.

Enabling and Disabling

You have multiple degrees of control over reporting for the warnings issued by Pylint.

• To enable or disable checking for a specific Pylint message (and thus the corresponding CodeSonar warning class), use a Pylint configuration file.
• To selectively disable submission to the hub for a warning or set of warnings, define a WARNING_FILTER discard rule in a suitable CodeSonar configuration file.

  You can also specify a combination of WARNING_FILTER discard and WARNING_FILTER allow rules, if that is the most convenient way to characterize a specific set. When you specify warning class names (or parts of names) in your WARNING_FILTER rules, make sure you are using the generated CodeSonar warning class name as described above.