Add a public API

.github/workflows/publish.yml

@@ -2,12 +2,14 @@ name: Publish packages to PyPI
 
 on:
   create:
-    tags: "*"
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+[a-b][0-9]+"
+      - "[0-9]+.[0-9]+.[0-9]+rc[0-9]+"
 
 jobs:
   publish:
     runs-on: ubuntu-latest
-    if: startsWith(github.ref, 'refs/tags/')
     steps:
     - uses: actions/checkout@v3
     - name: Set up Python

.github/workflows/test.yml

@@ -39,14 +39,12 @@ jobs:
       with:
         path: ~/.cache/pip
         key: pip-test-${{ matrix.python-version }}-${{ matrix.os }}
-    - name: Install the project
-      run: "pip install --no-binary=:all: ."
-    - name: Install test dependencies
-      run: pip install .[test] coverage[toml]
+    - name: Install the project and its test dependencies
+      run: pip install --no-binary=setuptools,wheel .[test] coverage[toml]
     - name: Test with pytest
       run: |
-        coverage run -m pytest -W always
-        coverage xml
+        python -m coverage run -m pytest -W always
+        python -m coverage xml
     - name: Send coverage data to Codecov
       uses: codecov/codecov-action@v3
       with:

docs/news.rst

@@ -1,6 +1,11 @@
 Release Notes
 =============
 
+**UNRELEASED**
+
+- Added a public API
+- Dropped support for converting ``bdist_wininst`` based installers into wheels
+
 **0.38.0 (2022-10-21)**
 
 - Dropped support for Python < 3.7

setup.cfg

@@ -32,15 +32,15 @@ package_dir=
     = src
 packages = find:
 python_requires = >=3.7
-install_requires = setuptools >= 57.0.0
 zip_safe = False
 
 [options.packages.find]
 where = src
 
 [options.extras_require]
 test =
-    pytest >= 3.0.0
+    pytest >= 6.2.0
+    setuptools >= 57
 
 [options.entry_points]
 console_scripts =
@@ -58,6 +58,7 @@ max-line-length = 88
 
 [tool:pytest]
 testpaths = tests
+addopts = --tb=short
 
 [coverage:run]
 source = wheel

src/wheel/__init__.py

@@ -1,3 +1,6 @@
 from __future__ import annotations
 
-__version__ = "0.38.0"
+__all__ = ["WheelError", "WheelReader", "WheelWriter", "make_filename"]
+__version__ = "1.0.0a1"
+
+from ._wheelfile import WheelError, WheelReader, WheelWriter, make_filename

src/wheel/macosx_libfile.py → src/wheel/_macosx_libfile.py

@@ -43,6 +43,7 @@
 import ctypes
 import os
 import sys
+from typing import BinaryIO
 
 """here the needed const and struct from mach-o header files"""
 
@@ -238,7 +239,7 @@
 """
 
 
-def swap32(x):
+def swap32(x: int) -> int:
     return (
         ((x << 24) & 0xFF000000)
         | ((x << 8) & 0x00FF0000)
@@ -247,7 +248,9 @@ def swap32(x):
     )
 
 
-def get_base_class_and_magic_number(lib_file, seek=None):
+def get_base_class_and_magic_number(
+    lib_file: BinaryIO, seek: int | None = None
+) -> tuple[type[ctypes.Structure], int]:
     if seek is None:
         seek = lib_file.tell()
     else:
@@ -271,11 +274,11 @@ def get_base_class_and_magic_number(lib_file, seek=None):
     return BaseClass, magic_number
 
 
-def read_data(struct_class, lib_file):
+def read_data(struct_class: type[ctypes.Structure], lib_file: BinaryIO):
     return struct_class.from_buffer_copy(lib_file.read(ctypes.sizeof(struct_class)))
 
 
-def extract_macosx_min_system_version(path_to_lib):
+def extract_macosx_min_system_version(path_to_lib: str) -> tuple[int, int, int] | None:
     with open(path_to_lib, "rb") as lib_file:
         BaseClass, magic_number = get_base_class_and_magic_number(lib_file, 0)
         if magic_number not in [FAT_MAGIC, FAT_MAGIC_64, MH_MAGIC, MH_MAGIC_64]:
@@ -333,7 +336,9 @@ class FatArch(BaseClass):
                 return None
 
 
-def read_mach_header(lib_file, seek=None):
+def read_mach_header(
+    lib_file: BinaryIO, seek: int | None = None
+) -> tuple[int, int, int] | None:
     """
     This funcition parse mach-O header and extract
     information about minimal system version
