Skip to content

Commit

Permalink
Deprecate public access to setuptools.dist.sequence
Browse files Browse the repository at this point in the history
  • Loading branch information
abravalheri authored and Avasam committed Oct 15, 2024
1 parent 00995c1 commit 000a413
Showing 1 changed file with 30 additions and 8 deletions.
38 changes: 30 additions & 8 deletions setuptools/dist.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,16 @@
import sys
from glob import iglob
from pathlib import Path
from typing import TYPE_CHECKING, List, MutableMapping, NoReturn, Tuple, Union, overload
from typing import (
TYPE_CHECKING,
Any,
List,
MutableMapping,
NoReturn,
Tuple,
Union,
overload,
)

from more_itertools import partition, unique_everseen
from packaging.markers import InvalidMarker, Marker
Expand Down Expand Up @@ -42,8 +51,10 @@

__all__ = ['Distribution']

sequence = tuple, list
_sequence = tuple, list
"""
:meta private:
Supported iterable types that are known to be:
- ordered (which `set` isn't)
- not match a str (which `Sequence[str]` does)
Expand All @@ -55,6 +66,17 @@
_requence_type_repr = "tuple[str, ...] | list[str]"


def __getattr__(name: str) -> Any: # pragma: no cover
if name == "sequence":
SetuptoolsDeprecationWarning.emit(
"`setuptools.dist.sequence` is an internal implementation detail.",
"Please define your own `sequence = tuple, list` instead.",
due_date=(2025, 8, 28), # Originally added on 2024-08-27
)
return _sequence
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")


def check_importable(dist, attr, value):
try:
ep = metadata.EntryPoint(value=value, name=None, group=None)
Expand All @@ -70,7 +92,7 @@ def assert_string_list(dist, attr: str, value: _Sequence) -> None:
try:
# verify that value is a list or tuple to exclude unordered
# or single-use iterables
assert isinstance(value, sequence)
assert isinstance(value, _sequence)
# verify that elements of value are strings
assert ''.join(value) != value
except (TypeError, ValueError, AttributeError, AssertionError) as e:
Expand Down Expand Up @@ -786,15 +808,15 @@ def has_contents_for(self, package):

def _exclude_misc(self, name: str, value: _Sequence) -> None:
"""Handle 'exclude()' for list/tuple attrs without a special handler"""
if not isinstance(value, sequence):
if not isinstance(value, _sequence):
raise DistutilsSetupError(
f"{name}: setting must be of type <{_requence_type_repr}> (got {value!r})"
)
try:
old = getattr(self, name)
except AttributeError as e:
raise DistutilsSetupError("%s: No such distribution setting" % name) from e
if old is not None and not isinstance(old, sequence):
if old is not None and not isinstance(old, _sequence):
raise DistutilsSetupError(
name + ": this setting cannot be changed via include/exclude"
)
Expand All @@ -804,7 +826,7 @@ def _exclude_misc(self, name: str, value: _Sequence) -> None:
def _include_misc(self, name: str, value: _Sequence) -> None:
"""Handle 'include()' for list/tuple attrs without a special handler"""

if not isinstance(value, sequence):
if not isinstance(value, _sequence):
raise DistutilsSetupError(
f"{name}: setting must be of type <{_requence_type_repr}> (got {value!r})"
)
Expand All @@ -814,7 +836,7 @@ def _include_misc(self, name: str, value: _Sequence) -> None:
raise DistutilsSetupError("%s: No such distribution setting" % name) from e
if old is None:
setattr(self, name, value)
elif not isinstance(old, sequence):
elif not isinstance(old, _sequence):
raise DistutilsSetupError(
name + ": this setting cannot be changed via include/exclude"
)
Expand Down Expand Up @@ -846,7 +868,7 @@ def exclude(self, **attrs):
self._exclude_misc(k, v)

def _exclude_packages(self, packages: _Sequence) -> None:
if not isinstance(packages, sequence):
if not isinstance(packages, _sequence):
raise DistutilsSetupError(
f"packages: setting must be of type <{_requence_type_repr}> (got {packages!r})"
)
Expand Down

0 comments on commit 000a413

Please sign in to comment.