Fix Python 3.11 compatibility

Author: JesseTG

CHANGELOG.md

@@ -10,6 +10,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 > breaking changes may be introduced
 > at any time without warning.
 
+## [Unreleased]
+
+### Fixed
+
+- Remove syntax that prevented compatibility with Python 3.10 and 3.11.
+- Added aliases to `typing` symbols as needed if using a Python version older than 3.12.
+- Added `typing_extensions` as a dependency if using a Python version older than 3.12.
+
 ## [0.1.6] - 2024-06-03
 
 ### Changed

pyproject.toml

@@ -32,7 +32,7 @@ classifiers = [
 ]
 keywords = ["libretro", "retroarch", "emulation", "testing", "retrogaming"]
 dependencies = [
-    "typing_extensions == 4.*; python_version == '3.10'",
+    "typing_extensions == 4.*; python_version < '3.12'",
 ]
 
 [project.optional-dependencies]

src/libretro/_typing.py

@@ -0,0 +1,11 @@
+import sys
+
+if sys.version_info >= (3, 12):
+    from collections.abc import Buffer, override
+else:
+    from typing_extensions import Buffer, override
+
+__all__ = [
+    "Buffer",
+    "override",
+]

src/libretro/api/_utils.py

@@ -1,6 +1,6 @@
 import ctypes
 import mmap