@@ -382,14 +387,14 @@ class VersionBuild(base_class):
             continue
 
 
-def parse_version(version):
+def parse_version(version: int) -> tuple[int, int, int]:
     x = (version & 0xFFFF0000) >> 16
     y = (version & 0x0000FF00) >> 8
     z = version & 0x000000FF
     return x, y, z
 
 
-def calculate_macosx_platform_tag(archive_root, platform_tag):
+def calculate_macosx_platform_tag(archive_root: str, platform_tag: str) -> str:
     """
     Calculate proper macosx platform tag basing on files which are included to wheel
 
@@ -467,5 +472,4 @@ def calculate_macosx_platform_tag(archive_root, platform_tag):
 
         sys.stderr.write(error_message)
 
-    platform_tag = prefix + "_" + fin_base_version + "_" + suffix
-    return platform_tag
+    return prefix + "_" + fin_base_version + "_" + suffix

src/wheel/metadata.py → src/wheel/_metadata.py

@@ -3,11 +3,9 @@
 """
 from __future__ import annotations
 
-import os.path
-import textwrap
-from email.message import Message
-from email.parser import Parser
-from typing import Iterator
+from collections.abc import Iterator
+from email.parser import HeaderParser
+from pathlib import Path
 
 from pkg_resources import Requirement, safe_extra, split_sections
 
@@ -69,41 +67,24 @@ def generate_requirements(
             yield "Requires-Dist", new_req + condition
 
 
-def pkginfo_to_metadata(egg_info_path: str, pkginfo_path: str) -> Message:
-    """
-    Convert .egg-info directory with PKG-INFO to the Metadata 2.1 format
-    """
-    with open(pkginfo_path, encoding="utf-8") as headers:
-        pkg_info = Parser().parse(headers)
+def pkginfo_to_metadata(pkginfo_path: Path) -> list[tuple[str, str]]:
+    """Convert an .egg-info/PKG-INFO file to the Metadata 2.1 format."""
+
+    with pkginfo_path.open() as fp:
+        pkg_info = HeaderParser().parse(fp)
 
     pkg_info.replace_header("Metadata-Version", "2.1")
+
     # Those will be regenerated from `requires.txt`.
     del pkg_info["Provides-Extra"]
     del pkg_info["Requires-Dist"]
-    requires_path = os.path.join(egg_info_path, "requires.txt")
-    if os.path.exists(requires_path):
-        with open(requires_path) as requires_file:
-            requires = requires_file.read()
-
+    requires_path = pkginfo_path.parent / "requires.txt"
+    if requires_path.exists():
+        requires = requires_path.read_text()
         parsed_requirements = sorted(split_sections(requires), key=lambda x: x[0] or "")
         for extra, reqs in parsed_requirements:
             for key, value in generate_requirements({extra: reqs}):
                 if (key, value) not in pkg_info.items():
                     pkg_info[key] = value
 
-    description = pkg_info["Description"]
-    if description:
-        description_lines = pkg_info["Description"].splitlines()
-        dedented_description = "\n".join(
-            # if the first line of long_description is blank,
-            # the first line here will be indented.
-            (
-                description_lines[0].lstrip(),
-                textwrap.dedent("\n".join(description_lines[1:])),
-                "\n",
-            )
-        )
-        pkg_info.set_payload(dedented_description)
-        del pkg_info["Description"]
-
-    return pkg_info
+    return list(pkg_info.items())