Use PEP600 policy names (#288)

Add legacy aliases for `manylinux_2_5`, `manylinux_2_12` & `manylinux_2_17`
The platform tag passed to `auditwheel repair` `--plat` argument can use either the PEP600 tag or the legacy tag.
The repaired wheel will get both platform tags.

e.g. `auditwheel repair --plat manylinux1_x86_64 foo-5.0-cp38-cp38-linux_x86_64.whl` and `auditwheel repair --plat manylinux_2_5_x86_64 foo-5.0-cp38-cp38-linux_x86_64.whl`  will both produce `foo-5.0-cp38-cp38-manylinux_2_5_x86_64.manylinux1_x86_64.whl`

Author: mayeut

auditwheel/main_repair.py

@@ -1,8 +1,8 @@
 from os.path import isfile, exists, abspath, basename
 
 from auditwheel.patcher import Patchelf
-from .policy import (load_policies, get_policy_name, get_priority_by_name,
-                     POLICY_PRIORITY_HIGHEST)
+from .policy import (load_policies, get_policy_by_name, get_policy_name,
+                     get_priority_by_name, POLICY_PRIORITY_HIGHEST)
 from .tools import EnvironmentDefault
 import logging
 
@@ -11,6 +11,7 @@
 
 def configure_parser(sub_parsers):
     policy_names = [p['name'] for p in load_policies()]
+    policy_names += [alias for p in load_policies() for alias in p['aliases']]
     highest_policy = get_policy_name(POLICY_PRIORITY_HIGHEST)
     help = "Vendor in external shared library dependencies of a wheel."
     p = sub_parsers.add_parser('repair', help=help, description=help)
@@ -69,7 +70,8 @@ def execute(args, p):
         logger.info('This does not look like a platform wheel')
         return 1
 
-    reqd_tag = get_priority_by_name(args.PLAT)
+    policy = get_policy_by_name(args.PLAT)
+    reqd_tag = policy['priority']
 
     if reqd_tag > get_priority_by_name(wheel_abi.sym_tag):
         msg = ('cannot repair "%s" to "%s" ABI because of the presence '
@@ -85,9 +87,10 @@ def execute(args, p):
                (args.WHEEL_FILE, args.PLAT))
         p.error(msg)
 
+    abis = [policy['name']] + policy['aliases']
     patcher = Patchelf()
     out_wheel = repair_wheel(args.WHEEL_FILE,
-                             abi=args.PLAT,
+                             abis=abis,
                              lib_sdir=args.LIB_SDIR,
                              out_dir=args.WHEEL_DIR,
                              update_tags=args.UPDATE_TAGS,
@@ -101,8 +104,10 @@ def execute(args, p):
                          'You requested %s but I have found this wheel is '
                          'eligible for %s.'),
                         args.PLAT, analyzed_tag)
