Wheel binary package format

docs/news.txt

@@ -14,6 +14,8 @@ Beta and final releases planned for the end of 2012.
 develop (unreleased)
 --------------------
 
+* Pip now has experimental "wheel" support.  Thanks Daniel Holth.
+
 * Added check in ``install --download`` to prevent re-downloading if the target
   file already exists. Thanks Andrey Bulgakov.
 

docs/usage.txt

@@ -154,6 +154,24 @@ To get info about an installed package, including its location and included
 files, run ``pip show ProjectName``.
 
 
+Wheel support
+-------------
+
+Pip has experimental support for building and installing "wheel" archives.
+
+To build wheel archives::
+
+    $ pip install --build-wheel=/tmp/wheel-cache --no-install SomePackage
+
+To install from wheel archives::
+
+    $ pip install --use-wheel --no-index --find-links=file:///tmp/wheel-cache SomePackage
+
+Pip currently only supports finding wheels based on the python version tag, not implementation, abi or platform tags.
+
+For more information, see the `wheel documentation <http://wheel.readthedocs.org/en/latest/index.html>`_
+
+
 Bundles
 -------
 

pip/backwardcompat.py

@@ -110,3 +110,25 @@ def home_lib(home):
     else:
         lib = os.path.join('lib', 'python')
     return os.path.join(home, lib)
+
+try:
+    import sysconfig
+except: # pragma nocover
+    from distutils import sysconfig
+
+import pip.locations
+get_path_locations = {'purelib':pip.locations.site_packages,
+                      'platlib':pip.locations.site_packages,
+                      'scripts':pip.locations.bin_py,
+                      'data':sys.prefix}
+try:
+    sysconfig.get_path
+    def get_path(path):
+        try:
+            return get_path_locations[path]
+        except KeyError:
+            return sysconfig.get_path(path)
+except AttributeError: # Python < 2.7
+    from pip.locations import site_packages, bin_py
+    def get_path(path):
+        return get_path_locations[path]

pip/commands/build.py

@@ -0,0 +1,25 @@
+from pip.locations import build_prefix, src_prefix
+from pip.util import display_path, backup_dir
+from pip.log import logger
+from pip.exceptions import CommandError
+from pip.commands.install import InstallCommand
+
+
+class BuildCommand(InstallCommand):
+    name = 'build'
+    usage = '%prog [OPTIONS] PACKAGE_NAMES...'
+    summary = 'Build packages'
+
+    def __init__(self):
+        super(BuildCommand, self).__init__()
+        self.parser.set_defaults(**{
+            'use_wheel': False,
+            'no_install': True,
+        })
+
+    def run(self, options, args):
+        if not options.wheel_cache:
+            raise CommandError('You must supply -w, --build-wheel option')
+        super(BuildCommand, self).run(options, args)
+
+BuildCommand()

pip/commands/install.py

@@ -20,6 +20,18 @@ class InstallCommand(Command):
 
     def __init__(self):
         super(InstallCommand, self).__init__()
+        self.parser.add_option('--use-wheel',
+            dest='use_wheel',
+            action='store_true',
+            help='Find wheel archives when searching index and find-links')
+        self.parser.add_option(
+            '-w', '--build-wheel    ',
+            dest='wheel_cache',
+            default=None,
+            metavar='DIR',
+            help="Run 'setup.py bdist_wheel -d DIR' prior to installing "
+            "distributions. The \"wheel\" package is required to build wheels. "
+            "Combine with --no-install to only build.")
         self.parser.add_option(
             '-e', '--editable',
             dest='editables',
@@ -181,7 +193,8 @@ def _build_package_finder(self, options, index_urls):
         return PackageFinder(find_links=options.find_links,
                              index_urls=index_urls,
                              use_mirrors=options.use_mirrors,
-                             mirrors=options.mirrors)
+                             mirrors=options.mirrors,
+                             use_wheel=options.use_wheel)
 
     def run(self, options, args):
         if options.download_dir:
@@ -190,6 +203,7 @@ def run(self, options, args):
         options.build_dir = os.path.abspath(options.build_dir)
         options.src_dir = os.path.abspath(options.src_dir)
         install_options = options.install_options or []
+        only_wheels = options.no_install and options.wheel_cache
         if options.use_user_site:
             if virtualenv_no_global():
                 raise InstallationError("Can not perform a '--user' install. User site-packages are not visible in this virtualenv.")
@@ -214,11 +228,14 @@ def run(self, options, args):
             src_dir=options.src_dir,
             download_dir=options.download_dir,
             download_cache=options.download_cache,
+            use_wheel=options.use_wheel,
+            wheel_cache=options.wheel_cache,
             upgrade=options.upgrade,
             as_egg=options.as_egg,
             ignore_installed=options.ignore_installed,
             ignore_dependencies=options.ignore_dependencies,
             force_reinstall=options.force_reinstall,
