pdmlock

Documentation

Overview

Package pdmlock extracts pdm.lock files.

Index

• type Extractor
  • func (e Extractor) Ecosystem(i *extractor.Inventory) (string, error)
  • func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) ([]*extractor.Inventory, error)
  • func (e Extractor) FileRequired(path string, fileInfo fs.FileInfo) bool
  • func (e Extractor) Name() string
  • func (e Extractor) Requirements() *plugin.Capabilities
  • func (e Extractor) ToCPEs(i *extractor.Inventory) ([]string, error)
  • func (e Extractor) ToPURL(i *extractor.Inventory) (*purl.PackageURL, error)
  • func (e Extractor) Version() int

Types

type Extractor

type Extractor struct{}

Extractor extracts python packages from pdm.lock files.

func (Extractor) Ecosystem

func (e Extractor) Ecosystem(i *extractor.Inventory) (string, error)

Ecosystem returns the OSV ecosystem ('PyPI') of the software extracted by this extractor.

func (Extractor) Extract

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

Extract extracts packages from pdm.lock files passed through the scan input.

func (Extractor) FileRequired

func (e Extractor) FileRequired(path string, fileInfo fs.FileInfo) bool

FileRequired returns true if the specified file matches PDM lockfile patterns.

func (Extractor) Name

func (e Extractor) Name() string

Name of the extractor

func (Extractor) Requirements

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

Requirements of the extractor

func (Extractor) ToCPEs

func (e Extractor) ToCPEs(i *extractor.Inventory) ([]string, error)

ToCPEs is not applicable as this extractor does not infer CPEs from the Inventory.

func (Extractor) ToPURL

func (e Extractor) ToPURL(i *extractor.Inventory) (*purl.PackageURL, error)

ToPURL converts an inventory created by this extractor into a PURL.

func (Extractor) Version

func (e Extractor) Version() int

Version of the extractor