You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
98 lines
3.0 KiB
98 lines
3.0 KiB
4 years ago
|
"""
|
||
|
|
sphinx.deprecation
|
||
|
|
~~~~~~~~~~~~~~~~~~
|
||
|
|
|
||
|
|
Sphinx deprecation classes and utilities.
|
||
|
|
|
||
|
|
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
|
||
|
|
:license: BSD, see LICENSE for details.
|
||
|
|
"""
|
||
|
|
|
||
|
|
import sys
|
||
|
|
import warnings
|
||
|
|
from importlib import import_module
|
||
|
|
from typing import Any, Dict
|
||
|
|
|
||
|
|
if False:
|
||
|
|
# For type annotation
|
||
|
|
from typing import Type # for python3.5.1
|
||
|
|
|
||
|
|
|
||
|
|
class RemovedInSphinx40Warning(DeprecationWarning):
|
||
|
|
pass
|
||
|
|
|
||
|
|
|
||
|
|
class RemovedInSphinx50Warning(PendingDeprecationWarning):
|
||
|
|
pass
|
||
|
|
|
||
|
|
|
||
|
|
class RemovedInSphinx60Warning(PendingDeprecationWarning):
|
||
|
|
pass
|
||
|
|
|
||
|
|
|
||
|
|
RemovedInNextVersionWarning = RemovedInSphinx40Warning
|
||
|
|
|
||
|
|
|
||
|
|
def deprecated_alias(modname: str, objects: Dict[str, object],
|
||
|
|
warning: "Type[Warning]", names: Dict[str, str] = None) -> None:
|
||
|
|
module = import_module(modname)
|
||
|
|
sys.modules[modname] = _ModuleWrapper( # type: ignore
|
||
|
|
module, modname, objects, warning, names)
|
||
|
|
|
||
|
|
|
||
|
|
class _ModuleWrapper:
|
||
|
|
def __init__(self, module: Any, modname: str,
|
||
|
|
objects: Dict[str, object],
|
||
|
|
warning: "Type[Warning]",
|
||
|
|
names: Dict[str, str]) -> None:
|
||
|
|
self._module = module
|
||
|
|
self._modname = modname
|
||
|
|
self._objects = objects
|
||
|
|
self._warning = warning
|
||
|
|
self._names = names
|
||
|
|
|
||
|
|
def __getattr__(self, name: str) -> Any:
|
||
|
|
if name not in self._objects:
|
||
|
|
return getattr(self._module, name)
|
||
|
|
|
||
|
|
canonical_name = self._names.get(name, None)
|
||
|
|
if canonical_name is not None:
|
||
|
|
warnings.warn(
|
||
|
|
"The alias '{}.{}' is deprecated, use '{}' instead. Check CHANGES for "
|
||
|
|
"Sphinx API modifications.".format(self._modname, name, canonical_name),
|
||
|
|
self._warning, stacklevel=3)
|
||
|
|
else:
|
||
|
|
warnings.warn("{}.{} is deprecated. Check CHANGES for Sphinx "
|
||
|
|
"API modifications.".format(self._modname, name),
|
||
|
|
self._warning, stacklevel=3)
|
||
|
|
return self._objects[name]
|
||
|
|
|
||
|
|
|
||
|
|
class DeprecatedDict(dict):
|
||
|
|
"""A deprecated dict which warns on each access."""
|
||
|
|
|
||
|
|
def __init__(self, data: Dict, message: str, warning: "Type[Warning]") -> None:
|
||
|
|
self.message = message
|
||
|
|
self.warning = warning
|
||
|
|
super().__init__(data)
|
||
|
|
|
||
|
|
def __setitem__(self, key: str, value: Any) -> None:
|
||
|
|
warnings.warn(self.message, self.warning, stacklevel=2)
|
||
|
|
super().__setitem__(key, value)
|
||
|
|
|
||
|
|
def setdefault(self, key: str, default: Any = None) -> Any:
|
||
|
|
warnings.warn(self.message, self.warning, stacklevel=2)
|
||
|
|
return super().setdefault(key, default)
|
||
|
|
|
||
|
|
def __getitem__(self, key: str) -> None:
|
||
|
|
warnings.warn(self.message, self.warning, stacklevel=2)
|
||
|
|
return super().__getitem__(key)
|
||
|
|
|
||
|
|
def get(self, key: str, default: Any = None) -> Any:
|
||
|
|
warnings.warn(self.message, self.warning, stacklevel=2)
|
||
|
|
return super().get(key, default)
|
||
|
|
|
||
|
|
def update(self, other: Dict) -> None: # type: ignore
|
||
|
|
warnings.warn(self.message, self.warning, stacklevel=2)
|
||
|
|
super().update(other)
|