pip.req.InstallRequirement Class Reference

Inheritance diagram for pip.req.InstallRequirement:

Public Member Functions
def	__init__
def	from_editable
def	from_line
def	__str__
def	from_path
def	build_location
def	correct_build_location
def	name
def	url_name
def	setup_py
def	run_egg_info
def	egg_info_data
def	egg_info_path
def	egg_info_lines
def	pkg_info
def	dependency_links
def	requirements
def	absolute_versions
def	installed_version
def	assert_source_matches_version
def	update_editable
def	uninstall
def	rollback_uninstall
def	commit_uninstall
def	archive
def	install
def	remove_temporary_source
def	install_editable
def	check_if_exists
def	is_wheel
def	is_bundle
def	bundle_requirements
def	move_bundle_files
def	move_wheel_files
def	delete_marker_filename

Public Attributes
	extras
	req
	comes_from
	source_dir
	editable
	editable_options
	url
	as_egg
	satisfied_by
	conflicts_with
	update
	install_succeeded
	FIXME: I'm not sure if this is a reasonable location; probably not but we can't put it in the default location, as that is a virtualenv symlink that isn't writable. More...
	uninstalled
	use_user_site
	target_dir
	from_bundle
	pycompile
	prereleases
	name

Private Member Functions
def	_clean_zip_name
def	_filter_install

Private Attributes
	_egg_info_path
	_temp_build_dir
	_is_bundle
	FIXME: this doesn't seem right: More...
	_ideal_build_dir
	_bundle_build_dirs
	_bundle_editable_dirs

Static Private Attributes
string	_run_setup_py
	FIXME: This is a lame hack, entirely for PasteScript which has a self-provided entry point that causes this awkwardness. More...
tuple	_requirements_section_re = re.compile(r'\[(.*?)\]')

Constructor & Destructor Documentation

def pip.req.InstallRequirement.__init__	(		self,
			req,
			comes_from,
			source_dir = None,
			editable = False,
			url = None,
			as_egg = False,
			update = True,
			prereleases = None,
			editable_options = None,
			from_bundle = False,
			pycompile = True
	)

Member Function Documentation

def pip.req.InstallRequirement.__str__

(

self

)

def pip.req.InstallRequirement._clean_zip_name (   self,   name,   prefix  )

private

def pip.req.InstallRequirement._filter_install (   self,   line  )

private

def pip.req.InstallRequirement.absolute_versions

(

self

)

def pip.req.InstallRequirement.archive	(		self,
			build_dir
	)

def pip.req.InstallRequirement.assert_source_matches_version

(

self

)

def pip.req.InstallRequirement.build_location	(		self,
			build_dir,
			unpack = True
	)

def pip.req.InstallRequirement.bundle_requirements

(

self

)

def pip.req.InstallRequirement.check_if_exists

(

self

)

Find an installed distribution that satisfies or conflicts
with this requirement, and set self.satisfied_by or
self.conflicts_with appropriately.

def pip.req.InstallRequirement.commit_uninstall

(

self

)

def pip.req.InstallRequirement.correct_build_location

(

self

)

If the build location was a temporary directory, this will move it
to a new more permanent location

def pip.req.InstallRequirement.delete_marker_filename

(

self

)

def pip.req.InstallRequirement.dependency_links

(

self

)

def pip.req.InstallRequirement.egg_info_data	(		self,
			filename
	)

def pip.req.InstallRequirement.egg_info_lines	(		self,
			filename
	)

def pip.req.InstallRequirement.egg_info_path	(		self,
			filename
	)

def pip.req.InstallRequirement.from_editable	(		cls,
			editable_req,
			comes_from = None,
			default_vcs = None
	)

def pip.req.InstallRequirement.from_line	(		cls,
			name,
			comes_from = None,
			prereleases = None
	)

Creates an InstallRequirement from a name, which might be a
requirement, directory containing 'setup.py', filename, or URL.

def pip.req.InstallRequirement.from_path

(

self

)

def pip.req.InstallRequirement.install	(		self,
			install_options,
			global_options = (),
			root = None
	)

