Adjust to Python 3.9+ syntax.

Author: felixfontein

src/antsibull_docs_parser/__init__.py

@@ -7,6 +7,8 @@
 Library for processing Ansible documentation markup.
 """
 
+from __future__ import annotations
+
 __version__ = "1.1.1.post0"
 
 __all__ = ("__version__",)

src/antsibull_docs_parser/_parser_impl.py

@@ -7,8 +7,9 @@
 Internal parsing code.
 """
 
+from __future__ import annotations
+
 import re
-import typing as t
 
 _ESCAPE_OR_COMMA = re.compile(r"\\(.)| *(,) *")
 _ESCAPE_OR_CLOSING = re.compile(r"\\(.)|([)])")
@@ -19,12 +20,12 @@ def parse_parameters_escaped(
     index: int,
     parameter_count: int,
     strict: bool,
-) -> t.Tuple[t.List[str], int, t.Optional[str]]:
-    result: t.List[str] = []
+) -> tuple[list[str], int, str | None]:
+    result: list[str] = []
     parameters_left = parameter_count
     while parameters_left > 1:
         parameters_left -= 1
-        value: t.List[str] = []
+        value: list[str] = []
         while True:
             match = _ESCAPE_OR_COMMA.search(text, pos=index)
             if not match:
@@ -77,8 +78,8 @@ def parse_parameters_unescaped(
     index: int,
     parameter_count: int,
     strict: bool,  # pylint: disable=unused-argument
-) -> t.Tuple[t.List[str], int, t.Optional[str]]:
-    result: t.List[str] = []
+) -> tuple[list[str], int, str | None]:
+    result: list[str] = []
     first = True
     parameters_left = parameter_count
     while parameters_left > 1:

src/antsibull_docs_parser/ansible_doc_text.py

@@ -7,6 +7,8 @@
 Ansible-doc text serialization.
 """
 
+from __future__ import annotations
+
 import typing as t
 
 from . import dom
@@ -17,7 +19,7 @@
 class AnsibleDocTextFormatter(Formatter):
     @staticmethod
     def _format_option_like(
-        part: t.Union[dom.OptionNamePart, dom.ReturnValuePart],
+        part: dom.OptionNamePart | dom.ReturnValuePart,
     ) -> str:
         value = part.value
         if value is None:
@@ -54,7 +56,7 @@ def format_italic(self, part: dom.ItalicPart) -> str:
     def format_link(self, part: dom.LinkPart) -> str:
         return f"{part.text} <{part.url}>"
 
-    def format_module(self, part: dom.ModulePart, url: t.Optional[str]) -> str:
+    def format_module(self, part: dom.ModulePart, url: str | None) -> str:
         return f"[{part.fqcn}]"
 
     def format_rst_ref(self, part: dom.RSTRefPart) -> str:
@@ -69,18 +71,16 @@ def format_text(self, part: dom.TextPart) -> str:
     def format_env_variable(self, part: dom.EnvVariablePart) -> str:
         return f"`{part.name}'"
 
-    def format_option_name(self, part: dom.OptionNamePart, url: t.Optional[str]) -> str:
+    def format_option_name(self, part: dom.OptionNamePart, url: str | None) -> str:
         return self._format_option_like(part)
 
     def format_option_value(self, part: dom.OptionValuePart) -> str:
         return f"`{part.value}'"
 
-    def format_plugin(self, part: dom.PluginPart, url: t.Optional[str]) -> str:
+    def format_plugin(self, part: dom.PluginPart, url: str | None) -> str:
         return f"[{part.plugin.fqcn}]"
 
-    def format_return_value(
-        self, part: dom.ReturnValuePart, url: t.Optional[str]
-    ) -> str:
+    def format_return_value(self, part: dom.ReturnValuePart, url: str | None) -> str:
         return self._format_option_like(part)
 
 
@@ -90,12 +90,12 @@ def format_return_value(
 def to_ansible_doc_text(
     paragraphs: t.Sequence[dom.Paragraph],
     formatter: Formatter = DEFAULT_ANSIBLE_DOC_FORMATTER,
-    link_provider: t.Optional[LinkProvider] = None,
+    link_provider: LinkProvider | None = None,
     par_start: str = "",
     par_end: str = "",
     par_sep: str = "\n\n",
     par_empty: str = "",
-    current_plugin: t.Optional[dom.PluginIdentifier] = None,
+    current_plugin: dom.PluginIdentifier | None = None,
 ) -> str:
     return _format_paragraphs(
         paragraphs,

src/antsibull_docs_parser/dom.py

@@ -7,19 +7,14 @@
 DOM classes used by parser.
 """
 
+from __future__ import annotations
+
 import abc
-import sys
 import typing as t
 from enum import Enum
 from typing import NamedTuple
 
-if sys.version_info >= (3, 8):
-    ErrorType = t.Union[
-        t.Literal["ignore"], t.Literal["message"], t.Literal["exception"]
-    ]
-else:
-    # Python 3.6/3.7 do not have t.Literal
-    ErrorType = str  # pragma: no cover
+ErrorType = t.Literal["ignore"] | t.Literal["message"] | t.Literal["exception"]
 
 
 class PluginIdentifier(NamedTuple):
