python

package

v1.1.10 Latest Latest Go to latest Published: Jul 13, 2021 License: MPL-2.0 Imports: 12 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/fossas/fossa-cli

Links

Open Source Insights

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)
type Options

Constants ¶

View Source

const (
	AnalyzerName = "python"

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

Variables ¶

View Source

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 ¶ added in v1.0.9

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

func AnalyzePipDepTree ¶ added in v1.0.9

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

func AnalyzePipenv ¶ added in v1.0.9

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

func AnalyzeRequirementsTxt ¶ added in v1.0.9

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

func AnalyzeSetupPy ¶ added in v1.0.9

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 ¶ added in v1.0.9

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"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL