virtualenvutils

package

v0.435.0 Latest Latest Go to latest Published: Aug 12, 2025 License: Apache-2.0 Imports: 13 Imported by: 0

Details

Handle Python virtualenvs.

View Source

const PYENV_CONFIG_BASENAME = "pyvenv.cfg"

This section is empty.

func IsVirtualEnv(ctx context.Context, path string) (bool, error)

type CreateVirtualenvOptions struct {
	// Path of the virtualenv to create:
	Path string

	// Slice of packages to install:
	Packages []string
}

func (c *CreateVirtualenvOptions) GetPath() (string, error)

type VirtualEnv struct {
	Path            string
	CommandExecutor *commandexecutorinterfaces.CommandExecutor
}

func CreateVirtualEnv(ctx context.Context, options *CreateVirtualenvOptions) (*VirtualEnv, error)

Creates a virtualenv and ensures the packages as specified in the options are present.

func GetVirtualEnv(path string) (*VirtualEnv, error)

func (v *VirtualEnv) Create(ctx context.Context) error

func (v *VirtualEnv) GetCommandExecutorOrDefaultIfUnset() commandexecutorinterfaces.CommandExecutor

func (v *VirtualEnv) GetPath() (string, error)

func (v *VirtualEnv) GetPipPath() (string, error)

func (v *VirtualEnv) InstallPackage(ctx context.Context, packageName string) error

func (v *VirtualEnv) InstallPackages(ctx context.Context, packages []string) error

func (v *VirtualEnv) IsPackageInstalled(ctx context.Context, packageName string) (isInstalled bool, err error)

func (v *VirtualEnv) IsPackagesInstalled(ctx context.Context, packageNames []string) (isInstalled bool, err error)

func (v *VirtualEnv) IsVirtualEnv(ctx context.Context) (bool, error)

func (v *VirtualEnv) ListInstalledPackageNames(ctx context.Context) ([]string, error)