Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 68 Next »

Live example

Icon

If you want to see a live example of the capabilities of the Python plugin, you can have a look at the analysis of the PyFFI project on Nemo.

Description / Features

This plugin enables the analysis of Python projects.

Dependencies

This plugin has the following dependencies:

  • Pylint must be installed to check Pylint coding rules.

Installation

  1. Install the Python plugin through the Update Center or download it into the SONAR_HOME/extensions/plugins directory
  2. Restart the Sonar server

Usage

Run a Sonar Analysis with the Sonar Runner (Recommended Way)

To launch a Sonar analysis of your Python project, use the Sonar Runner.

A sample project is available on github that can be browsed or downloaded: /projects/languages/python/python-sonar-runner.

Run a Sonar Analysis with the other Analyzers

Maven and Ant can also be used to launch analysis on Python projects.

Advanced Settings

Icon

The features "Execution of unit tests" and "Coverage metrics" and thus the settings "sonar.python.xunit.reportPath" and "sonar.python.coverage.*" will be available in Sonar Python 1.1 (version currently in development)

Property

Scope

Example

Description

sonar.python.pylintSystem-wide/usr/local/bin/pylint

Path to the pylint executable to use in pylint analysis. Set to empty to use the default one.

It has to be set on Windows, use either masked backslashes or slashes as path separators; examples: C:\\Python26\\Scripts\\pylint.bat or C:/Python/26/Scripts/pylint.bat

sonar.python.pylint_configProject-wide.pylintrc

Path to the pylint configuration file (relative to project root or absolute) to use in pylint analysis. Set to empty to use the default.

sonar.python.xunit.reportPathProject-widenosetests.xmlAnt pattern describing the path to unit test execution reports, relative to projects root. Leave unset to use the default ("xunit-reports/xunit-result-*.xml"). The reports have to conform to the junitreport XML format.
sonar.python.coverage.reportPathProject-widecoverage.xmlAnt pattern describing the path to coverage reports, relative to projects root. Leave unset to use the default ("coverage-reports/coverage-*.xml"). The reports have to conform to the Cobertura XML format.
sonar.python.coverage.itReportPathProject-wideit-coverage.xmlAnt pattern describing the path to coverage reports for integration tests, relative to projects root. Leave unset to use the default ("coverage-reports/it-coverage-*.xml"). The reports have to conform to the Cobertura XML format.

Make sure to set up the environment properly (PYTHONPATH etc.) before running the analyzer, if your project requires it.

External report generation

Here is a quick guide how to generate the reports using external tools.

Test execution

nosetests --with-xunit [tests to execute]

To get a more accurate execution time statistics make sure to use nose 1.1.0 or newer.

Coverage

Use Ned Batchelders coverage package like this:

coverage erase
coverage run --branch --sources=<python packages> <program> 
coverage xml -i

Make sure to put all packages to measure into the --source parameter. That ensures that coverage will report zero coverage on all untouched files, as you most probably want to. To make this work, make sure to meet two prerequisites:

  • use coverage => 3.4
  • the packages should be packages, i.e. every directory on the way to the sources should contain an __init__.py file.

Extending Coding Rules using XPath

New coding rules can be added using XPath. See the related documentation.

To navigate the AST, download the SSLR Python Toolkit.

Change Log

Loading

Version 1.1 (12 issues)

 

Loading

Version 1.0 (26 issues)

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

 

Loading

Version 0.1 (5 issues)

 

  • No labels