Skip to content

Commit 09cdccc

Browse files
committed
Added deprecation warnings to all modules not previously prefixed with an underscore
This was done to discourage anyone from importing `wheel`.
1 parent 1e00742 commit 09cdccc

27 files changed

+1588
-1532
lines changed

README.rst

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
11
wheel
22
=====
33

4-
This library is the reference implementation of the Python wheel packaging
5-
standard, as defined in `PEP 427`_.
4+
This is a command line tool for manipulating Python wheel files, as defined in
5+
`PEP 427`_. It contains the following functionality:
66

7-
It has two different roles:
7+
* Convert ``.egg`` archives into ``.whl``
8+
* Unpack wheel archives
9+
* Repack wheel archives
10+
* Add or remove tags in existing wheel archives
811

9-
#. A setuptools_ extension for building wheels that provides the
10-
``bdist_wheel`` setuptools command
11-
#. A command line tool for working with wheel files
12+
Historical note
13+
---------------
1214

13-
It should be noted that wheel is **not** intended to be used as a library, and
14-
as such there is no stable, public API.
15+
This library used to be the reference implementation of the Python wheel packaging
16+
standard, and a setuptools_ extension containing the ``bdist_wheel`` command. The wheel
17+
file processing functionality has since been moved to the packaging_ library, and the
18+
``bdist_wheel`` command has been merged into setuptools itself, leaving this project to
19+
only contain the command line interface.
1520

1621
.. _PEP 427: https://www.python.org/dev/peps/pep-0427/
22+
.. _packaging: https://pypi.org/project/packaging/
1723
.. _setuptools: https://pypi.org/project/setuptools/
1824

1925
Documentation

docs/news.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ Release Notes
44
**UNRELEASED**
55

66
- Canonicalize requirements in METADATA file (PR by Wim Jeantine-Glenn)
7+
- Added deprecation warnings to all modules not previously prefixed with an underscore
78

89
**0.43.0 (2024-03-11)**
910

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Changelog = "https://wheel.readthedocs.io/en/stable/news.html"
3232
Source = "https://github.com/pypa/wheel"
3333

3434
[project.scripts]
35-
wheel = "wheel.cli:main"
35+
wheel = "wheel._cli:main"
3636

3737
[project.entry-points."distutils.commands"]
3838
bdist_wheel = "wheel.bdist_wheel:bdist_wheel"

src/wheel/__main__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,9 @@ def main(): # needed for console script
1414

1515
path = os.path.dirname(os.path.dirname(__file__))
1616
sys.path[0:0] = [path]
17-
import wheel.cli
17+
from wheel import _cli
1818

19-
sys.exit(wheel.cli.main())
19+
sys.exit(_cli.main())
2020

2121

2222
if __name__ == "__main__":

0 commit comments

Comments
 (0)