pip._internal.utils.deprecation Namespace Reference

Classes
class	PipDeprecationWarning

Functions
None	_showwarning (Union[Warning, str] message, Type[Warning] category, str filename, int lineno, Optional[TextIO] file=None, Optional[str] line=None)
None	install_warning_logger ()
None	deprecated (*str reason, Optional[str] replacement, Optional[str] gone_in, Optional[str] feature_flag=None, Optional[int] issue=None)

Variables
str	DEPRECATION_MSG_PREFIX = "DEPRECATION: "

Detailed Description

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

Function Documentation

deprecated()

None pip._internal.utils.deprecation.deprecated	(	*str	reason,
		Optional[str]	replacement,
		Optional[str]	gone_in,
		Optional[str]	feature_flag = None,
		Optional[int]	issue = 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.