requirements

package
v0.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 9, 2026 License: Apache-2.0, BSD-3-Clause, MIT Imports: 16 Imported by: 2

Documentation

Overview

Package requirements extracts requirements files.

Index

Constants

View Source
const (
	// Name is the unique name of this extractor.
	Name = "python/requirements"
)

Variables

This section is empty.

Functions

func New added in v0.1.2

New returns a requirements.txt extractor.

Types

type Extractor

type Extractor struct {
	Stats stats.Collector
	// contains filtered or unexported fields
}

Extractor extracts python packages from requirements.txt files.

func (Extractor) Extract

Extract extracts packages from requirements files passed through the scan input.

func (Extractor) FileRequired

func (e Extractor) FileRequired(api filesystem.FileAPI) bool

FileRequired returns true if the specified file matches python Metadata file patterns.

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor.

func (Extractor) Requirements added in v0.1.3

func (e Extractor) Requirements() *plugin.Capabilities

Requirements of the extractor.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor.

type Metadata added in v0.1.2

type Metadata struct {
	// The values from the --hash flags, as in https://pip.pypa.io/en/stable/topics/secure-installs/#hash-checking-mode.
	// These are the hashes of the distributions of the package.
	HashCheckingModeValues []string
	// The comparator used to compare the package version, e.g. ==, ~=, >=
	VersionComparator string
	// The dependency requirement to used for dependency resolution
	Requirement string
}

Metadata contains additional information from a package in a requirements file.

func ToStruct added in v0.4.2

ToStruct converts the PythonRequirementsMetadata proto to a Metadata struct.

func (*Metadata) SetProto added in v0.4.2

func (m *Metadata) SetProto(p *pb.Package)

SetProto sets the PythonRequirementsMetadata field in the Package proto.

Jump to

Keyboard shortcuts

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