catkin_virtualenv.venv.Virtualenv Class Reference

Public Member Functions
def	__init__ (self, path)
def	check (self, requirements, extra_pip_args)
def	initialize (self, python, use_system_packages, extra_pip_args, clean=True)
def	install (self, requirements, extra_pip_args)
def	lock (self, package_name, input_requirements, no_overwrite, extra_pip_args)
def	relocate (self, target_dir)

Public Attributes
	path

Private Member Functions
def	_check_module (self, python_executable, module)
def	_delete_bytecode (self)
def	_venv_bin (self, binary_name)

Detailed Description

Definition at line 47 of file venv.py.

Constructor & Destructor Documentation

__init__()

def catkin_virtualenv.venv.Virtualenv.__init__	(		self,
			path
	)

Manage a virtualenv at the specified path.

Definition at line 48 of file venv.py.

Member Function Documentation

_check_module()

def catkin_virtualenv.venv.Virtualenv._check_module (   self,   python_executable,   module  )

private

Definition at line 197 of file venv.py.

_delete_bytecode()

def catkin_virtualenv.venv.Virtualenv._delete_bytecode (   self )

private

Remove all .py[co] files since they embed absolute paths.

Definition at line 206 of file venv.py.

_venv_bin()

def catkin_virtualenv.venv.Virtualenv._venv_bin (   self,   binary_name  )

private

Definition at line 190 of file venv.py.

check()

def catkin_virtualenv.venv.Virtualenv.check	(		self,
			requirements,
			extra_pip_args
	)

Check if a set of requirements is completely locked.

Definition at line 119 of file venv.py.

initialize()

def catkin_virtualenv.venv.Virtualenv.initialize	(		self,
			python,
			use_system_packages,
			extra_pip_args,
			clean = True
	)

Initialize a new virtualenv using the specified python version and extra arguments.

Definition at line 52 of file venv.py.

install()

def catkin_virtualenv.venv.Virtualenv.install	(		self,
			requirements,
			extra_pip_args
	)

Purge the cache first before installing.

Definition at line 111 of file venv.py.

lock()

def catkin_virtualenv.venv.Virtualenv.lock	(		self,
			package_name,
			input_requirements,
			no_overwrite,
			extra_pip_args
	)

Create a frozen requirement set from a set of input specifications.

Definition at line 147 of file venv.py.

relocate()

def catkin_virtualenv.venv.Virtualenv.relocate	(		self,
			target_dir
	)

Relocate a virtualenv to another directory.

Definition at line 178 of file venv.py.

Member Data Documentation

path

catkin_virtualenv.venv.Virtualenv.path

Definition at line 50 of file venv.py.

---

The documentation for this class was generated from the following file:

• venv.py