Normalize packages names

Fixes sjkingo#42
Also allows to install packages with -e (editable) option

tests.py

@@ -6,11 +6,14 @@
 import tempfile
 import unittest
 
+from virtualenvapi import __version__, __file__ as virtualenvapi_file_path
 from virtualenvapi.manage import VirtualEnvironment
 
+virtualenvapi_module_path = os.path.dirname(os.path.dirname(virtualenvapi_file_path))
 packages_for_tests = ['pep8']
 non_lowercase_packages_for_test = ['Pillow']
-all_packages_for_tests = packages_for_tests + non_lowercase_packages_for_test
+git_packages_for_test = ['git+https://github.com/pytest-dev/[email protected]']
+all_packages_for_tests = packages_for_tests + non_lowercase_packages_for_test + git_packages_for_test
 
 def which(program):
     def is_exe(fpath):
@@ -80,14 +83,23 @@ def test_install_requirements(self):
             for pack in packages_for_tests:
                 self.assertTrue(self.virtual_env_obj.is_installed(pack))
 
+    def test_install_editable(self):
+        self.virtual_env_obj.install('-e git+file://{}#egg=virtualenv-api'.format(virtualenvapi_module_path))
+        print(self.virtual_env_obj.installed_packages)
+        self.assertTrue(self.virtual_env_obj.is_installed('virtualenv-api'))
+        self.assertFalse(self.virtual_env_obj.is_installed(('virtualenv-api', __version__)))
+
     def test_uninstall(self):
         self._install_packages(all_packages_for_tests)
         for pack in all_packages_for_tests:
-            if pack.endswith('.git'):
-                pack = pack.split('/')[-1].replace('.git', '')
             self.virtual_env_obj.uninstall(pack)
             self.assertFalse(self.virtual_env_obj.is_installed(pack))
 
+    def test_uninstall_editable(self):
+        self.virtual_env_obj.install('-e git+file://{}#egg=virtualenv-api'.format(virtualenvapi_module_path))
+        self.assertFalse(self.virtual_env_obj.is_installed('virtualenv-api'))
+        self.assertFalse(self.virtual_env_obj.is_installed(('virtualenv-api', __version__)))
+
     def test_wheel(self):
         self.virtual_env_obj.install('wheel') # required for this test
         for pack in packages_for_tests:

virtualenvapi/manage.py

@@ -1,10 +1,9 @@
-from os import linesep, environ
-import os.path
+import os
 import subprocess
 import six
 import sys
 
-from virtualenvapi.util import split_package_name, to_text, get_env_path, to_ascii
+from virtualenvapi.util import normalize_package, normalize_package_name, to_text, get_env_path, get_package_name
 from virtualenvapi.exceptions import *
 
 
