summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Bell <peterbell10@live.co.uk>2020-07-15 17:28:34 +0100
committerPeter Bell <peterbell10@live.co.uk>2020-07-15 17:28:34 +0100
commitea0fbd21d5e0c498cf13e338a1ed3dd64d15d4f3 (patch)
treedb6f38fb18298c86536f4b26886a247d87650aaf
parentbedc00faa6c1c35ab11673734c462d9652651da5 (diff)
downloadsphinx-git-ea0fbd21d5e0c498cf13e338a1ed3dd64d15d4f3.tar.gz
Add type check to aliases dict
-rw-r--r--sphinx/deprecation.py4
1 files changed, 4 insertions, 0 deletions
diff --git a/sphinx/deprecation.py b/sphinx/deprecation.py
index 9d67de9ca..5baac8cf5 100644
--- a/sphinx/deprecation.py
+++ b/sphinx/deprecation.py
@@ -40,6 +40,10 @@ class _ModuleWrapperDeprecatedAlias:
def __init__(self, module: Any, modname: str,
aliases: Dict[str, Tuple[str, object]],
warning: "Type[Warning]") -> None:
+ if not all(isinstance(v, tuple) for v in aliases.values()):
+ raise TypeError('deprecated_alias expects aliases to be a dict mapping: '
+ 'name -> tuple[canonical name, object]')
+
self._module = module
self._modname = modname
self._aliases = aliases