wheelegg

package

v0.4.3 Latest Latest Go to latest Published: Feb 9, 2026 License: Apache-2.0, BSD-3-Clause, MIT Imports: 20 Imported by: 0

Details

Package wheelegg extracts wheel and egg files.

View Source

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

View Source

var ErrSizeNotSet = errors.New("input.Info is nil, but should have Size set")

ErrSizeNotSet will trigger when Info.Size() is not set.

func New(cfg *cpb.PluginConfig) (filesystem.Extractor, error)

New returns a wheel/egg extractor.

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

Extractor extracts python packages from wheel/egg files.

func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)

Extract extracts packages from wheel/egg files passed through the scan input. For .egg files, input.Info.Size() is required to unzip the file.

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

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

func (e Extractor) Name() string

Name of the extractor.

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

Requirements of the extractor.

func (e Extractor) Version() int

Version of the extractor.

type PythonPackageMetadata struct {
	Author      string `json:"author"`
	AuthorEmail string `json:"authorEmail"`
}

PythonPackageMetadata holds parsing information from a python egg or wheel package.

func ToStruct(m *pb.PythonPackageMetadata) *PythonPackageMetadata

ToStruct converts the PythonPackageMetadata proto to a Metadata struct.

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

SetProto sets the PythonMetadata field in the Package proto.