+            policy = get_policy_by_name(analyzed_tag)
+            abis = [policy['name']] + policy['aliases']
             out_wheel = repair_wheel(args.WHEEL_FILE,
-                                     abi=analyzed_tag,
+                                     abis=abis,
                                      lib_sdir=args.LIB_SDIR,
                                      out_dir=args.WHEEL_DIR,
                                      update_tags=args.UPDATE_TAGS,

auditwheel/main_show.py

@@ -15,7 +15,8 @@ def configure_parser(sub_parsers):
 def printp(text: str) -> None:
     from textwrap import wrap
     print()
-    print('\n'.join(wrap(text)))
+    print('\n'.join(wrap(text, break_long_words=False,
+                         break_on_hyphens=False)))
 
 
 def execute(args, p):

auditwheel/policy/__init__.py

@@ -65,6 +65,8 @@ def _validate_pep600_compliance(policies) -> None:
             if _p['name'] != 'linux':
                 _p['symbol_versions'] = _p['symbol_versions'][_ARCH_NAME]
             _p['name'] = _p['name'] + '_' + _ARCH_NAME
+            _p['aliases'] = [alias + '_' + _ARCH_NAME
+                             for alias in _p['aliases']]
             _POLICIES.append(_p)
 
 POLICY_PRIORITY_HIGHEST = max(p['priority'] for p in _POLICIES)
@@ -81,24 +83,30 @@ def _load_policy_schema():
     return schema
 
 
-def get_policy_name(priority: int) -> Optional[str]:
-    matches = [p['name'] for p in _POLICIES if p['priority'] == priority]
+def get_policy_by_name(name: str) -> Optional[Dict]:
+    matches = [p for p in _POLICIES
+               if p['name'] == name or name in p['aliases']]
     if len(matches) == 0:
         return None
     if len(matches) > 1:
-        raise RuntimeError('Internal error. priorities should be unique')
+        raise RuntimeError('Internal error. Policies should be unique')
     return matches[0]
 
 
-def get_priority_by_name(name: str) -> Optional[int]:
-    matches = [p['priority'] for p in _POLICIES if p['name'] == name]
+def get_policy_name(priority: int) -> Optional[str]:
+    matches = [p['name'] for p in _POLICIES if p['priority'] == priority]
     if len(matches) == 0:
         return None
     if len(matches) > 1:
-        raise RuntimeError('Internal error. Policies should be unique.')
+        raise RuntimeError('Internal error. priorities should be unique')
     return matches[0]
 
 
+def get_priority_by_name(name: str) -> Optional[int]:
+    policy = get_policy_by_name(name)
+    return None if policy is None else policy['priority']
+
+
 def get_replace_platforms(name: str) -> List[str]:
     """Extract platform tag replacement rules from policy
 

auditwheel/policy/policy-schema.json

@@ -12,6 +12,12 @@
                 "name": {
                     "type": "string"
                 },
+                "aliases": {
+                    "type": "array",
+                    "items": {
+                        "type": "string"
+                    }
+                },
                 "priority": {
                     "type": "integer"
                 },

auditwheel/policy/policy.json

@@ -1,10 +1,12 @@
 [
     {"name": "linux",
+     "aliases": [],
      "priority": 0,
      "symbol_versions": {},
      "lib_whitelist": []
     },
-    {"name": "manylinux1",
+    {"name": "manylinux_2_5",
+     "aliases": ["manylinux1"],
      "priority": 100,
      "symbol_versions": {
          "i686": {
@@ -29,7 +31,8 @@
          "libSM.so.6", "libGL.so.1", "libgobject-2.0.so.0",
          "libgthread-2.0.so.0", "libglib-2.0.so.0", "libresolv.so.2"
      ]},
-    {"name": "manylinux2010",
+    {"name": "manylinux_2_12",
+     "aliases": ["manylinux2010"],
      "priority": 90,
      "symbol_versions": {
        "i686": {
@@ -54,7 +57,8 @@
          "libSM.so.6", "libGL.so.1", "libgobject-2.0.so.0",
          "libgthread-2.0.so.0", "libglib-2.0.so.0", "libresolv.so.2"
      ]},
-    {"name": "manylinux2014",
+    {"name": "manylinux_2_17",
+     "aliases": ["manylinux2014"],
      "priority": 80,
      "symbol_versions": {
        "i686": {
@@ -110,6 +114,7 @@
          "libgthread-2.0.so.0", "libglib-2.0.so.0", "libresolv.so.2"
      ]},
     {"name": "manylinux_2_24",
+     "aliases": [],
      "priority": 70,
      "symbol_versions": {
        "i686": {

auditwheel/repair.py

@@ -9,7 +9,7 @@
 from os.path import exists, basename, abspath, isabs, dirname
 from os.path import join as pjoin
 from subprocess import check_call
-from typing import Dict, Iterable, Optional, Tuple
+from typing import Dict, Iterable, List, Optional, Tuple
 
 from auditwheel.patcher import ElfPatcher
 from .elfutils import elf_read_rpaths, elf_read_dt_needed, is_subdir
@@ -28,7 +28,7 @@
     re.VERBOSE).match
 
 
-def repair_wheel(wheel_path: str, abi: str, lib_sdir: str, out_dir: str,
+def repair_wheel(wheel_path: str, abis: List[str], lib_sdir: str, out_dir: str,
                  update_tags: bool, patcher: ElfPatcher,
                  strip: bool = False) -> Optional[str]:
 
@@ -61,7 +61,7 @@ def repair_wheel(wheel_path: str, abi: str, lib_sdir: str, out_dir: str,
         # the wheel, and v['libs'] contains its required libs
         for fn, v in external_refs_by_fn.items():
 
-            ext_libs = v[abi]['libs']  # type: Dict[str, str]
+            ext_libs = v[abis[0]]['libs']  # type: Dict[str, str]
             for soname, src_path in ext_libs.items():
                 if src_path is None:
                     raise ValueError(('Cannot repair wheel, because required '
@@ -88,8 +88,8 @@ def repair_wheel(wheel_path: str, abi: str, lib_sdir: str, out_dir: str,
                     patcher.replace_needed(path, n, soname_map[n][0])
 
         if update_tags:
-            ctx.out_wheel = add_platforms(ctx, [abi],
-                                          get_replace_platforms(abi))
+            ctx.out_wheel = add_platforms(ctx, abis,
+                                          get_replace_platforms(abis[0]))
 
         if strip:
             libs_to_strip = [path for (_, path) in soname_map.values()]

auditwheel/wheeltools.py

@@ -11,7 +11,7 @@
 import csv
 from itertools import product
 from types import TracebackType
-from typing import Generator, Iterable, Optional, Type
+from typing import Generator, Iterable, List, Optional, Type
 import logging
 
 from base64 import urlsafe_b64encode
@@ -178,7 +178,7 @@ def iter_files(self) -> Generator[str, None, None]:
             yield filename
 
 
-def add_platforms(wheel_ctx: InWheelCtx, platforms: Iterable[str],
+def add_platforms(wheel_ctx: InWheelCtx, platforms: List[str],
                   remove_platforms: Iterable[str] = ()) -> str:
     """Add platform tags `platforms` to a wheel
 
@@ -189,7 +189,7 @@ def add_platforms(wheel_ctx: InWheelCtx, platforms: Iterable[str],
     ----------
     wheel_ctx : InWheelCtx
         An open wheel context
-    platforms : iterable
+    platforms : list
         platform tags to add to wheel filename and WHEEL tags - e.g.
         ``('macosx_10_9_intel', 'macosx_10_9_x86_64')
     remove_platforms : iterable
@@ -216,9 +216,9 @@ def add_platforms(wheel_ctx: InWheelCtx, platforms: Iterable[str],
     fparts = parsed_fname.groupdict()
     original_fname_tags = fparts['plat'].split('.')
     logger.info('Previous filename tags: %s', ', '.join(original_fname_tags))
-    fname_tags = {tag for tag in original_fname_tags
-                  if tag not in remove_platforms}
-    fname_tags |= set(platforms)
+    fname_tags = [tag for tag in original_fname_tags
+                  if tag not in remove_platforms]
+    fname_tags = unique_by_index(fname_tags + platforms)
 
     # Can't be 'any' and another platform
     if 'any' in fname_tags and len(fname_tags) > 1:

tests/integration/test_bundled_cffi.py

@@ -0,0 +1,24 @@
+import platform
+from pathlib import Path
+import pytest
+from auditwheel.wheel_abi import analyze_wheel_abi
+
+
+HERE = Path(__file__).parent.resolve()
+
+
+@pytest.mark.skipif(platform.machine() != 'x86_64', reason='only supported on x86_64')
+@pytest.mark.parametrize('file, external_libs', [
+    ('cffi-1.5.0-cp27-none-linux_x86_64.whl', {'libffi.so.5'}),
+    ('python_snappy-0.5.2-pp260-pypy_41-linux_x86_64.whl', {'libsnappy.so.1'}),
+])
+def test_analyze_wheel_abi(file, external_libs):
+    winfo = analyze_wheel_abi(str(HERE / file))
+    assert set(winfo.external_refs['manylinux_2_5_x86_64']['libs']) == external_libs
+
+
+@pytest.mark.skipif(platform.machine() != 'x86_64', reason='only supported on x86_64')
+def test_analyze_wheel_abi_pyfpe():
+    winfo = analyze_wheel_abi(str(HERE / 'fpewheel-0.0.0-cp35-cp35m-linux_x86_64.whl'))
+    assert winfo.sym_tag == 'manylinux_2_5_x86_64'  # for external symbols, it could get manylinux1
+    assert winfo.pyfpe_tag == 'linux_x86_64'        # but for having the pyfpe reference, it gets just linux