pip.locations Namespace Reference

Functions
def	write_delete_marker_file
def	running_under_virtualenv
def	virtualenv_no_global
def	__get_username
def	_get_build_prefix
def	distutils_scheme

Variables
string	DELETE_MARKER_MESSAGE
string	PIP_DELETE_MARKER_FILENAME = 'pip-delete-this-directory.txt'
tuple	build_prefix = os.path.join(sys.prefix, 'build')
tuple	src_prefix = os.path.join(sys.prefix, 'src')
	FIXME: keep src in cwd for now (it is not a temporary folder) More...
tuple	site_packages = get_python_lib()
tuple	user_dir = os.path.expanduser('~')
tuple	bin_py = os.path.join(sys.prefix, 'Scripts')
tuple	bin_user = os.path.join(user_site, 'Scripts')
tuple	default_storage_dir = os.path.join(user_dir, 'pip')
tuple	default_config_file = os.path.join(default_storage_dir, 'pip.ini')
tuple	default_log_file = os.path.join(default_storage_dir, 'pip.log')

Detailed Description

Locations where we look for configs, install stuff, etc

Function Documentation

def pip.locations.__get_username ( )

private

Returns the effective username of the current process. 

def pip.locations._get_build_prefix ( )

private

Returns a safe build_prefix 

def pip.locations.distutils_scheme	(		dist_name,
			user = False,
			home = None,
			root = None
	)

Return a distutils install scheme

def pip.locations.running_under_virtualenv

(

)

Return True if we're running inside a virtualenv, False otherwise.

def pip.locations.virtualenv_no_global

(

)

Return True if in a venv and no system site packages.

def pip.locations.write_delete_marker_file

(

directory

)

Write the pip delete marker file into this directory.

Variable Documentation

string pip.locations.bin_py = os.path.join(sys.prefix, 'Scripts')

tuple pip.locations.bin_user = os.path.join(user_site, 'Scripts')

tuple pip.locations.build_prefix = os.path.join(sys.prefix, 'build')

tuple pip.locations.default_config_file = os.path.join(default_storage_dir, 'pip.ini')

tuple pip.locations.default_log_file = os.path.join(default_storage_dir, 'pip.log')

tuple pip.locations.default_storage_dir = os.path.join(user_dir, 'pip')

string pip.locations.DELETE_MARKER_MESSAGE

Initial value:

= '''\
This file is placed here by pip to indicate the source was put
here by pip.

Once this package is successfully installed this source code will be
deleted (unless you remove this file).
'''

string pip.locations.PIP_DELETE_MARKER_FILENAME = 'pip-delete-this-directory.txt'

tuple pip.locations.site_packages = get_python_lib()

tuple pip.locations.src_prefix = os.path.join(sys.prefix, 'src')

FIXME: keep src in cwd for now (it is not a temporary folder)

tuple pip.locations.user_dir = os.path.expanduser('~')