@@ -28,7 +27,7 @@ def __init__(self, path=None, python=None, cache=None, readonly=False, system_si
         # Expand path so shell shortcuts may be used such as ~
         self.path = os.path.abspath(os.path.expanduser(path))
 
-        self.env = environ.copy()
+        self.env = os.environ.copy()
 
         # Blacklist environment variables that will break pip in virtualenvs
         # See https://github.com/pypa/virtualenv/issues/845
@@ -48,28 +47,34 @@ def __str__(self):
     @property
     def _pip(self):
         """The arguments used to call pip."""
+
         # pip is called using the python interpreter to get around a long path
         # issue detailed in https://github.com/sjkingo/virtualenv-api/issues/30
         return [self._python_rpath, '-m', 'pip']
 
     @property
     def _python_rpath(self):
         """The relative path (from environment root) to python."""
+
         # Windows virtualenv installation installs pip to the [Ss]cripts
         # folder. Here's a simple check to support:
         if sys.platform == 'win32':
             return os.path.join('Scripts', 'python.exe')
+
         return os.path.join('bin', 'python')
 
     @property
     def pip_version(self):
         """Version of installed pip."""
+
         if not self._pip_exists:
             return None
+
         if not hasattr(self, '_pip_version'):
             # don't call `self._execute_pip` here as that method calls this one
             output = self._execute(self._pip + ['-V'], log=False).split()[1]
             self._pip_version = tuple([int(n) for n in output.split('.')])
+
         return self._pip_version
 
     @property
@@ -80,34 +85,41 @@ def root(self):
     @property
     def name(self):
         """The name of this virtual environment (taken from its path)."""
+
         return os.path.basename(self.path)
 
     @property
     def _logfile(self):
         """Absolute path of the log file for recording installation output."""
+
         return os.path.join(self.path, 'build.log')
 
     @property
     def _errorfile(self):
         """Absolute path of the log file for recording installation errors."""
+
         return os.path.join(self.path, 'build.err')
 
     def _create(self):
         """Executes `virtualenv` to create a new environment."""
+
         if self.readonly:
             raise VirtualenvReadonlyException()
         args = ['virtualenv']
+
         if self.system_site_packages:
             args.append('--system-site-packages')
         if self.python is None:
             args.append(self.name)
         else:
             args.extend(['-p', self.python, self.name])
+
         proc = subprocess.Popen(args, cwd=self.root, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
         output, error = proc.communicate()
         returncode = proc.returncode
         if returncode:
             raise VirtualenvCreationException((returncode, output, self.name))
+
         self._write_to_log(output, truncate=True)
         self._write_to_error(error, truncate=True)
 
@@ -177,12 +189,14 @@ def _write_to_error(self, s, truncate=False):
     def _pip_exists(self):
         """Returns True if pip exists inside the virtual environment. Can be
         used as a naive way to verify that the environment is installed."""
+
         return os.path.isfile(os.path.join(self.path, 'bin', 'pip'))
 
     def open_or_create(self):
         """Attempts to open the virtual environment or creates it if it
         doesn't exist.
         XXX this should probably be expanded to do some proper checking?"""
+
         if not self._pip_exists():
             self._create()
         self._ready = True
@@ -192,109 +206,128 @@ def install(self, package, force=False, upgrade=False, options=None):
         specified in pip's package syntax or a tuple of ('name', 'ver'),
         only if it is not already installed. Some valid examples:
 
-         'Django'
-         'Django==1.5'
-         ('Django', '1.5')
-         '-e .'
-         '-r requirements.txt'
+        'Django'
+        'Django==1.5'
+        ('Django', '1.5')
+        '-e .'
+        '-r requirements.txt'
 
         If `force` is True, force an installation. If `upgrade` is True,
         attempt to upgrade the package in question. If both `force` and
         `upgrade` are True, reinstall the package and its dependencies.
         The `options` is a list of strings that can be used to pass to
         pip."""
+
         if self.readonly:
             raise VirtualenvReadonlyException()
+
         if options is None:
             options = []
-        if isinstance(package, tuple):
-            package = '=='.join(package)
-        if package.startswith(('-e', '-r')):
-            package_args = package.split()
-        else:
-            package_args = [package]
-        if not (force or upgrade) and (package_args[0] != '-r' and self.is_installed(package_args[-1])):
-            self._write_to_log('%s is already installed, skipping (use force=True to override)' % package_args[-1])
+
+        package_name = get_package_name(package)
+        package_args = package_name.split() # '-e package_name' -> ['-e', 'package_name']
+
+        package_name = normalize_package(package_name)
+
+        if not (force or upgrade) and ('-r' in package_args and self.is_installed(package_name)):
+            self._write_to_log('%s is already installed, skipping (use force=True to override)' % package_name)
             return
+
         if not isinstance(options, list):
             raise ValueError("Options must be a list of strings.")
+
         if upgrade:
             options += ['--upgrade']
             if force:
                 options += ['--force-reinstall']
         elif force:
             options += ['--ignore-installed']
+
         try:
             self._execute_pip(['install'] + package_args + options)
         except subprocess.CalledProcessError as e:
-            raise PackageInstallationException((e.returncode, e.output, package))
+            raise PackageInstallationException((e.returncode, e.output, package_name))
 
     def uninstall(self, package):
         """Uninstalls the given package (given in pip's package syntax or a tuple of
         ('name', 'ver')) from this virtual environment."""
-        if isinstance(package, tuple):
-            package = '=='.join(package)
-        if not self.is_installed(package):
-            self._write_to_log('%s is not installed, skipping' % package)
+
+        package_name = normalize_package_name(get_package_name(package))
+
+        if not self.is_installed(package_name):
+            self._write_to_log('%s is not installed, skipping' % package_name)
             return
         try:
-            self._execute_pip(['uninstall', '-y', package])
+            self._execute_pip(['uninstall', '-y', package_name])
         except subprocess.CalledProcessError as e:
-            raise PackageRemovalException((e.returncode, e.output, package))
+            raise PackageRemovalException((e.returncode, e.output, package_name))
 
     def wheel(self, package, options=None):
         """Creates a wheel of the given package from this virtual environment,
         as specified in pip's package syntax or a tuple of ('name', 'ver'),
         only if it is not already installed. Some valid examples:
 
-         'Django'
-         'Django==1.5'
-         ('Django', '1.5')
+        'Django'
+        'Django==1.5'
+        ('Django', '1.5')
 
         The `options` is a list of strings that can be used to pass to
         pip."""
+
         if self.readonly:
             raise VirtualenvReadonlyException()
+
         if options is None:
             options = []
-        if isinstance(package, tuple):
-            package = '=='.join(package)
+
+        package_name = normalize_package_name(get_package_name(package))
+
         if not self.is_installed('wheel'):
-            raise PackageWheelException((0, "Wheel package must be installed in the virtual environment", package))
+            raise PackageWheelException((0, "Wheel package must be installed in the virtual environment", package_name))
+
         if not isinstance(options, list):
             raise ValueError("Options must be a list of strings.")
+
         try:
-            self._execute_pip(['wheel', package] + options)
+            self._execute_pip(['wheel', package_name] + options)
         except subprocess.CalledProcessError as e:
-            raise PackageWheelException((e.returncode, e.output, package))
+            raise PackageWheelException((e.returncode, e.output, package_name))
 
     def is_installed(self, package):
         """Returns True if the given package (given in pip's package syntax or a
         tuple of ('name', 'ver')) is installed in the virtual environment."""
-        if isinstance(package, tuple):
-            package = '=='.join(package)
-        if package.endswith('.git'):
-            pkg_name = os.path.split(package)[1][:-4]
-            return pkg_name in self.installed_package_names or \
-                    pkg_name.replace('_', '-') in self.installed_package_names
-        pkg_tuple = split_package_name(package)
-        if pkg_tuple[1] is not None:
-            return pkg_tuple in self.installed_packages
+
+        package = normalize_package(package)
+        package_name, package_version = package
+
+        package_name = package_name.lower()
+        package_name_underscored = package_name.replace('-', '_').lower()
+
+        if package_version is not None:
+            for name, version in self.installed_packages:
+                if name.lower() in [package_name, package_name_underscored] and version == package_version:
+                    return True
         else:
-            return pkg_tuple[0].lower() in self.installed_package_names
+            for name in self.installed_package_names:
+                if name.lower() in [package_name, package_name_underscored]:
+                    return True
+
+        return False
 
     def upgrade(self, package, force=False):
         """Shortcut method to upgrade a package. If `force` is set to True,
         the package and all of its dependencies will be reinstalled, otherwise
         if the package is up to date, this command is a no-op."""
+
         self.install(package, upgrade=True, force=force)
 
     def upgrade_all(self):
         """
         Upgrades all installed packages to their latest versions.
         """
-        for pkg in self.installed_package_names:
-            self.install(pkg, upgrade=True)
+
+        for package_name in self.installed_package_names:
+            self.install(package_name, upgrade=True)
 
     def search(self, term):
         """
@@ -303,20 +336,22 @@ def search(self, term):
 
         New in 2.1.5: returns a dictionary instead of list of tuples
         """
+
         packages = {}
         results = self._execute_pip(['search', term], log=False)  # Don't want to log searches
-        for result in results.split(linesep):
+        for result in results.split(os.linesep):
             try:
                 name, description = result.split(six.u(' - '), 1)
             except ValueError:
                 # '-' not in result so unable to split into tuple;
                 # this could be from a multi-line description
                 continue
             else:
-                name = name.strip()
-                if len(name) == 0:
+                name = normalize_package(name)
+                if not name:
                     continue
                 packages[name] = description.split(six.u('<br'), 1)[0].strip()
+
         return packages
 
     def search_names(self, term):
@@ -325,14 +360,16 @@ def search_names(self, term):
     @property
     def installed_packages(self):
         """
-        List of all packages that are installed in this environment in
+        List of packages that are installed in this environment in
         the format [(name, ver), ..].
         """
+
         freeze_options = ['-l', '--all'] if self.pip_version >= (8, 1, 0) else ['-l']
-        return list(map(split_package_name, filter(None, self._execute_pip(
-                ['freeze'] + freeze_options).split(linesep))))
+        return list(map(normalize_package, filter(None, self._execute_pip(
+                ['freeze'] + freeze_options).split(os.linesep))))
 
     @property
     def installed_package_names(self):
         """List of all package names that are installed in this environment."""
+
         return [name.lower() for name, _ in self.installed_packages]