deprecations#
用于辅助弃用代码的工具。
类#
用于为指定版本创建弃用句柄的工厂。 |
属性#
- T#
- exception DeprecatedError#
基类：
RuntimeError未指定的运行时错误。
初始化 self。请参阅 help(type(self)) 以获得准确的签名。
- class DeprecationHandler(version: str)#
用于为指定版本创建弃用句柄的工厂。
- 参数:
version -- 用于在检查弃用状态时进行比较的版本。
- static _get_version_tuple(version: str) tuple[int, Ellipsis] | None#
如果可能，将版本作为非空整数元组返回，否则返回 None。
- 参数:
version -- 要解析的版本字符串。
- __call__(deprecate_in: str, remove_in: str, *, addendum: str | None = None, stack: int = 0, deprecation_type: type[Warning] = DeprecationWarning) Callable[[Callable[P, T]], Callable[P, T]]#
用于函数、方法和类的弃用装饰器。
- 参数:
deprecate_in -- 代码将被标记为已弃用的版本。
remove_in -- 预计代码将被移除的版本。
addendum -- 可选的附加消息。用于指示应该怎么做。
stack -- 可选的堆栈层级增量。
- argument(deprecate_in: str, remove_in: str, argument: str, *, rename: str | None = None, addendum: str | None = None, stack: int = 0, deprecation_type: type[Warning] = DeprecationWarning) Callable[[Callable[P, T]], Callable[P, T]]#
用于关键字参数的弃用装饰器。
- 参数:
deprecate_in -- 代码将被标记为已弃用的版本。
remove_in -- 预计代码将被移除的版本。
argument -- 要弃用的参数。
rename -- 可选的新参数名称。
addendum -- 可选的附加消息。用于指示应该怎么做。
stack -- 可选的堆栈层级增量。
- action(deprecate_in: str, remove_in: str, action: ActionType, *, addendum: str | None = None, stack: int = 0, deprecation_type: type[Warning] = FutureWarning) ActionType#
包装任何 argparse.Action 以发出弃用警告。
- module(deprecate_in: str, remove_in: str, *, addendum: str | None = None, stack: int = 0) None#
用于模块的弃用函数。
- 参数:
deprecate_in -- 代码将被标记为已弃用的版本。
remove_in -- 预计代码将被移除的版本。
addendum -- 可选的附加消息。用于指示应该怎么做。
stack -- 可选的堆栈层级增量。
- constant(deprecate_in: str, remove_in: str, constant: str, value: Any, *, addendum: str | None = None, stack: int = 0, deprecation_type: type[Warning] = DeprecationWarning) None#
用于模块常量/全局变量的弃用函数。
- 参数:
deprecate_in -- 代码将被标记为已弃用的版本。
remove_in -- 预计代码将被移除的版本。
constant (常量)
value (值)
addendum -- 可选的附加消息。用于指示应该怎么做。
stack -- 可选的堆栈层级增量。
- topic(deprecate_in: str, remove_in: str, *, topic: str, addendum: str | None = None, stack: int = 0, deprecation_type: type[Warning] = DeprecationWarning) None#
主题的弃用函数。
- 参数:
deprecate_in -- 代码将被标记为已弃用的版本。
remove_in -- 预计代码将被移除的版本。
topic -- 要弃用的主题。
addendum -- 可选的附加消息。用于指示应该怎么做。
stack -- 可选的堆栈层级增量。
- _get_module(stack: int) tuple[types.ModuleType, str]#
检测调用方的模块。
- 参数:
stack -- 堆栈层级增量。
- 返回:
模块和模块名称。
- _generate_message(deprecate_in: str, remove_in: str, prefix: str, addendum: str | None, *, deprecation_type: type[Warning]) tuple[type[Warning] | None, str]#
生成标准化的弃用消息，并确定弃用是待定的、激活的还是过去的。
- 参数:
deprecate_in -- 代码将被标记为已弃用的版本。
remove_in -- 预计代码将被移除的版本。
prefix -- 消息前缀，通常是函数名称。
addendum -- 附加消息。用于指示替代方案。
deprecation_type -- 用于激活弃用的警告类型。
- 返回:
警告类别（如果适用）和消息。
- deprecated#