def pip.req.InstallRequirement.install_editable	(		self,
			install_options,
			global_options = ()
	)

def pip.req.InstallRequirement.installed_version

(

self

)

def pip.req.InstallRequirement.is_bundle

(

self

)

def pip.req.InstallRequirement.is_wheel

(

self

)

def pip.req.InstallRequirement.move_bundle_files	(		self,
			dest_build_dir,
			dest_src_dir
	)

def pip.req.InstallRequirement.move_wheel_files	(		self,
			wheeldir,
			root = None
	)

def pip.req.InstallRequirement.name

(

self

)

def pip.req.InstallRequirement.pkg_info

(

self

)

def pip.req.InstallRequirement.remove_temporary_source

(

self

)

Remove the source files from this requirement, if they are marked
for deletion

def pip.req.InstallRequirement.requirements	(		self,
			extras = ()
	)

def pip.req.InstallRequirement.rollback_uninstall

(

self

)

def pip.req.InstallRequirement.run_egg_info	(		self,
			force_root_egg_info = False
	)

def pip.req.InstallRequirement.setup_py

(

self

)

def pip.req.InstallRequirement.uninstall	(		self,
			auto_confirm = False
	)

Uninstall the distribution currently satisfying this requirement.

Prompts before removing or modifying files unless
``auto_confirm`` is True.

Refuses to delete or modify files outside of ``sys.prefix`` -
thus uninstallation within a virtual environment can only
modify that virtual environment, even if the virtualenv is
linked to global site-packages.

def pip.req.InstallRequirement.update_editable	(		self,
			obtain = True
	)

def pip.req.InstallRequirement.url_name

(

self

)

Member Data Documentation

pip.req.InstallRequirement._bundle_build_dirs

private

pip.req.InstallRequirement._bundle_editable_dirs

private

pip.req.InstallRequirement._egg_info_path

private

pip.req.InstallRequirement._ideal_build_dir

private

pip.req.InstallRequirement._is_bundle

private

FIXME: this doesn't seem right:

tuple pip.req.InstallRequirement._requirements_section_re = re.compile(r'\[(.*?)\]')

staticprivate

string pip.req.InstallRequirement._run_setup_py

staticprivate

Initial value:

= """
__file__ = __SETUP_PY__
from setuptools.command import egg_info
import pkg_resources
import os
import tokenize
def replacement_run(self):
self.mkpath(self.egg_info)
installer = self.distribution.fetch_build_egg
for ep in pkg_resources.iter_entry_points('egg_info.writers'):
    # require=False is the change we're making:
    writer = ep.load(require=False)
    if writer:
        writer(self, ep.name, os.path.join(self.egg_info,ep.name))
self.find_sources()
egg_info.egg_info.run = replacement_run
exec(compile(getattr(tokenize, 'open', open)(__file__).read().replace('\\r\\n', '\\n'), __file__, 'exec'))
"""

FIXME: This is a lame hack, entirely for PasteScript which has a self-provided entry point that causes this awkwardness.

pip.req.InstallRequirement._temp_build_dir

private

pip.req.InstallRequirement.as_egg

pip.req.InstallRequirement.comes_from

pip.req.InstallRequirement.conflicts_with

pip.req.InstallRequirement.editable

pip.req.InstallRequirement.editable_options

pip.req.InstallRequirement.extras

pip.req.InstallRequirement.from_bundle

pip.req.InstallRequirement.install_succeeded

FIXME: I'm not sure if this is a reasonable location; probably not but we can't put it in the default location, as that is a virtualenv symlink that isn't writable.

FIXME: should we do –install-headers here too?

pip.req.InstallRequirement.name

pip.req.InstallRequirement.prereleases

pip.req.InstallRequirement.pycompile

pip.req.InstallRequirement.req

pip.req.InstallRequirement.satisfied_by

pip.req.InstallRequirement.source_dir

pip.req.InstallRequirement.target_dir

pip.req.InstallRequirement.uninstalled

pip.req.InstallRequirement.update

pip.req.InstallRequirement.url

pip.req.InstallRequirement.use_user_site

---

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

• orbits/lib/python2.7/site-packages/pip/req.py