rewrite library type annotations and converters to use/support UnionType '|' symbol

Author: Mega-JC

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [tool.black]
 line-length = 88
-target_version = ['py39', 'py310']
+target_version = ['py310']
 include = '\.pyi?$'
 exclude = '''
 
@@ -38,7 +38,7 @@ include = [
 exclude = [
     "**/__pycache__"
 ]
-pythonVersion = "3.9"
+pythonVersion = "3.10"
 
 [tool.pytest.ini_options]
 asyncio_mode = "strict"

snakecore/__init__.py

@@ -30,7 +30,7 @@
 
 
 async def init(
-    global_client: Optional[discord.Client] = None,
+    global_client: discord.Client | None = None,
     *,
     raise_module_exceptions: bool = False,
 ) -> tuple[int, int]:
@@ -47,7 +47,7 @@ async def init(
 
     Parameters
     ----------
-    global_client : Optional[discord.Client], optional
+    global_client : discord.Client | None, optional
         The global `discord.Client` object to set for all modules to use.
         By default None.
     raise_module_exceptions : bool, optional
@@ -77,7 +77,7 @@ async def init(
 
 
 def init_sync(
-    global_client: Optional[discord.Client] = None,
+    global_client: discord.Client | None = None,
     *,
     raise_module_exceptions: bool = False,
 ) -> tuple[int, int]:
@@ -88,7 +88,7 @@ def init_sync(
 
     Parameters
     ----------
-    global_client : Optional[discord.Client], optional
+    global_client : discord.Client | None, optional
         The global `discord.Client` object to set for all modules to use.
         Defaults to None.
     raise_module_exceptions : bool, optional
@@ -134,7 +134,7 @@ def init_sync(
 
 
 async def init_async(
-    global_client: Optional[discord.Client] = None,
+    global_client: discord.Client | None = None,
     *,
     raise_module_exceptions: bool = False,
 ):
@@ -145,7 +145,7 @@ async def init_async(
 
     Parameters
     ----------
-    global_client : Optional[discord.Client], optional
+    global_client : discord.Client | None, optional
         The global `discord.Client` object to set for all modules to use.
         Defaults to None.
     raise_module_exceptions : bool, optional

snakecore/commands/__init__.py

@@ -14,12 +14,12 @@
 from .bot import *
 
 
-def init(global_client: Optional[discord.Client] = None) -> None:
+def init(global_client: discord.Client | None = None) -> None:
     """Initialize this module.
 
     Parameters
     ----------
-    global_client : Optional[discord.Client], optional
+    global_client : discord.Client | None, optional
         The global `discord.Client` object to set for all submodules to use.
         Defaults to None.
     """

snakecore/commands/bot.py

@@ -99,7 +99,7 @@ def delete_extension_config(self, qualified_name: str):
 
     def get_extension_config(
         self, qualified_name: str, default: Any = UNSET, /
-    ) -> Union[Mapping[str, Any], Any]:
+    ) -> Mapping[str, Any] | Any:
         """Get the configuration mapping that an extension should be loaded with, under
         the given qualified name.
 
@@ -118,7 +118,7 @@ def get_extension_config(
 
         Returns
         -------
-        Union[Mapping[str, Any], Any]
+        Mapping[str, Any] | Any
             The mapping or a default value.
         """
         config = self._extension_configs.get(qualified_name, None)
@@ -137,8 +137,8 @@ async def load_extension_with_config(
         self,
         name: str,
         *,
-        package: Optional[str] = None,
-        config: Optional[Mapping[str, Any]] = None,
+        package: str | None = None,
+        config: Mapping[str, Any] | None = None,
     ) -> None:
         """A shorthand for calling `set_extension_config` followed by `load_extension`."""
         name = self._resolve_name(name, package)

snakecore/commands/converters.py

@@ -41,8 +41,8 @@
 from .bot import AutoShardedBot, Bot
 
 _T = TypeVar("_T")
-BotT = Union[Bot, AutoShardedBot]
-DECBotT = Union[commands.Bot, commands.AutoShardedBot]
+BotT = Bot | AutoShardedBot
+DECBotT = commands.Bot | commands.AutoShardedBot
 
 ellipsis = type(Ellipsis)
 
@@ -432,7 +432,7 @@ class CodeBlock:
     _INLINE_PATTERN = re.compile(regex_patterns.INLINE_CODE_BLOCK)
 
     def __init__(
-        self, code: str, language: Optional[str] = None, inline: Optional[bool] = None
+        self, code: str, language: str | None = None, inline: bool | None = None
     ) -> None:
         self.code = code
         self.language = language
@@ -560,6 +560,12 @@ async def convert(self, ctx: commands.Context[DECBotT], argument: str) -> str:
     def __call__(self, *args: Any, **kwds: Any) -> Any:
         pass
 
+    def __or__(self, other):  # Add support for UnionType
+        return self.__class__.__class__.__or__(self.__class__, other)  # type: ignore
+
+    def __ror__(self, other):  # Add support for UnionType
+        return self.__class__.__class__.__ror__(self.__class__, other)  # type: ignore
+
     @staticmethod
     def escape(string: str) -> str:
         """Convert a "raw" string to one where characters are escaped."""
@@ -629,7 +635,7 @@ def __init__(self, size: Any = None) -> None:
         super().__init__()
         self.size: tuple = (..., ...) if size is None else size
 
-    def __class_getitem__(cls, size: Union[StringParams, StringParamsTuple]) -> Self:
+    def __class_getitem__(cls, size: StringParams | StringParamsTuple) -> Self:
         size_tuple = (..., ...)
 
         if getattr(size, "__origin__", None) is Literal:
@@ -775,7 +781,7 @@ def __init__(self, regex: str, examples: tuple[str, ...]) -> None:
         self.regex_pattern = re.compile(regex)
         self.examples = examples
 
-    def __class_getitem__(cls, regex_and_examples: Union[str, tuple[str, ...]]) -> Self:
+    def __class_getitem__(cls, regex_and_examples: str | tuple[str, ...]) -> Self:
         regex = None
         examples = ()
         if isinstance(regex_and_examples, tuple) and regex_and_examples:
@@ -891,7 +897,7 @@ def __class_getitem__(cls, params: Any) -> Self:
 
             args = getattr(converter, "__args__", ())
             if sys.version_info >= (3, 10) and converter.__class__ is types.UnionType:  # type: ignore
-                converter = Union[args]  # type: ignore
+                converter = args  # type: ignore
 
             origin = getattr(converter, "__origin__", None)
 
@@ -1138,10 +1144,10 @@ async def convert(
                 ctx.command
                 and getattr(fake_parameter.annotation, "__origin__", None) is Union
                 and type(None)
-                in fake_parameter.annotation.__args__  # check for Optional[...]  # type: ignore
+                in fake_parameter.annotation.__args__  # check for ... | None  # type: ignore
                 and transformed is None
             ):
-                view.index = previous_index  # view.undo() does not revert properly for Optional[...]
+                view.index = previous_index  # view.undo() does not revert properly for ... | None
                 view.previous = previous_previous
 
         ctx.current_parameter = original_parameter
@@ -1150,6 +1156,12 @@ async def convert(
     def __call__(self, *args: Any, **kwds: Any) -> Any:
         pass
 
+    def __or__(self, other):  # Add support for UnionType
+        return self.__class__.__class__.__or__(self.__class__, other)  # type: ignore
+
+    def __ror__(self, other):  # Add support for UnionType
+        return self.__class__.__class__.__ror__(self.__class__, other)  # type: ignore
+
     def __repr__(self) -> str:
         return f"{self.__class__.__name__}[{', '.join(self._repr_converter(conv) for conv in self.converters)}]"
 
@@ -1296,7 +1308,7 @@ class String(str):  # type: ignore
         - `'"ab\\"c"'` -> `'ab"c'`
         """
 
-        def __class_getitem__(cls, size: Union[StringParams, StringParamsTuple]):
+        def __class_getitem__(cls, size: StringParams | StringParamsTuple):
             ...
 
     class StringExpr(str):  # type: ignore
@@ -1312,15 +1324,15 @@ class StringExpr(str):  # type: ignore
         - `'"ab\\"c"'` -> `'ab"c'`
         """
 
-        def __class_getitem__(cls, regex_and_examples: Union[str, tuple[str, ...]]):
+        def __class_getitem__(cls, regex_and_examples: str | tuple[str, ...]):
             ...
 
     class StringExprMatch(re.Match):  # type: ignore
         """A subclass of the `StringExpr` converter, that converts inputs into
         `re.Match` objects instead of strings.
         """
 
-        def __class_getitem__(cls, regex_and_examples: Union[str, tuple[str, ...]]):
+        def __class_getitem__(cls, regex_and_examples: str | tuple[str, ...]):
             ...
 
 else:
@@ -1420,8 +1432,8 @@ async def convert_flag(
             annotation = annotation.__args__[0]
             return await convert_flag(ctx, argument, flag, annotation)
         elif origin is Union and type(None) in annotation.__args__:
-            # typing.Optional[x]
-            annotation = Union[tuple(arg for arg in annotation.__args__ if arg is not type(None))]  # type: ignore
+            # typing.x | None
+            annotation = tuple(arg for arg in annotation.__args__ if arg is not type(None))  # type: ignore
             return await commands.run_converters(ctx, annotation, argument, param)
         elif origin is dict:
             # typing.Dict[K, V] -> typing.Tuple[K, V]

snakecore/commands/decorators.py

@@ -18,7 +18,7 @@
 from discord.ext.commands.flags import FlagsMeta, Flag
 from snakecore.commands.bot import ExtAutoShardedBot, ExtBot
 
-from snakecore.commands.converters import FlagConverter as _FlagConverter
+from snakecore.commands.converters import FlagConverter as _FlagConverter, Parens
 from snakecore.commands.parser import parse_command_str
 from ._types import AnyCommandType
 
@@ -36,7 +36,7 @@
 
 def flagconverter_kwargs(
     *,
-    prefix: Optional[str] = "",
+    prefix: str | None = "",
     delimiter: str = ":",
     cls: type[commands.FlagConverter] = _FlagConverter,
 ) -> Callable[[Callable[_P, _T]], Callable[_P, _T]]:
@@ -65,9 +65,9 @@ def flagconverter_kwargs(
 
     Parameters
     ----------
-    prefix : Optional[str], optional
+    prefix : str | None, optional
         The prefix to pass to the `FlagConverter` subclass. Defaults to `""`.
-        delimiter (Optional[str], optional): The delimiter to pass to the `FlagConverter`
+        delimiter (str | None, optional): The delimiter to pass to the `FlagConverter`
           subclass. Defaults to `":"`.
         cls (type[commands.FlagConverter], optional): The class to use as a base class for
           the resulting FlagConverter class to generate. Useful for implementing custom flag
@@ -111,14 +111,16 @@ def flagconverter_kwargs_inner_deco(func: Callable[_P, _T]) -> Callable[_P, _T]:
                         commands.Greedy,
                     ):
                         if (
-                            isinstance(evaluated_anno, UnionGenericAlias)
+                            isinstance(
+                                evaluated_anno, (UnionGenericAlias, types.UnionType)
+                            )
                             and type(None) in evaluated_anno.__args__
                             or evaluated_anno in (None, type(None), str)
                         ):
                             raise TypeError(
-                                "Cannot have None, NoneType or typing.Optional as an "
-                                f"annotation for '*{param.name}' when using "
-                                "flagconverter decorator"
+                                "Cannot have None, NoneType or typing.Optional/or "
+                                "UnionType with None as an annotation for "
+                                f"'*{param.name}' when using flagconverter decorator"
                             )
                         else:
                             new_annotation = f"commands.Greedy[{param.annotation}]"
@@ -128,14 +130,14 @@ def flagconverter_kwargs_inner_deco(func: Callable[_P, _T]) -> Callable[_P, _T]:
                     or isinstance(new_annotation, commands.Greedy)
                 ):
                     if (
-                        isinstance(new_annotation, UnionGenericAlias)
+                        isinstance(new_annotation, (UnionGenericAlias, types.UnionType))
                         and type(None) in new_annotation.__args__
                         or new_annotation in (None, type(None), str)
                     ):
                         raise TypeError(
-                            "Cannot have None, NoneType or typing.Optional as an "
-                            f"annotation for '*{param.name}' when using "
-                            "flagconverter decorator"
+                            "Cannot have None, NoneType or typing.Optional/or "
+                            "UnionType with None as an annotation for "
+                            f"'*{param.name}' when using flagconverter decorator"
                         )
                     new_annotation = commands.Greedy(converter=param.annotation)
 
@@ -339,7 +341,7 @@ def with_config_kwargs(setup: Callable[_P, Any]) -> Callable[[commands.Bot], Any
 
     Parameters
     ----------
-    func : Callable[[Union[ExtBot, ExtAutoShardedBot], ...], None]
+    func : Callable[[ExtBot | ExtAutoShardedBot, ...], None]
         The `setup()` function.
     """
 

snakecore/commands/parser.py

@@ -109,7 +109,7 @@ class CodeBlock:
     protocol and can be used as a converter.
     """
 
-    def __init__(self, text: str, lang: Optional[str] = None) -> None:
+    def __init__(self, text: str, lang: str | None = None) -> None:
         """Initialise codeblock object. The text argument here is the contents of
         the codeblock. If the optional argument lang is specified, it has to be
         the language type of the codeblock, if not provided, it is determined
@@ -244,7 +244,7 @@ def split_anno(anno: str):
 def strip_optional_anno(anno: str) -> str:
     """Helper to strip "Optional" anno"""
     anno = anno.strip()
-    if anno.startswith("Optional[") and anno.endswith("]"):
+    if anno.startswith("") and anno.endswith(" | None"):
         # call recursively to split "Optional" chains
         return strip_optional_anno(anno[9:-1])
 
@@ -254,7 +254,7 @@ def strip_optional_anno(anno: str) -> str:
 def split_union_anno(anno: str):
     """Helper to split a 'Union' annotation. Returns a generator of strings."""
     anno = strip_optional_anno(anno)
-    if anno.startswith("Union[") and anno.endswith("]"):
+    if anno.startswith("") and anno.endswith(""):
         for anno in split_anno(anno[6:-1]):
             # use recursive splits to "flatten" unions
             yield from split_union_anno(anno)
@@ -392,7 +392,7 @@ def parse_args(cmd_str: str):
     """
     args: list[Any] = []
     kwargs: dict[str, Any] = {}
-    temp_list: Optional[list[Any]] = None  # used to store the temporary tuple
+    temp_list: list[Any] | None = None  # used to store the temporary tuple
 
     kwstart = False  # used to make sure that keyword args come after args
     prevkey = None  # temporarily store previous key name
@@ -522,13 +522,13 @@ def append_arg(arg: Any):
 
 
 async def cast_basic_arg(
-    ctx: commands.Context[Union[commands.Bot, commands.AutoShardedBot]],
+    ctx: commands.Context[commands.Bot | commands.AutoShardedBot],
     anno: str,
     arg: Any,
 ) -> Any:
     """Helper to cast an argument to the type mentioned by the parameter
     annotation. This casts an argument in its "basic" form, where both argument
-    and typehint are "simple", that does not contain stuff like Union[...],
+    and typehint are "simple", that does not contain stuff like ...,
     tuple[...], etc.
     Raises ValueError on failure to cast arguments
     """
@@ -796,9 +796,9 @@ async def cast_basic_arg(
 
 async def cast_arg(
     ctx: commands.Context,
-    param: Union[inspect.Parameter, str],
+    param: inspect.Parameter | str,
     arg: Any,
-    key: Optional[str] = None,
+    key: str | None = None,
     convert_error: bool = True,
 ) -> Any:
     """Cast an argument to the type mentioned by the paramenter annotation"""

snakecore/config.py

@@ -349,10 +349,10 @@ class CoreConfig(ConfigurationBase):
     """Configuration variables used by `snakecore` itself."""
 
     global_client = Field(
-        var_type=Union[discord.Client, discord.AutoShardedClient], write_once=True
+        var_type=discord.Client | discord.AutoShardedClient, write_once=True
     )
     init_mods = Field(init_constr=dict, var_type=dict[ModuleName, bool])
-    storage_channel = Field(init_val=None, var_type=Optional[discord.abc.Messageable])
+    storage_channel = Field(init_val=None, var_type=discord.abc.Messageable | None)
 
 
 conf = CoreConfig()