Skip to content

Deprecate bdist_wininst #2040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelog.d/2040.change.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Deprecated the ``bdist_wininst`` command. Binary packages should be built as wheels instead.
9 changes: 9 additions & 0 deletions setuptools/command/bdist_wininst.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import distutils.command.bdist_wininst as orig
import warnings

from setuptools import SetuptoolsDeprecationWarning


class bdist_wininst(orig.bdist_wininst):
Expand All @@ -14,6 +17,12 @@ def reinitialize_command(self, command, reinit_subcommands=0):
return cmd

def run(self):
warnings.warn(
"bdist_wininst is deprecated and will be removed in a future "
"version. Use bdist_wheel (wheel packages) instead.",
SetuptoolsDeprecationWarning
)

self._is_running = True
try:
orig.bdist_wininst.run(self)
Expand Down
23 changes: 23 additions & 0 deletions setuptools/tests/test_bdist_deprecations.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
"""develop tests
"""
import mock

import pytest

from setuptools.dist import Distribution
from setuptools import SetuptoolsDeprecationWarning


@mock.patch("distutils.command.bdist_wininst.bdist_wininst")
def test_bdist_wininst_warning(distutils_cmd):
dist = Distribution(dict(
script_name='setup.py',
script_args=['bdist_wininst'],
name='foo',
py_modules=['hi'],
))
dist.parse_command_line()
with pytest.warns(SetuptoolsDeprecationWarning):
dist.run_commands()

distutils_cmd.run.assert_called_once()