python

Documentation

Overview

Package python provides analysers for Python projects.

A `BuildTarget` in Python is the directory of the Python project, generally containing `requirements.txt` or `setup.py`.

Index

• Constants
• Variables
• func AnalyzePip(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)
• func AnalyzePipDepTree(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)
• func AnalyzePipenv(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)
• func AnalyzeRequirementsTxt(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)
• func AnalyzeSetupPy(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)
• func Discover(dir string, options map[string]interface{}) ([]module.Module, error)
• func FromRequirements(reqs []pip.Requirement) []pkg.Import
• func FromTree(tree []pip.DepTree) ([]pkg.Import, map[pkg.ID]pkg.Package)
• func NewDiscover(dir module.Filepath) (map[module.Filepath]module.DiscoveredStrategies, *errors.Error)
• type Analyzer
  • func New(m module.Module) (*Analyzer, error)
  • func (a *Analyzer) Analyze() (graph.Deps, error)
  • func (a *Analyzer) Build() error
  • func (a *Analyzer) Clean() error
  • func (a *Analyzer) IsBuilt() (bool, error)
• type Options

Constants

const (
	AnalyzerName = "python"

	SetupPyStrategy         = "setuptools"
	PipStrategy             = "pip"
	PipenvStrategy          = "pipenv"
	PipDepTreeStrategy      = "deptree"
	RequirementsTxtStrategy = "requirements"
)

Variables

var PythonAnalyzer = module.AnalyzerV2{
	Name:         AnalyzerName,
	DiscoverFunc: NewDiscover,
	Strategies: module.Strategies{
		Named: map[module.StrategyName]module.Strategy{
			SetupPyStrategy:         AnalyzeSetupPy,
			PipStrategy:             AnalyzePip,
			PipenvStrategy:          AnalyzePipenv,
			PipDepTreeStrategy:      AnalyzePipDepTree,
			RequirementsTxtStrategy: AnalyzeRequirementsTxt,
		},
		SortedNames: []module.StrategyName{PipenvStrategy, PipDepTreeStrategy, PipStrategy, RequirementsTxtStrategy, SetupPyStrategy},
		Optimal:     []module.StrategyName{PipenvStrategy},
	},
}

Functions

func AnalyzePip

func AnalyzePip(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)

func AnalyzePipDepTree

func AnalyzePipDepTree(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)

func AnalyzePipenv

func AnalyzePipenv(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)

func AnalyzeRequirementsTxt

func AnalyzeRequirementsTxt(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)

func AnalyzeSetupPy

func AnalyzeSetupPy(dir module.Filepath, target module.Filepath) (graph.Deps, *errors.Error)

func Discover

func Discover(dir string, options map[string]interface{}) ([]module.Module, error)

Discover constructs modules in all directories with a `requirements.txt` or `setup.py`.

func FromRequirements

func FromRequirements(reqs []pip.Requirement) []pkg.Import

func FromTree

func FromTree(tree []pip.DepTree) ([]pkg.Import, map[pkg.ID]pkg.Package)

func NewDiscover

func NewDiscover(dir module.Filepath) (map[module.Filepath]module.DiscoveredStrategies, *errors.Error)

Types

type Analyzer

type Analyzer struct {
	PythonCmd     string
	PythonVersion string

	Pipenv  pipenv.Pipenv
	Pip     pip.Pip
	Module  module.Module
	Options Options
}

func New

func New(m module.Module) (*Analyzer, error)

func (*Analyzer) Analyze

func (a *Analyzer) Analyze() (graph.Deps, error)

func (*Analyzer) Build

func (a *Analyzer) Build() error

func (*Analyzer) Clean

func (a *Analyzer) Clean() error

Clean logs a warning and does nothing for Python.

func (*Analyzer) IsBuilt

func (a *Analyzer) IsBuilt() (bool, error)

type Options

type Options struct {
	Strategy         string `mapstructure:"strategy"`
	RequirementsPath string `mapstructure:"requirements"`
	VirtualEnv       string `mapstructure:"venv"`
}