+            only_wheels=only_wheels,
             use_user_site=options.use_user_site)
         for name in args:
             requirement_set.add_requirement(
@@ -257,7 +274,7 @@ def run(self, options, args):
         else:
             requirement_set.locate_files()
 
-        if not options.no_install and not self.bundle:
+        if (not options.no_install and not self.bundle) or only_wheels:
             requirement_set.install(install_options, global_options)
             installed = ' '.join([req.name for req in
                                   requirement_set.successfully_installed])

pip/commands/zip.py

@@ -134,7 +134,8 @@ def unzip_package(self, module_name, filename):
             ## FIXME: this should be undoable:
             zip = zipfile.ZipFile(zip_filename)
             to_save = []
-            for name in zip.namelist():
+            for info in zip.infolist():
+                name = info.filename
                 if name.startswith(module_name + os.path.sep):
                     content = zip.read(name)
                     dest = os.path.join(package_path, name)

pip/download.py

@@ -280,7 +280,8 @@ def geturl(urllib2_resp):
 
 def is_archive_file(name):
     """Return True if `name` is a considered as an archive file."""
-    archives = ('.zip', '.tar.gz', '.tar.bz2', '.tgz', '.tar', '.pybundle')
+    archives = ('.zip', '.tar.gz', '.tar.bz2', '.tgz', '.tar', '.pybundle',
+               '.whl')
     ext = splitext(name)[1].lower()
     if ext in archives:
         return True

pip/index.py

@@ -40,7 +40,8 @@ class PackageFinder(object):
     """
 
     def __init__(self, find_links, index_urls,
-            use_mirrors=False, mirrors=None, main_mirror_url=None):
+            use_mirrors=False, mirrors=None, main_mirror_url=None,
+            use_wheel=False):
         self.find_links = find_links
         self.index_urls = index_urls
         self.dependency_links = []
@@ -52,6 +53,7 @@ def __init__(self, find_links, index_urls,
             logger.info('Using PyPI mirrors: %s' % ', '.join(self.mirror_urls))
         else:
             self.mirror_urls = []
+        self.use_wheel = use_wheel
 
     def add_dependency_links(self, links):
         ## FIXME: this shouldn't be global list this, it should only
@@ -258,9 +260,14 @@ def _get_queued_page(self, req, pending_queue, done, seen):
             for link in page.rel_links():
                 pending_queue.put(link)
 
-    _egg_fragment_re = re.compile(r'#egg=([^&]*)')
+    _egg_fragment_re = re.compile(r'#egg=([^&]*)')    
     _egg_info_re = re.compile(r'([a-z0-9_.]+)-([a-z0-9_.-]+)', re.I)
     _py_version_re = re.compile(r'-py([123]\.?[0-9]?)$')
+    _wheel_info_re = re.compile(
+                r"""^(?P<namever>(?P<name>.+?)(-(?P<ver>\d.+?))?)
+                ((-(?P<build>\d.*?))?-(?P<pyver>.+?)-(?P<abi>.+?)-(?P<plat>.+?)
+                \.whl|\.dist-info)$""",
+                re.VERBOSE)
 
     def _sort_links(self, links):
         "Returns elements of links in order, non-egg links first, egg links second, while eliminating duplicates"
@@ -279,6 +286,12 @@ def _package_versions(self, links, search_name):
         for link in self._sort_links(links):
             for v in self._link_package_versions(link, search_name):
                 yield v
+
+    def _known_extensions(self):
+        extensions = ('.tar.gz', '.tar.bz2', '.tar', '.tgz', '.zip') 
+        if self.use_wheel:
+            return extensions + ('.whl',)
+        return extensions
 
     def _link_package_versions(self, link, search_name):
         """
@@ -288,6 +301,7 @@ def _link_package_versions(self, link, search_name):
 
         Meant to be overridden by subclasses, not called by clients.
         """
+        version = None
         if link.egg_fragment:
             egg_info = link.egg_fragment
         else:
@@ -301,7 +315,7 @@ def _link_package_versions(self, link, search_name):
                 # Special double-extension case:
                 egg_info = egg_info[:-4]
                 ext = '.tar' + ext
-            if ext not in ('.tar.gz', '.tar.bz2', '.tar', '.tgz', '.zip'):
+            if ext not in self._known_extensions():
                 if link not in self.logged_links:
                     logger.debug('Skipping link %s; unknown archive format: %s' % (link, ext))
                     self.logged_links.add(link)
@@ -311,7 +325,23 @@ def _link_package_versions(self, link, search_name):
                     logger.debug('Skipping link %s; macosx10 one' % (link))
                     self.logged_links.add(link)
                 return []
-        version = self._egg_info_matches(egg_info, search_name, link)
+            if ext == '.whl':
+                wheel_info = self._wheel_info_re.match(link.filename)
+                if wheel_info.group('name').replace('_', '-').lower() == search_name.lower():
+                    version = wheel_info.group('ver')
+                    nodot = sys.version[:3].replace('.', '')
+                    pyversions = wheel_info.group('pyver').split('.')
+                    ok = False
+                    for pv in pyversions:
+                        # TODO: Doesn't check Python implementation
+                        if nodot.startswith(pv[2:]):
+                            ok = True
+                            break
+                    if not ok:
+                        logger.debug('Skipping %s because Python version is incorrect' % link)
+                        return []    
+        if not version:
+            version = self._egg_info_matches(egg_info, search_name, link)
         if version is None:
             logger.debug('Skipping link %s; wrong project name (not %s)' % (link, search_name))
             return []