vpython

package
v0.0.0-...-c76aa60 Latest Latest
Warning

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

 Go to latest Published: Feb 28, 2025 License: Apache-2.0 Imports: 7 Imported by: 17

Documentation

Overview

Package vpython contains `vpython` environment definition protobufs.

Index

Constants

View Source 
const Version = "v2"

Version is a version string. It must be updated any time the text protobufs advance in a non-backwards-compatible way.

This version string is used in the generation of filenames, and must be filesystem-compatible.

Variables

View Source 
var File_go_chromium_org_luci_vpython_api_vpython_pep425_proto protoreflect.FileDescriptor
View Source 
var File_go_chromium_org_luci_vpython_api_vpython_spec_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type PEP425Tag 

type PEP425Tag struct {

	// Python is the PEP425 python tag (e.g., "cp27").
	Python string `protobuf:"bytes,1,opt,name=python,proto3" json:"python,omitempty"`
	// ABI is the PEP425 "python ABI" tag (e.g., "cp27mu", "none").
	Abi string `protobuf:"bytes,2,opt,name=abi,proto3" json:"abi,omitempty"`
	// Platform is the PEP425 "python platform" tag (e.g., "linux_x86_64",
	// "armv7l", "any").
	Platform string `protobuf:"bytes,3,opt,name=platform,proto3" json:"platform,omitempty"`
	// contains filtered or unexported fields
}

Represents a Python PEP425 tag.

func (*PEP425Tag) AnyPlatform 

func (t *PEP425Tag) AnyPlatform() bool

AnyPlatform returns true if t declares that it works on any platform.

func (*PEP425Tag) Count 

func (t *PEP425Tag) Count() (v int)

Count returns the number of populated fields in this tag.

func (*PEP425Tag) Descriptor deprecated 

func (*PEP425Tag) Descriptor() ([]byte, []int)

Deprecated: Use PEP425Tag.ProtoReflect.Descriptor instead.

func (*PEP425Tag) GetAbi 

func (x *PEP425Tag) GetAbi() string

func (*PEP425Tag) GetPlatform 

func (x *PEP425Tag) GetPlatform() string

func (*PEP425Tag) GetPython 

func (x *PEP425Tag) GetPython() string

func (*PEP425Tag) HasABI 

func (t *PEP425Tag) HasABI() bool

HasABI returns true if t declares that it only works with a specific ABI.

func (*PEP425Tag) IsZero 

func (t *PEP425Tag) IsZero() bool

IsZero returns true if this tag is a zero value.

func (*PEP425Tag) ProtoMessage 

func (*PEP425Tag) ProtoMessage()

func (*PEP425Tag) ProtoReflect 

func (x *PEP425Tag) ProtoReflect() protoreflect.Message

func (*PEP425Tag) Reset 

func (x *PEP425Tag) Reset()

func (*PEP425Tag) String 

func (x *PEP425Tag) String() string

func (*PEP425Tag) TagString 

func (t *PEP425Tag) TagString() string

TagString returns an underscore-separated string containing t's fields.

type Spec 

type Spec struct {

	// The Python version to use. This should be of the form:
	// "Major[.Minor]"
	//
	// If specified, the version will be enforced absolutely, otherwise vpython
	// will pick a default version.
	PythonVersion string          `protobuf:"bytes,1,opt,name=python_version,json=pythonVersion,proto3" json:"python_version,omitempty"`
	Wheel         []*Spec_Package `protobuf:"bytes,2,rep,name=wheel,proto3" json:"wheel,omitempty"`
	// Optional specification-provided PEP425 verification tags.
	//
	// Verification will pass only if:
	// 1. a set of PEP425 tags representing the systems that it wants to be
	// verified against is provided.
	// 2. the spec is valid (i.e. all wheels exist) for _all_ given PEP425Tags.
	VerifyPep425Tag []*PEP425Tag `protobuf:"bytes,4,rep,name=verify_pep425_tag,json=verifyPep425Tag,proto3" json:"verify_pep425_tag,omitempty"`
	// contains filtered or unexported fields
}

Spec is a "vpython" environment specification.

func (*Spec) Clone 

func (s *Spec) Clone() *Spec

Clone returns a deep clone of the supplied Spec.

If e is nil, a non-nil empty Spec will be returned.

func (*Spec) Descriptor deprecated 

func (*Spec) Descriptor() ([]byte, []int)

Deprecated: Use Spec.ProtoReflect.Descriptor instead.

func (*Spec) GetPythonVersion 

func (x *Spec) GetPythonVersion() string

func (*Spec) GetVerifyPep425Tag 

func (x *Spec) GetVerifyPep425Tag() []*PEP425Tag

func (*Spec) GetWheel 

func (x *Spec) GetWheel() []*Spec_Package

func (*Spec) ProtoMessage 

func (*Spec) ProtoMessage()

func (*Spec) ProtoReflect 

func (x *Spec) ProtoReflect() protoreflect.Message

func (*Spec) Reset 

func (x *Spec) Reset()

func (*Spec) String 

func (x *Spec) String() string

type Spec_Package 

type Spec_Package struct {

	// The name of the package.
	//
	// - For CIPD, this is the package name.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The package version.
	//
	//   - For CIPD, this will be any recognized CIPD version (i.e., ID, tag, or
	//     ref).
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// Optional PEP425 tags to determine whether this package is included on the
	// target system. If no match tags are specified, this package will always
	// be included. If match tags are specified, the package will be included if
	// any system PEP425 tags match at least one of the match tags.
	//
	// A match will succeed if any system PEP425 tag field matches the
	// corresponding field in the PEP425 tag. If the match tag omits a field
	// (partial), that field will not be considered. For example, if a match
	// tag specifies just an ABI field, any system PEP425 tag with that ABI will
	// be considered a successful match, regardless of other field values.
	MatchTag []*PEP425Tag `protobuf:"bytes,3,rep,name=match_tag,json=matchTag,proto3" json:"match_tag,omitempty"`
	// Optional PEP425 tags to determine whether this package is NOT included on
	// the target system. This has the opposite behavior as "match_tag": if any
	// host tags match any tags in this list, the package will not be installed
	// on this host.
	//
	// A "not_match_tag" overrides a "match_tag", so if a host has tags that
	// match entries in both, the package will be not considered a match.
	NotMatchTag []*PEP425Tag `protobuf:"bytes,4,rep,name=not_match_tag,json=notMatchTag,proto3" json:"not_match_tag,omitempty"`
	// contains filtered or unexported fields
}

A definition for a remote package. The type of package depends on the configured package resolver.

func (*Spec_Package) Descriptor deprecated 

func (*Spec_Package) Descriptor() ([]byte, []int)

Deprecated: Use Spec_Package.ProtoReflect.Descriptor instead.

func (*Spec_Package) GetMatchTag 

func (x *Spec_Package) GetMatchTag() []*PEP425Tag

func (*Spec_Package) GetName 

func (x *Spec_Package) GetName() string

func (*Spec_Package) GetNotMatchTag 

func (x *Spec_Package) GetNotMatchTag() []*PEP425Tag

func (*Spec_Package) GetVersion 

func (x *Spec_Package) GetVersion() string

func (*Spec_Package) ProtoMessage 

func (*Spec_Package) ProtoMessage()

func (*Spec_Package) ProtoReflect 

func (x *Spec_Package) ProtoReflect() protoreflect.Message

func (*Spec_Package) Reset 

func (x *Spec_Package) Reset()

func (*Spec_Package) String 

func (x *Spec_Package) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.