reviewbot.deprecation¶
Internal support for handling deprecations in Review Bot.
The version-specific objects in this module are not considered stable between releases, and may be removed at any point. The base objects are considered stable.
New in version 3.0.
Module Attributes
An alias for the next release of Review Bot where features would be removed. |
Exceptions
Base class for a Review Bot deprecation warning. |
|
An alias for the next release of Review Bot where features would be removed. |
|
Deprecations for features removed in Review Bot 4.0. |
|
Deprecations for features removed in Review Bot 5.0. |
- exception BaseRemovedInReviewBotVersionWarning[source]¶
Bases:
DeprecationWarning
Base class for a Review Bot deprecation warning.
All version-specific deprecation warnings inherit from this, allowing callers to check for Review Bot deprecations without being tied to a specific version.
- classmethod warn(message, stacklevel=2)[source]¶
Emit the deprecation warning.
This is a convenience function that emits a deprecation warning using this class, with a suitable default stack level. Callers can provide a useful message and a custom stack level.
- Parameters:
message (
str
) – The message to show in the deprecation warning.stacklevel (
int
, optional) – The stack level for the warning.
- exception RemovedInReviewBot40Warning[source]¶
Bases:
BaseRemovedInReviewBotVersionWarning
Deprecations for features removed in Review Bot 4.0.
Note that this class will itself be removed in Review Bot 4.0. If you need to check against Review Bot deprecation warnings, please see
BaseRemovedInReviewBotVersionWarning
.- __annotations__ = {}¶
- exception RemovedInReviewBot50Warning[source]¶
Bases:
BaseRemovedInReviewBotVersionWarning
Deprecations for features removed in Review Bot 5.0.
Note that this class will itself be removed in Review Bot 5.0. If you need to check against Review Bot deprecation warnings, please see
BaseRemovedInReviewBotVersionWarning
. Alternatively, you can use the alias for this class,RemovedInNextReviewBotVersionWarning
.- __annotations__ = {}¶