SWAMPy

✎ CARVE FLESH

EDITING: deprecation.py

"""
A module that implements tooling to enable easy warnings about deprecations.
"""

import logging
import warnings
from typing import Any, Optional, TextIO, Type, Union

from pip._vendor.packaging.version import parse

from pip import __version__ as current_version  # NOTE: tests patch this name.

DEPRECATION_MSG_PREFIX = "DEPRECATION: "

class PipDeprecationWarning(Warning):
    pass

_original_showwarning: Any = None

# Warnings <-> Logging Integration
def _showwarning(
    message: Union[Warning, str],
    category: Type[Warning],
    filename: str,
    lineno: int,
    file: Optional[TextIO] = None,
    line: Optional[str] = None,
) -> None:
    if file is not None:
        if _original_showwarning is not None:
            _original_showwarning(message, category, filename, lineno, file, line)
    elif issubclass(category, PipDeprecationWarning):
        # We use a specially named logger which will handle all of the
        # deprecation messages for pip.
        logger = logging.getLogger("pip._internal.deprecations")
        logger.warning(message)
    else:
        _original_showwarning(message, category, filename, lineno, file, line)

def install_warning_logger() -> None:
    # Enable our Deprecation Warnings
    warnings.simplefilter("default", PipDeprecationWarning, append=True)

global _original_showwarning

if _original_showwarning is None:
        _original_showwarning = warnings.showwarning
        warnings.showwarning = _showwarning

def deprecated(
    *,
    reason: str,
    replacement: Optional[str],
    gone_in: Optional[str],
    feature_flag: Optional[str] = None,
    issue: Optional[int] = None,
) -> None:
    """Helper to deprecate existing functionality.

reason:
        Textual reason shown to the user about why this functionality has
        been deprecated. Should be a complete sentence.
    replacement:
        Textual suggestion shown to the user about what alternative
        functionality they can use.
    gone_in:
        The version of pip does this functionality should get removed in.
        Raises an error if pip's current version is greater than or equal to
        this.
    feature_flag:
        Command-line flag of the form --use-feature={feature_flag} for testing
        upcoming functionality.
    issue:
        Issue number on the tracker that would serve as a useful place for
        users to find related discussion and provide feedback.
    """

# Determine whether or not the feature is already gone in this version.
    is_gone = gone_in is not None and parse(current_version) >= parse(gone_in)

message_parts = [
        (reason, f"{DEPRECATION_MSG_PREFIX}{{}}"),
        (
            gone_in,
            "pip {} will enforce this behaviour change."
            if not is_gone
            else "Since pip {}, this is no longer supported.",
        ),
        (
            replacement,
            "A possible replacement is {}.",
        ),
        (
            feature_flag,
            "You can use the flag --use-feature={} to test the upcoming behaviour."
            if not is_gone
            else None,
        ),
        (
            issue,
            "Discussion can be found at https://github.com/pypa/pip/issues/{}",
        ),
    ]

message = " ".join(
        format_str.format(value)
        for value, format_str in message_parts
        if format_str is not None and value is not None
    )

# Raise as an error if this behaviour is deprecated.
    if is_gone:
        raise PipDeprecationWarning(message)

warnings.warn(message, category=PipDeprecationWarning, stacklevel=2)

CANCEL

Name	Type	Size	Modified	Actions
↩ ..	DIR	—	—
📄 __init__.py	PY	0 B	2025-09-22 19:18	EDIT
📄 _jaraco_text.py	PY	3.3 KB	2025-09-22 19:18	EDIT
📄 _log.py	PY	1015 B	2025-09-22 19:18	EDIT
📄 appdirs.py	PY	1.6 KB	2025-09-22 19:18	EDIT
📄 compat.py	PY	1.8 KB	2025-09-22 19:18	EDIT
📄 compatibility_tags.py	PY	5.3 KB	2025-09-22 19:18	EDIT
📄 datetime.py	PY	242 B	2025-09-22 19:18	EDIT
📄 deprecation.py	PY	3.5 KB	2025-09-22 19:18	EDIT
📄 direct_url_helpers.py	PY	3.1 KB	2025-09-22 19:18	EDIT
📄 egg_link.py	PY	2.4 KB	2025-09-22 19:18	EDIT
📄 encoding.py	PY	1.1 KB	2025-09-22 19:18	EDIT
📄 entrypoints.py	PY	3 KB	2025-09-22 19:18	EDIT
📄 filesystem.py	PY	5 KB	2025-09-22 19:18	EDIT
📄 filetypes.py	PY	716 B	2025-09-22 19:18	EDIT
📄 glibc.py	PY	3 KB	2025-09-22 19:18	EDIT
📄 hashes.py	PY	5 KB	2025-09-22 19:18	EDIT
📄 logging.py	PY	11.3 KB	2025-09-22 19:18	EDIT
📄 misc.py	PY	23.1 KB	2025-09-22 19:18	EDIT
📄 models.py	PY	1.2 KB	2025-09-22 19:18	EDIT
📄 packaging.py	PY	2.1 KB	2025-09-22 19:18	EDIT
📄 setuptools_build.py	PY	4.3 KB	2025-09-22 19:18	EDIT
📄 subprocess.py	PY	9 KB	2025-09-22 19:18	EDIT
📄 temp_dir.py	PY	9.1 KB	2025-09-22 19:18	EDIT
📄 unpacking.py	PY	8.6 KB	2025-09-22 19:18	EDIT
📄 urls.py	PY	1.7 KB	2025-09-22 19:18	EDIT
📄 virtualenv.py	PY	3.4 KB	2025-09-22 19:18	EDIT
📄 wheel.py	PY	4.4 KB	2025-09-22 19:18	EDIT