Documentation
¶
Overview ¶
Package pyprojecttoml extracts dependencies from pyproject.toml files conforming to PEP 621. Specifically, it parses the standardized [project.dependencies] and [project.optional-dependencies] tables.
Index ¶
Constants ¶
const (
// Name is the unique name of this extractor.
Name = "python/pyprojecttoml"
)
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New(*cpb.PluginConfig) (filesystem.Extractor, error)
New returns a new instance of the extractor.
func ToProto ¶ added in v0.5.3
func ToProto(m *Metadata) *pb.PyprojectMetadata
ToProto converts the Metadata struct to a PythonPyprojectTomlMetadata proto.
Types ¶
type Extractor ¶
type Extractor struct{}
Extractor extracts Python packages from pyproject.toml files
func (Extractor) Extract ¶
func (e Extractor) Extract( _ context.Context, input *filesystem.ScanInput, ) (inventory.Inventory, error)
Extract extracts packages from the [project] table of a pyproject.toml file.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true only for files named exactly "pyproject.toml".
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
type Metadata ¶ added in v0.5.3
type Metadata struct {
HasDynamicDependencies bool `json:"has-dynamic-dependencies"`
Dependencies []string `json:"dependencies"`
OptionalDependencies map[string][]string `json:"optional-dependencies"`
}
Metadata contains information about the Python package declared by a PEP-621 pyproject.toml.
func ToStruct ¶ added in v0.5.3
func ToStruct(m *pb.PyprojectMetadata) *Metadata
ToStruct converts the PythonPyprojectTomlMetadata proto to a Metadata struct.
func (*Metadata) IsProtoable ¶ added in v0.5.3
func (m *Metadata) IsProtoable()
IsProtoable marks the struct as a metadata type.
Source Files