""" A module that implements tooling to enable easy warnings about deprecations. """ # The following comment should be removed at some point in the future. # mypy: disallow-untyped-defs=False from __future__ import absolute_import import logging import warnings from pip._vendor.packaging.version import parse from pip import __version__ as current_version from pip._internal.utils.typing import MYPY_CHECK_RUNNING if MYPY_CHECK_RUNNING: from typing import Any, Optional DEPRECATION_MSG_PREFIX = "DEPRECATION: " class PipDeprecationWarning(Warning): pass _original_showwarning = None # type: Any # Warnings <-> Logging Integration def _showwarning(message, category, filename, lineno, file=None, line=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(): # type: () -> 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, replacement, gone_in, issue=None): # type: (str, Optional[str], Optional[str], Optional[int]) -> None """Helper to deprecate existing functionality. reason: Textual reason shown to the user about why this functionality has been deprecated. 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 errors if pip's current version is greater than or equal to this. issue: Issue number on the tracker that would serve as a useful place for users to find related discussion and provide feedback. Always pass replacement, gone_in and issue as keyword arguments for clarity at the call site. """ # Construct a nice message. # This is eagerly formatted as we want it to get logged as if someone # typed this entire message out. sentences = [ (reason, DEPRECATION_MSG_PREFIX + "{}"), (gone_in, "pip {} will remove support for this functionality."), (replacement, "A possible replacement is {}."), (issue, ( "You can find discussion regarding this at " "https://github.com/pypa/pip/issues/{}." )), ] message = " ".join( template.format(val) for val, template in sentences if val is not None ) # Raise as an error if it has to be removed. if gone_in is not None and parse(current_version) >= parse(gone_in): raise PipDeprecationWarning(message) warnings.warn(message, category=PipDeprecationWarning, stacklevel=2)
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
__pycache__ | Folder | 2755 |
|
|
__init__.py | File | 0 B | 0644 |
|
appdirs.py | File | 1.32 KB | 0644 |
|
compat.py | File | 9.27 KB | 0644 |
|
compatibility_tags.py | File | 5.31 KB | 0644 |
|
datetime.py | File | 295 B | 0644 |
|
deprecation.py | File | 3.24 KB | 0644 |
|
direct_url_helpers.py | File | 4.26 KB | 0644 |
|
distutils_args.py | File | 1.32 KB | 0644 |
|
encoding.py | File | 1.25 KB | 0644 |
|
entrypoints.py | File | 1.13 KB | 0644 |
|
filesystem.py | File | 6.78 KB | 0644 |
|
filetypes.py | File | 571 B | 0644 |
|
glibc.py | File | 3.22 KB | 0644 |
|
hashes.py | File | 4.57 KB | 0644 |
|
inject_securetransport.py | File | 810 B | 0644 |
|
logging.py | File | 12.79 KB | 0644 |
|
misc.py | File | 27.34 KB | 0644 |
|
models.py | File | 1.17 KB | 0644 |
|
packaging.py | File | 2.96 KB | 0644 |
|
parallel.py | File | 3.32 KB | 0644 |
|
pkg_resources.py | File | 1.22 KB | 0644 |
|
setuptools_build.py | File | 4.94 KB | 0644 |
|
subprocess.py | File | 9.69 KB | 0644 |
|
temp_dir.py | File | 8.18 KB | 0644 |
|
typing.py | File | 1.37 KB | 0644 |
|
unpacking.py | File | 9.27 KB | 0644 |
|
urls.py | File | 1.49 KB | 0644 |
|
virtualenv.py | File | 3.62 KB | 0644 |
|
wheel.py | File | 7.13 KB | 0644 |
|