-from collections.abc import Buffer, Iterator
+from collections.abc import Iterator
 from contextlib import contextmanager
 from copy import deepcopy
 from ctypes import (
@@ -27,6 +27,8 @@
 from os import PathLike
 from typing import TypeAlias, get_type_hints
 
+from libretro._typing import Buffer
+
 # When https://github.com/python/cpython/issues/112015 is merged,
 # use ctypes.memoryview_at instead of this hack
 # taken from https://stackoverflow.com/a/72968176/1089957
@@ -71,7 +73,7 @@ def is_zeroed(struct: Structure) -> bool:
     return not any(view)
 
 
-def from_zero_terminated[S](ptr) -> Iterator[S]:
+def from_zero_terminated(ptr) -> Iterator:
     if ptr:
         i = 0
         while not is_zeroed(ptr[i]):

src/libretro/api/content.py

@@ -1,5 +1,5 @@
 import os
-from collections.abc import Buffer, Generator, Iterator, Mapping, Sequence
+from collections.abc import Generator, Iterator, Mapping, Sequence
 from contextlib import contextmanager
 from ctypes import (
     POINTER,
@@ -19,6 +19,7 @@
 from typing import Any, NamedTuple, TypeAlias, overload
 from zipfile import Path as ZipPath
 
+from libretro._typing import Buffer
 from libretro.api._utils import (
     FieldsFromTypeHints,
     as_bytes,

src/libretro/builder.py

@@ -3,7 +3,7 @@
 from enum import Enum, auto
 from logging import Logger
 from os import PathLike
-from typing import AnyStr, Literal, Self, TypedDict
+from typing import AnyStr, Literal, Self, TypeAlias, TypedDict, TypeVar
 from zipfile import Path as ZipPath
 
 from libretro.api import (
@@ -70,12 +70,6 @@
 except ImportError:
     ModernGlVideoDriver = None
 
-type _RequiredFactory[T] = Callable[[], T]
-type _OptionalFactory[T] = Callable[[], T | None]
-
-type _RequiredArg[T] = T | _RequiredFactory[T]
-type _OptionalArg[T] = T | _OptionalFactory[T] | Default | None
-
 
 class _DefaultType(Enum):
     DEFAULT = auto()
@@ -88,38 +82,50 @@ class _DefaultType(Enum):
 When passed to a SessionBuilder method, the method will use the default value for that argument.
 """
 
+T = TypeVar("T")
+
+_RequiredFactory: TypeAlias = Callable[[], T]
+_OptionalFactory: TypeAlias = Callable[[], T | None]
+
+_RequiredArg: TypeAlias = T | _RequiredFactory[T]
+_OptionalArg: TypeAlias = T | _OptionalFactory[T] | Default | None
+
 _nothing = lambda: None
-CoreArg = Core | str | PathLike | CDLL | _RequiredFactory[Core]
-AudioDriverArg = _RequiredArg[AudioDriver] | Default
-InputDriverArg = (
+CoreArg: TypeAlias = Core | str | PathLike | CDLL | _RequiredFactory[Core]
+AudioDriverArg: TypeAlias = _RequiredArg[AudioDriver] | Default
+InputDriverArg: TypeAlias = (
     _RequiredArg[InputDriver]
     | InputStateGenerator
     | InputStateIterable
     | InputStateIterator
     | Default
 )
-VideoDriverArg = _RequiredArg[VideoDriver] | Default
-ContentArg = Content | SubsystemContent | _OptionalFactory[Content | SubsystemContent] | None
-ContentDriverArg = _OptionalArg[ContentDriver]
-BoolArg = _OptionalArg[bool]
-MessageDriverArg = _OptionalArg[MessageInterface] | Logger
-OptionDriverArg = _OptionalArg[OptionDriver] | Mapping[AnyStr, AnyStr] | Literal[0, 1, 2]
-PathDriverArg = _OptionalArg[PathDriver] | str | PathLike
-LogDriverArg = _OptionalArg[LogDriver] | Logger
-PerfDriverArg = _OptionalArg[PerfDriver]
-LocationDriverArg = _OptionalArg[LocationDriver] | LocationInputGenerator
-UserDriverArg = _OptionalArg[UserDriver]
-FileSystemArg = _OptionalArg[FileSystemInterface] | Literal[1, 2, 3]
-LedDriverArg = _OptionalArg[LedDriver]
-AvEnableFlagsArg = _OptionalArg[AvEnableFlags]
-MidiDriverArg = _OptionalArg[MidiDriver]
-TimingDriverArg = _OptionalArg[TimingDriver]
-FloatArg = _OptionalArg[float | int]
-HardwareContextArg = _OptionalArg[HardwareContext]
-ThrottleStateArg = _OptionalArg[retro_throttle_state]
-SavestateContextArg = _OptionalArg[SavestateContext]
-MicDriverArg = _OptionalArg[MicrophoneDriver]
-PowerDriverArg = _OptionalArg[PowerDriver] | retro_device_power
+VideoDriverArg: TypeAlias = _RequiredArg[VideoDriver] | Default
+ContentArg: TypeAlias = (
+    Content | SubsystemContent | _OptionalFactory[Content | SubsystemContent] | None
+)
+ContentDriverArg: TypeAlias = _OptionalArg[ContentDriver]
+BoolArg: TypeAlias = _OptionalArg[bool]
+MessageDriverArg: TypeAlias = _OptionalArg[MessageInterface] | Logger
+OptionDriverArg: TypeAlias = (
+    _OptionalArg[OptionDriver] | Mapping[AnyStr, AnyStr] | Literal[0, 1, 2]
+)
+PathDriverArg: TypeAlias = _OptionalArg[PathDriver] | str | PathLike
+LogDriverArg: TypeAlias = _OptionalArg[LogDriver] | Logger
+PerfDriverArg: TypeAlias = _OptionalArg[PerfDriver]
+LocationDriverArg: TypeAlias = _OptionalArg[LocationDriver] | LocationInputGenerator
+UserDriverArg: TypeAlias = _OptionalArg[UserDriver]
+FileSystemArg: TypeAlias = _OptionalArg[FileSystemInterface] | Literal[1, 2, 3]
+LedDriverArg: TypeAlias = _OptionalArg[LedDriver]
+AvEnableFlagsArg: TypeAlias = _OptionalArg[AvEnableFlags]
+MidiDriverArg: TypeAlias = _OptionalArg[MidiDriver]
+TimingDriverArg: TypeAlias = _OptionalArg[TimingDriver]
+FloatArg: TypeAlias = _OptionalArg[float | int]
+HardwareContextArg: TypeAlias = _OptionalArg[HardwareContext]
+ThrottleStateArg: TypeAlias = _OptionalArg[retro_throttle_state]
+SavestateContextArg: TypeAlias = _OptionalArg[SavestateContext]
+MicDriverArg: TypeAlias = _OptionalArg[MicrophoneDriver]
+PowerDriverArg: TypeAlias = _OptionalArg[PowerDriver] | retro_device_power
 
 
 class RequiredError(RuntimeError):

src/libretro/core.py

@@ -1,5 +1,5 @@
 from abc import abstractmethod
-from collections.abc import Buffer, Callable, Sequence
+from collections.abc import Callable, Sequence
 from copy import deepcopy
 from ctypes import (
     CDLL,
@@ -19,6 +19,7 @@
 from os import PathLike
 from typing import Protocol
 
+from libretro._typing import Buffer
 from libretro.api import (
     Region,
     retro_audio_sample_batch_t,

src/libretro/drivers/audio/array.py

@@ -1,7 +1,7 @@
 from array import array
 from copy import deepcopy
-from typing import override
 
+from libretro._typing import override
 from libretro.api.audio import retro_audio_buffer_status_callback, retro_audio_callback
 from libretro.api.av import retro_system_av_info
 from libretro.error import UnsupportedEnvCall

src/libretro/drivers/audio/wave.py

@@ -2,8 +2,8 @@
 from copy import deepcopy
 from io import RawIOBase
 from os import PathLike, fsdecode
-from typing import override
 
+from libretro._typing import override
 from libretro.api.audio import retro_audio_buffer_status_callback, retro_audio_callback
 from libretro.api.av import retro_system_av_info
 from libretro.error import UnsupportedEnvCall

src/libretro/drivers/camera/generator.py

@@ -1,4 +1,4 @@
-from typing import override
+from libretro._typing import override
 
 from ... import (
     CameraCapabilityFlags,

src/libretro/drivers/content/standard.py

@@ -4,9 +4,9 @@
 from ctypes import Array, c_void_p
 from os import PathLike
 from tempfile import TemporaryDirectory
-from typing import override
 from zipfile import Path as ZipPath
 
+from libretro._typing import override
 from libretro.api import (
     Content,
     ContentInfoOverrides,

src/libretro/drivers/environment/composite.py

@@ -16,10 +16,11 @@
     sizeof,
     string_at,
 )
-from typing import AnyStr, Required, TypedDict, override
+from typing import AnyStr, Required, TypedDict
 
 from _ctypes import CFuncPtr
 
+from libretro._typing import override
 from libretro.api import (
     AvEnableFlags,
     HardwareContext,

src/libretro/drivers/environment/default.py

@@ -1,7 +1,7 @@
 from collections.abc import Mapping
 from ctypes import POINTER, c_bool, c_char_p, c_float, c_uint, c_uint64, cast
-from typing import override
 
+from libretro._typing import override
 from libretro.api import (
     EnvironmentCall,
     retro_audio_buffer_status_callback,

src/libretro/drivers/environment/dict.py

@@ -1,8 +1,8 @@
 from collections.abc import Callable, KeysView, Mapping
 from ctypes import c_void_p
 from types import MappingProxyType
-from typing import override
 
+from libretro._typing import override
 from libretro.api import EnvironmentCall
 from libretro.error import UnsupportedEnvCall
 

src/libretro/drivers/input/generator.py

@@ -1,8 +1,8 @@
 from collections.abc import Callable, Generator, Iterable, Iterator, Sequence
 from dataclasses import dataclass
 from enum import Enum, auto
-from typing import override
 
+from libretro._typing import override
 from libretro._utils import Pollable
 from libretro.api.input import (
     AnalogState,

src/libretro/drivers/led/dict.py

@@ -1,4 +1,4 @@
-from typing import override
+from libretro._typing import override
 
 from .driver import LedDriver
 

src/libretro/drivers/microphone/generator.py

@@ -1,7 +1,7 @@
 from array import array
 from collections.abc import Callable, Generator, Iterable, Iterator, Sequence
-from typing import override
 
+from libretro._typing import override
 from libretro.api.microphone import INTERFACE_VERSION, retro_microphone_params
 
 from .driver import Microphone, MicrophoneDriver

src/libretro/drivers/netpacket/socket.py

@@ -1,6 +1,6 @@
 from socket import AddressFamily, SocketKind, socket
-from typing import override
 
+from libretro._typing import override
 from libretro.api.netpacket import NetpacketFlags, retro_netpacket_callback
 
 from .driver import ClientID, NetpacketDriver

src/libretro/drivers/options/dict.py

@@ -2,8 +2,9 @@
 from collections.abc import Mapping, MutableMapping, Sequence
 from copy import deepcopy
 from ctypes import Array, string_at
-from typing import AnyStr, override
+from typing import AnyStr
 
+from libretro._typing import override
 from libretro.api._utils import as_bytes, from_zero_terminated
 from libretro.api.options import (
     CoreOptionArray,

src/libretro/drivers/path/default.py

@@ -1,5 +1,6 @@
 from os import PathLike, fsencode
-from typing import override
+
+from libretro._typing import override
 
 from .driver import PathDriver
 

src/libretro/drivers/power/driver.py

@@ -1,6 +1,7 @@
 from abc import abstractmethod
-from typing import Protocol, override, runtime_checkable
+from typing import Protocol, runtime_checkable
 
+from libretro._typing import override
 from libretro.api.power import retro_device_power
 
 

src/libretro/drivers/timing/default.py

@@ -1,6 +1,4 @@
-from copy import deepcopy
-from typing import override
-
+from libretro._typing import override
 from libretro.api.timing import (
     retro_fastforwarding_override,
     retro_frame_time_callback,

src/libretro/drivers/user/default.py

@@ -1,5 +1,4 @@
-from typing import override
-
+from libretro._typing import override
 from libretro.api.user import Language
 
 from .driver import UserDriver

src/libretro/drivers/video/multi.py

@@ -1,7 +1,8 @@
 from collections.abc import Callable, Mapping, Set
 from copy import deepcopy
-from typing import final, override
+from typing import final
 
+from libretro._typing import override
 from libretro.api.av import retro_game_geometry, retro_system_av_info
 from libretro.api.proc import retro_proc_address_t
 from libretro.api.video import (

src/libretro/drivers/video/software/array.py

@@ -1,9 +1,10 @@
 import itertools
 from array import array
 from copy import deepcopy
-from typing import final, override
+from typing import final
 from warnings import warn
 
+from libretro._typing import override
 from libretro.api.av import retro_game_geometry, retro_system_av_info
 from libretro.api.video import MemoryAccess, PixelFormat, Rotation, retro_framebuffer
 

src/libretro/drivers/video/software/base.py

@@ -1,8 +1,8 @@
 from abc import ABC
 from collections.abc import Set
-from typing import final, override
+from typing import final
 
-from libretro.api.proc import retro_proc_address_t
+from libretro._typing import override
 from libretro.api.video.context import HardwareContext, retro_hw_render_callback
 from libretro.api.video.render import retro_hw_render_interface
 from libretro.error import UnsupportedEnvCall