Description / Features

This plugin enables the analysis of Python projects.

Dependencies

This plugin has following dependencies:

• Pylint is used for the rules compliance analysis.

Installation

1. Install the Python plugin through the Update Center
2. Restart Sonar

Configuration

Usage

Analyzing with Maven

• Add your source directories to the build and the language-property to the properties section of your pom. Syntax: 

  <properties>
    ...
    <sonar.language>py</sonar.language>
    ...
  </properties>
   
  <build>
    ...
    <sourceDirectory> path </sourceDirectdory>
    ...
  </build>

• Make sure the dynamic analysis is not switched off. Syntax: 

  <properties>
    ...
    <sonar.dynamicAnalysis>true<sonar.dynamicAnalysis>
    ...
  </properties>

• Make sure that the Sonar server is running

• Start the analysis with "mvn sonar:sonar"

See here for general information about analyzing via maven.

Analyzing with the Sonar Runner

• Add a sonar-project.properties file at the root directory of your project
• Set sonar.language to py. Syntax: sonar.language=py
• Make sure that the Sonar server is running
• Run sonar-runner in the directory containing the sonar-project.properties file

See here for general information about analyzing via sonar-runner.

Sample Project

... is available here.

Changelog

Version 1.0 (26 issues)
Type	Key	Summary	Priority	Status	Resolution
	SONARPLUGINS-1721	pygenie stops the code analyse if it tries to analyse a file not ending with a empty row		Closed	Fixed
	SONARPLUGINS-2049	Rule: Avoid usage of print statement		Closed	Fixed
	SONARPLUGINS-2041	Rule: Avoid too complex file		Closed	Fixed
	SONARPLUGINS-2036	Rule: Avoid too complex class		Closed	Fixed
	SONARPLUGINS-2035	Metric: classes		Closed	Fixed
	SONARPLUGINS-2032	Rule: Always use upper case "L" for long integers		Closed	Fixed
	SONARPLUGINS-2031	Rule: Regular expression on comment		Closed	Fixed
	SONARPLUGINS-2028	Rule: Avoid too complex function		Closed	Fixed
	SONARPLUGINS-2030	Rule: Avoid deeply nested if statements		Closed	Fixed
	SONARPLUGINS-2024	Rule: Avoid usage of <> operator		Closed	Fixed
	SONARPLUGINS-2025	Rule: Line too long		Closed	Fixed
	SONARPLUGINS-2022	Rule: Avoid usage of exec statement		Closed	Fixed
	SONARPLUGINS-2026	Rule: One statement per line		Closed	Fixed
	SONARPLUGINS-2023	Rule: Avoid usage of `` (backtick) operator		Closed	Fixed
	SONARPLUGINS-2021	Rule: When there is a parsing error, this error should be added like a violation on that Python file		Closed	Fixed
	SONARPLUGINS-2020	Replace ANTLR-based lexer by our own		Closed	Fixed
	SONARPLUGINS-2019	Rename default quality profile to "Sonar way" to be consistent with other plugins		Closed	Fixed
	SONARPLUGINS-2018	Python Plugin not compatible with SCM Activity Plugin		Closed	Fixed
	SONARPLUGINS-2016	Metric: blank comments		Closed	Fixed
	SONARPLUGINS-2013	Metric: statements		Closed	Fixed
	SONARPLUGINS-2014	Rule: Generic Python rule to define some homemade checks with an XPath expression		Closed	Fixed
	SONARPLUGINS-2012	Provide Python rule engine based on SSLR		Closed	Fixed
	SONARPLUGINS-2015	Metric: functions		Closed	Fixed
	SONARPLUGINS-1830	Implement Python parser based on SSLR		Closed	Fixed
	SONARPLUGINS-2006	Provide a default SQALE mapping for the Python rules		Closed	Fixed
	SONARPLUGINS-1722	Absolut paths in sonar.python.pylint_config are prefixed with the path of the project		Closed	Fixed

 

Version 0.1 (5 issues)
Type	Key	Summary	Priority	Status	Resolution
	SONARPLUGINS-1547	Make the pylint integration configurable		Closed	Fixed
	SONARPLUGINS-1639	Support of code duplication detection		Closed	Fixed
	SONARPLUGINS-1635	Rework the recognition of basic program entities		Closed	Fixed
	SONARPLUGINS-1634	Improve the pylint integration		Closed	Fixed
	SONARPLUGINS-1573	Add a colorizer for python code		Closed	Fixed