summaryrefslogtreecommitdiff
path: root/sphinx/util
diff options
context:
space:
mode:
authorAdam Turner <9087854+aa-turner@users.noreply.github.com>2022-12-30 20:14:18 +0000
committerAdam Turner <9087854+aa-turner@users.noreply.github.com>2023-01-01 20:48:37 +0000
commitf4c8a0a68e0013808d169357c9f77ebdf19d0f4e (patch)
treef952fa0106f7b93db5b5a21b801f12566f2ebaee /sphinx/util
parent0b1efd7756e05b238c28c62e3946a222cacbd229 (diff)
downloadsphinx-git-f4c8a0a68e0013808d169357c9f77ebdf19d0f4e.tar.gz
Insert ``from __future__ import annotations``
Diffstat (limited to 'sphinx/util')
-rw-r--r--sphinx/util/__init__.py2
-rw-r--r--sphinx/util/cfamily.py2
-rw-r--r--sphinx/util/console.py2
-rw-r--r--sphinx/util/docfields.py2
-rw-r--r--sphinx/util/docstrings.py2
-rw-r--r--sphinx/util/docutils.py2
-rw-r--r--sphinx/util/fileutil.py2
-rw-r--r--sphinx/util/i18n.py2
-rw-r--r--sphinx/util/images.py2
-rw-r--r--sphinx/util/inspect.py2
-rw-r--r--sphinx/util/inventory.py2
-rw-r--r--sphinx/util/jsdump.py2
-rw-r--r--sphinx/util/logging.py2
-rw-r--r--sphinx/util/matching.py2
-rw-r--r--sphinx/util/math.py2
-rw-r--r--sphinx/util/nodes.py5
-rw-r--r--sphinx/util/osutil.py2
-rw-r--r--sphinx/util/parallel.py2
-rw-r--r--sphinx/util/png.py2
-rw-r--r--sphinx/util/requests.py2
-rw-r--r--sphinx/util/rst.py2
-rw-r--r--sphinx/util/tags.py2
-rw-r--r--sphinx/util/template.py2
-rw-r--r--sphinx/util/texescape.py2
-rw-r--r--sphinx/util/typing.py2
25 files changed, 52 insertions, 1 deletions
diff --git a/sphinx/util/__init__.py b/sphinx/util/__init__.py
index c28e76091..313b32211 100644
--- a/sphinx/util/__init__.py
+++ b/sphinx/util/__init__.py
@@ -1,5 +1,7 @@
"""Utility functions for Sphinx."""
+from __future__ import annotations
+
import functools
import hashlib
import os
diff --git a/sphinx/util/cfamily.py b/sphinx/util/cfamily.py
index 21ac9b79f..15122955b 100644
--- a/sphinx/util/cfamily.py
+++ b/sphinx/util/cfamily.py
@@ -1,5 +1,7 @@
"""Utility functions common to the C and C++ domains."""
+from __future__ import annotations
+
import re
from copy import deepcopy
from typing import Any, Callable, List, Match, Optional, Pattern, Tuple, Union
diff --git a/sphinx/util/console.py b/sphinx/util/console.py
index 304f5d4a1..d4c6ff44f 100644
--- a/sphinx/util/console.py
+++ b/sphinx/util/console.py
@@ -1,5 +1,7 @@
"""Format colored console output."""
+from __future__ import annotations
+
import os
import re
import shutil
diff --git a/sphinx/util/docfields.py b/sphinx/util/docfields.py
index 7a2f802c5..ec49774f1 100644
--- a/sphinx/util/docfields.py
+++ b/sphinx/util/docfields.py
@@ -3,6 +3,8 @@
"Doc fields" are reST field lists in object descriptions that will
be domain-specifically transformed to a more appealing presentation.
"""
+from __future__ import annotations
+
from typing import TYPE_CHECKING, Any, Dict, List, Tuple, Type, Union, cast
from docutils import nodes
diff --git a/sphinx/util/docstrings.py b/sphinx/util/docstrings.py
index eb3acefd4..8efd71bb6 100644
--- a/sphinx/util/docstrings.py
+++ b/sphinx/util/docstrings.py
@@ -1,5 +1,7 @@
"""Utilities for docstring processing."""
+from __future__ import annotations
+
import re
import sys
from typing import Dict, List, Tuple
diff --git a/sphinx/util/docutils.py b/sphinx/util/docutils.py
index e45cf0db9..e80066845 100644
--- a/sphinx/util/docutils.py
+++ b/sphinx/util/docutils.py
@@ -1,5 +1,7 @@
"""Utility functions for docutils."""
+from __future__ import annotations
+
import os
import re
import warnings
diff --git a/sphinx/util/fileutil.py b/sphinx/util/fileutil.py
index e4f24f239..a4bf3d94f 100644
--- a/sphinx/util/fileutil.py
+++ b/sphinx/util/fileutil.py
@@ -1,5 +1,7 @@
"""File utility functions for Sphinx."""
+from __future__ import annotations
+
import os
import posixpath
from typing import TYPE_CHECKING, Callable, Dict, Optional
diff --git a/sphinx/util/i18n.py b/sphinx/util/i18n.py
index 6915d3091..23ba31e7c 100644
--- a/sphinx/util/i18n.py
+++ b/sphinx/util/i18n.py
@@ -1,5 +1,7 @@
"""Builder superclass for all builders."""
+from __future__ import annotations
+
import os
import re
import warnings
diff --git a/sphinx/util/images.py b/sphinx/util/images.py
index 2e13957f6..656f2e5bf 100644
--- a/sphinx/util/images.py
+++ b/sphinx/util/images.py
@@ -1,5 +1,7 @@
"""Image utility functions for Sphinx."""
+from __future__ import annotations
+
import base64
import imghdr
from collections import OrderedDict
diff --git a/sphinx/util/inspect.py b/sphinx/util/inspect.py
index accbb2388..7544f109b 100644
--- a/sphinx/util/inspect.py
+++ b/sphinx/util/inspect.py
@@ -1,5 +1,7 @@
"""Helpers for inspecting Python modules."""
+from __future__ import annotations
+
import ast
import builtins
import contextlib
diff --git a/sphinx/util/inventory.py b/sphinx/util/inventory.py
index 7827aec74..91369f559 100644
--- a/sphinx/util/inventory.py
+++ b/sphinx/util/inventory.py
@@ -1,4 +1,6 @@
"""Inventory utility functions for Sphinx."""
+from __future__ import annotations
+
import os
import re
import zlib
diff --git a/sphinx/util/jsdump.py b/sphinx/util/jsdump.py
index 17a3c6528..0cd59c383 100644
--- a/sphinx/util/jsdump.py
+++ b/sphinx/util/jsdump.py
@@ -3,6 +3,8 @@
Uses the basestring encode function from simplejson by Bob Ippolito.
"""
+from __future__ import annotations
+
import re
import warnings
from typing import IO, Any, Dict, List, Match, Union
diff --git a/sphinx/util/logging.py b/sphinx/util/logging.py
index 6f8b7096d..5c84755c7 100644
--- a/sphinx/util/logging.py
+++ b/sphinx/util/logging.py
@@ -1,5 +1,7 @@
"""Logging utility functions for Sphinx."""
+from __future__ import annotations
+
import logging
import logging.handlers
from collections import defaultdict
diff --git a/sphinx/util/matching.py b/sphinx/util/matching.py
index ffea2d6f3..45b49f67b 100644
--- a/sphinx/util/matching.py
+++ b/sphinx/util/matching.py
@@ -1,5 +1,7 @@
"""Pattern-matching utility functions for Sphinx."""
+from __future__ import annotations
+
import os.path
import re
from typing import Callable, Dict, Iterable, Iterator, List, Match, Optional, Pattern
diff --git a/sphinx/util/math.py b/sphinx/util/math.py
index 121c606c5..bac197d7a 100644
--- a/sphinx/util/math.py
+++ b/sphinx/util/math.py
@@ -1,5 +1,7 @@
"""Utility functions for math."""
+from __future__ import annotations
+
from typing import Optional
from docutils import nodes
diff --git a/sphinx/util/nodes.py b/sphinx/util/nodes.py
index 9494b61de..4f1c2dac7 100644
--- a/sphinx/util/nodes.py
+++ b/sphinx/util/nodes.py
@@ -1,5 +1,7 @@
"""Docutils node-related utility functions for Sphinx."""
+from __future__ import annotations
+
import re
import unicodedata
from typing import (TYPE_CHECKING, Any, Callable, Iterable, List, Optional, Set, Tuple, Type,
@@ -45,7 +47,8 @@ class NodeMatcher:
A special value ``typing.Any`` matches any kind of node-attributes. For example,
following example searches ``reference`` node having ``refdomain`` attributes::
- from typing import Any
+ from __future__ import annotations
+from typing import Any
matcher = NodeMatcher(nodes.reference, refdomain=Any)
doctree.findall(matcher)
# => [<reference ...>, <reference ...>, ...]
diff --git a/sphinx/util/osutil.py b/sphinx/util/osutil.py
index e8d47c5c7..485b65e88 100644
--- a/sphinx/util/osutil.py
+++ b/sphinx/util/osutil.py
@@ -1,5 +1,7 @@
"""Operating system-related utility functions for Sphinx."""
+from __future__ import annotations
+
import contextlib
import filecmp
import os
diff --git a/sphinx/util/parallel.py b/sphinx/util/parallel.py
index 201e5b5e2..a37b85346 100644
--- a/sphinx/util/parallel.py
+++ b/sphinx/util/parallel.py
@@ -1,5 +1,7 @@
"""Parallel building utilities."""
+from __future__ import annotations
+
import os
import time
import traceback
diff --git a/sphinx/util/png.py b/sphinx/util/png.py
index cb7ee8be4..d2718da18 100644
--- a/sphinx/util/png.py
+++ b/sphinx/util/png.py
@@ -1,5 +1,7 @@
"""PNG image manipulation helpers."""
+from __future__ import annotations
+
import binascii
import struct
from typing import Optional
diff --git a/sphinx/util/requests.py b/sphinx/util/requests.py
index 0f52d61ef..0b1058b88 100644
--- a/sphinx/util/requests.py
+++ b/sphinx/util/requests.py
@@ -1,5 +1,7 @@
"""Simple requests package loader"""
+from __future__ import annotations
+
import sys
import warnings
from contextlib import contextmanager
diff --git a/sphinx/util/rst.py b/sphinx/util/rst.py
index 800d15f5b..ddcef6f6d 100644
--- a/sphinx/util/rst.py
+++ b/sphinx/util/rst.py
@@ -1,5 +1,7 @@
"""reST helper functions."""
+from __future__ import annotations
+
import re
from collections import defaultdict
from contextlib import contextmanager
diff --git a/sphinx/util/tags.py b/sphinx/util/tags.py
index ac69ae852..422307952 100644
--- a/sphinx/util/tags.py
+++ b/sphinx/util/tags.py
@@ -1,3 +1,5 @@
+from __future__ import annotations
+
from typing import Iterator, List, Optional
from jinja2 import nodes
diff --git a/sphinx/util/template.py b/sphinx/util/template.py
index 23c68e36b..d38af78d8 100644
--- a/sphinx/util/template.py
+++ b/sphinx/util/template.py
@@ -1,5 +1,7 @@
"""Templates utility functions for Sphinx."""
+from __future__ import annotations
+
import os
from functools import partial
from os import path
diff --git a/sphinx/util/texescape.py b/sphinx/util/texescape.py
index ba885f695..2952c4388 100644
--- a/sphinx/util/texescape.py
+++ b/sphinx/util/texescape.py
@@ -1,5 +1,7 @@
"""TeX escaping helper."""
+from __future__ import annotations
+
import re
from typing import Dict, Optional
diff --git a/sphinx/util/typing.py b/sphinx/util/typing.py
index 8ad451f03..17bbdd152 100644
--- a/sphinx/util/typing.py
+++ b/sphinx/util/typing.py
@@ -1,5 +1,7 @@
"""The composite types for Sphinx."""
+from __future__ import annotations
+
import sys
import typing
from struct import Struct