Qodana 2024.1 Help

Qodana Community for Python

official project

Python

Qodana Community for Python is based on PyCharm Community and provides static analysis for Python projects.

Supported technologies

Qodana Community for Python provides inspections for the following technologies.

Programming languages

Python

Markup languages

CSS

HTML

JSON and JSON5

RELAX NG

XML

YAML

Scripting languages

Shell script

Databases and ORM

MongoDB

MySQL

Oracle

PostgreSQL

SQL

SQL Server

Frameworks and libraries

Django

Google App Engine

Jupyter

Pyramid

Supported features

The Qodana Community for Python linter provides the following Qodana features:

Feature

Available under the license

Baseline

Community

FlexInspect

Community

Quality gate

Community

Try it now

Analyze a project locally

Install project dependencies

For a basic Python project that has no external dependencies, no preliminary steps are required.

In case the project has external pip dependencies, you can set them up using the bootstrap key in the qodana.yaml file.
For example, if your project dependencies are specified by the requirements.txt file in your project root, add the following line to qodana.yaml:

bootstrap: pip install -r requirements.txt

The command will be automatically executed before the analysis.

Run analysis

Qodana provides two options for local analysis of your code. Qodana CLI is the easiest option to start. Alternatively, you can use the Docker command from the Docker image tab.

Assuming that you have already installed Qodana CLI on your machine, you can run this command in the project root directory:

qodana scan \ -e QODANA_TOKEN="<cloud-project-token>" \ -l jetbrains/qodana-python-community:2024.1

Here, the QODANA_TOKEN variable refers to the project token.

If you omit the linter name jetbrains/qodana-python-community:2024.1 here, then the Qodana for Python linter will be run instead.

To start, pull the image from Docker Hub (only necessary to get the latest version):

docker pull jetbrains/qodana-python-community:2024.1

Start local analysis with source-directory pointing to the root of your project and QODANA_TOKEN referring to the project token:

docker run \ -v <source-directory>/:/data/project/ \ -e QODANA_TOKEN="<cloud-project-token>" \ jetbrains/qodana-python-community:2024.1

In your browser, open Qodana Cloud to examine inspection results. Here, you can also reconfigure the analysis, see the Inspection report section for details.

Next steps

Last modified: 25 June 2024