@@ -47,123 +42,123 @@ class PartType(Enum):
 
 class TextPart(NamedTuple):
     text: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.TEXT]" = PartType.TEXT
+    source: str | None = None
+    type: t.Literal[PartType.TEXT] = PartType.TEXT
 
 
 class ItalicPart(NamedTuple):
     text: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.ITALIC]" = PartType.ITALIC
+    source: str | None = None
+    type: t.Literal[PartType.ITALIC] = PartType.ITALIC
 
 
 class BoldPart(NamedTuple):
     text: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.BOLD]" = PartType.BOLD
+    source: str | None = None
+    type: t.Literal[PartType.BOLD] = PartType.BOLD
 
 
 class ModulePart(NamedTuple):
     fqcn: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.MODULE]" = PartType.MODULE
+    source: str | None = None
+    type: t.Literal[PartType.MODULE] = PartType.MODULE
 
 
 class PluginPart(NamedTuple):
     plugin: PluginIdentifier
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.PLUGIN]" = PartType.PLUGIN
+    source: str | None = None
+    type: t.Literal[PartType.PLUGIN] = PartType.PLUGIN
 
 
 class URLPart(NamedTuple):
     url: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.URL]" = PartType.URL
+    source: str | None = None
+    type: t.Literal[PartType.URL] = PartType.URL
 
 
 class LinkPart(NamedTuple):
     text: str
     url: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.LINK]" = PartType.LINK
+    source: str | None = None
+    type: t.Literal[PartType.LINK] = PartType.LINK
 
 
 class RSTRefPart(NamedTuple):
     text: str
     ref: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.RST_REF]" = PartType.RST_REF
+    source: str | None = None
+    type: t.Literal[PartType.RST_REF] = PartType.RST_REF
 
 
 class CodePart(NamedTuple):
     text: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.CODE]" = PartType.CODE
+    source: str | None = None
+    type: t.Literal[PartType.CODE] = PartType.CODE
 
 
 class OptionNamePart(NamedTuple):
-    plugin: t.Optional[PluginIdentifier]
-    entrypoint: t.Optional[str]  # present iff plugin.type == 'role'
-    link: t.List[str]
+    plugin: PluginIdentifier | None
+    entrypoint: str | None  # present iff plugin.type == 'role'
+    link: list[str]
     name: str
-    value: t.Optional[str]
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.OPTION_NAME]" = PartType.OPTION_NAME
+    value: str | None
+    source: str | None = None
+    type: t.Literal[PartType.OPTION_NAME] = PartType.OPTION_NAME
 
 
 class OptionValuePart(NamedTuple):
     value: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.OPTION_VALUE]" = PartType.OPTION_VALUE
+    source: str | None = None
+    type: t.Literal[PartType.OPTION_VALUE] = PartType.OPTION_VALUE
 
 
 class EnvVariablePart(NamedTuple):
     name: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.ENV_VARIABLE]" = PartType.ENV_VARIABLE
+    source: str | None = None
+    type: t.Literal[PartType.ENV_VARIABLE] = PartType.ENV_VARIABLE
 
 
 class ReturnValuePart(NamedTuple):
-    plugin: t.Optional[PluginIdentifier]
-    entrypoint: t.Optional[str]  # present iff plugin.type == 'role'
-    link: t.List[str]
+    plugin: PluginIdentifier | None
+    entrypoint: str | None  # present iff plugin.type == 'role'
+    link: list[str]
     name: str
-    value: t.Optional[str]
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.RETURN_VALUE]" = PartType.RETURN_VALUE
+    value: str | None
+    source: str | None = None
+    type: t.Literal[PartType.RETURN_VALUE] = PartType.RETURN_VALUE
 
 
 class HorizontalLinePart(NamedTuple):
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.HORIZONTAL_LINE]" = PartType.HORIZONTAL_LINE
+    source: str | None = None
+    type: t.Literal[PartType.HORIZONTAL_LINE] = PartType.HORIZONTAL_LINE
 
 
 class ErrorPart(NamedTuple):
     message: str
-    source: t.Optional[str] = None
-    type: "t.Literal[PartType.ERROR]" = PartType.ERROR
-
-
-AnyPart = t.Union[
-    TextPart,
-    ItalicPart,
-    BoldPart,
-    ModulePart,
-    PluginPart,
-    URLPart,
-    LinkPart,
-    RSTRefPart,
-    CodePart,
-    OptionNamePart,
-    OptionValuePart,
-    EnvVariablePart,
-    ReturnValuePart,
-    HorizontalLinePart,
-    ErrorPart,
-]
-
-
-Paragraph = t.List[AnyPart]
+    source: str | None = None
+    type: t.Literal[PartType.ERROR] = PartType.ERROR
+
+
+AnyPart = (
+    TextPart
+    | ItalicPart
+    | BoldPart
+    | ModulePart
+    | PluginPart
+    | URLPart
+    | LinkPart
+    | RSTRefPart
+    | CodePart
+    | OptionNamePart
+    | OptionValuePart
+    | EnvVariablePart
+    | ReturnValuePart
+    | HorizontalLinePart
+    | ErrorPart
+)
+
+
+Paragraph = list[AnyPart]
 
 
 class Walker(abc.ABC):