Package org.sonar.plugins.python.indexer

Class SetupPySourceRoots

java.lang.Object

org.sonar.plugins.python.indexer.SetupPySourceRoots

public class SetupPySourceRoots
extends Object

Extracts source root directories from setup.py files.

Method Summary

Modifier and Type	Method	Description
static List<String>	extract(File file)	Extracts source root directories from a setup.py File.
static ConfigSourceRoots	extractWithLocation(File file)	Extracts source root directories from a setup.py File, preserving the config file location.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

extract

public static List<String> extract(File file)

Extracts source root directories from a setup.py File.

Parameters:

file - the setup.py file

Returns:

list of source root paths (relative), empty if none found or on parse error

extractWithLocation

public static ConfigSourceRoots extractWithLocation(File file)

Extracts source root directories from a setup.py File, preserving the config file location.

This method returns a ConfigSourceRoots that associates the extracted relative paths with the config file, allowing callers to resolve absolute paths relative to the config file's directory rather than the project base directory.

Parameters:

file - the setup.py file

Returns:

ConfigSourceRoots containing the config file and its relative source roots