manifest

Documentation

Index

• type File
  • func NewFile(manifest *Manifest) *File
  • func (f *File) Decode(manifestPath string) error
  • func (f *File) EncodeWithIntegrity(w io.Writer, manifestGeneratorHashFile, requirements io.Reader) error
  • func (f *File) EncodeWithoutIntegrity(w io.Writer) error
  • func (f *File) VerifyIntegrity(manifestGeneratorHashFile, requirements io.Reader) (bool, error)
• type Manifest
• type ModulesMapping
  • func (m ModulesMapping) MarshalYAML() (interface{}, error)
• type PipRepository

Types

type File

type File struct {
	Manifest *Manifest `yaml:"manifest,omitempty"`
	// Integrity is the hash of the requirements.txt file and the Manifest for
	// ensuring the integrity of the entire gazelle_python.yaml file. This
	// controls the testing to keep the gazelle_python.yaml file up-to-date.
	Integrity string `yaml:"integrity,omitempty"`
}

File represents the gazelle_python.yaml file.

func NewFile

func NewFile(manifest *Manifest) *File

NewFile creates a new File with a given Manifest.

func (*File) Decode

func (f *File) Decode(manifestPath string) error

Decode decodes the manifest file from the given path.

func (*File) EncodeWithIntegrity

func (f *File) EncodeWithIntegrity(w io.Writer, manifestGeneratorHashFile, requirements io.Reader) error

Encode encodes the manifest file to the given writer.

func (*File) EncodeWithoutIntegrity

func (f *File) EncodeWithoutIntegrity(w io.Writer) error

func (*File) VerifyIntegrity

func (f *File) VerifyIntegrity(manifestGeneratorHashFile, requirements io.Reader) (bool, error)

VerifyIntegrity verifies if the integrity set in the File is valid.

type Manifest

type Manifest struct {
	// ModulesMapping is the mapping from importable modules to which Python
	// wheel name provides these modules.
	ModulesMapping ModulesMapping `yaml:"modules_mapping"`
	// PipDepsRepositoryName is the name of the pip_parse repository target.
	// DEPRECATED
	PipDepsRepositoryName string `yaml:"pip_deps_repository_name,omitempty"`
	// PipRepository contains the information for pip_parse or pip_repository
	// target.
	PipRepository *PipRepository `yaml:"pip_repository,omitempty"`
}

Manifest represents the structure of the Gazelle manifest file.

type ModulesMapping

type ModulesMapping map[string]string

ModulesMapping is the type used to map from importable Python modules to the wheel names that provide these modules.

func (ModulesMapping) MarshalYAML

func (m ModulesMapping) MarshalYAML() (interface{}, error)

MarshalYAML makes sure that we sort the module names before marshaling the contents of `ModulesMapping` to a YAML file. This ensures that the file is deterministically generated from the map.

type PipRepository

type PipRepository struct {
	// The name of the pip_parse or pip_repository target.
	Name string
}