Gecko [ technovaaa.co.uk ]

Name	Size	Permission	Date
__pycache__	[ DIR ]	drwxr-xr-x	2025-08-15 18:14
__init__.py	0 B	-rw-r--r--	2024-10-02 19:13
_log.py	1015 B	-rw-r--r--	2024-10-02 19:13
appdirs.py	1.63 KB	-rw-r--r--	2024-10-02 19:13
compat.py	1.84 KB	-rw-r--r--	2024-10-02 19:13
compatibility_tags.py	5.25 KB	-rw-r--r--	2024-10-02 19:13
datetime.py	242 B	-rw-r--r--	2024-10-02 19:13
deprecation.py	3.54 KB	-rw-r--r--	2024-10-02 19:13
direct_url_helpers.py	3.13 KB	-rw-r--r--	2024-10-02 19:13
distutils_args.py	1.22 KB	-rw-r--r--	2024-10-02 19:13
egg_link.py	2.15 KB	-rw-r--r--	2024-10-02 19:13
encoding.py	1.14 KB	-rw-r--r--	2024-10-02 19:13
entrypoints.py	1.1 KB	-rw-r--r--	2024-10-02 19:13
filesystem.py	5.75 KB	-rw-r--r--	2024-10-02 19:13
filetypes.py	716 B	-rw-r--r--	2024-10-02 19:13
glibc.py	3.04 KB	-rw-r--r--	2024-10-02 19:13
hashes.py	4.7 KB	-rw-r--r--	2024-10-02 19:13
inject_securetransport.py	795 B	-rw-r--r--	2024-10-02 19:13
logging.py	11.26 KB	-rw-r--r--	2024-10-02 19:13
misc.py	20.29 KB	-rw-r--r--	2024-10-02 19:13
models.py	1.17 KB	-rw-r--r--	2024-10-02 19:13
packaging.py	2.88 KB	-rw-r--r--	2024-10-02 19:13
parallel.py	3.12 KB	-rw-r--r--	2024-10-02 19:13
pkg_resources.py	987 B	-rw-r--r--	2024-10-02 19:13
setuptools_build.py	4.59 KB	-rw-r--r--	2024-10-02 19:13
subprocess.py	9.82 KB	-rw-r--r--	2024-10-02 19:13
temp_dir.py	7.48 KB	-rw-r--r--	2024-10-02 19:13
unpacking.py	8.94 KB	-rw-r--r--	2024-10-02 19:13
urls.py	1.72 KB	-rw-r--r--	2024-10-02 19:13
virtualenv.py	3.38 KB	-rw-r--r--	2024-10-02 19:13
wheel.py	6.02 KB	-rw-r--r--	2024-10-02 19:13

Rename

"""
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)