pyglet 2.1.dev2__tar.gz → 2.1.dev3__tar.gz

{pyglet-2.1.dev2 → pyglet-2.1.dev3}/.github/workflows/unittests.yml

@@ -28,7 +28,7 @@ jobs:
     runs-on: macos-latest
     strategy:
       matrix:
-        python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ]
+        python-version: [ '3.10', '3.11', '3.12' ]
     name: Python ${{ matrix.python-version }} OSX
     steps:
       - uses: actions/checkout@v4

{pyglet-2.1.dev2 → pyglet-2.1.dev3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pyglet
-Version: 2.1.dev2
+Version: 2.1.dev3
 Summary: pyglet is a cross-platform games and multimedia package.
 Author-email: Alex Holkner & contributors <Alex.Holkner@gmail.com>
 Requires-Python: >=3.8

{pyglet-2.1.dev2 → pyglet-2.1.dev3}/RELEASE_NOTES

@@ -1,3 +1,16 @@
+pyglet 2.0.16
+
+Changes and Improvements
+------------------------
+- library-wide overhaul of docstrings, and addition of type hints (#1084)
+
+Bugfixes
+--------
+- resource: Fix indexing of directories inside of Zip files. Remove broken code for multi-part archives.
+- shapes: Add missing `thickness` property to Box.
+- shapes: Add missing docstrings to `Arc` `thickness` property.
+
+
 pyglet 2.0.15
 
 Changes and Improvements
@@ -911,7 +924,7 @@ New features
 Improvements
 ------------
 - Improved font rendering for fonts with negative bearing (#99)
-- Sprites now have `scale_x` and `scale_y` attributes, allowing for aspect ratio changes. The 
+- Sprites now have `scale_x` and `scale_y` attributes, allowing for aspect ratio changes. The
   existing `scale` attribute sets the overall scaling, and functions as before.
 - Sprites have a new `update` method which allows simultaneous changing of position, scale, and
   rotation. This reduces some overhead when changing multiple attributes at once.
@@ -941,16 +954,16 @@ Bugfixes
 
 
 pyglet 1.2.3
-============                                                                                        
-Minor bugfix release.                                                                               
-                                                                                                    
-Bugfixes:                                                                                           
-- Windows: Fix issue where ALT key causes app to hang.                                              
-- Media: Many fixes to PulseAudio and OpenAL media drivers (a.o. #26, #27).                         
-- OSX: Fix stealing the menu when already present in cocoa.                                         
-- Fix multi texturing support (#28).                                                                
-- OSX: Prevent segfault with multiple runs (#37/GC728)                                              
-- ArchLinux: Fix segmentation fault when using gdk_pixbuf (#25) 
+============
+Minor bugfix release.
+
+Bugfixes:
+- Windows: Fix issue where ALT key causes app to hang.
+- Media: Many fixes to PulseAudio and OpenAL media drivers (a.o. #26, #27).
+- OSX: Fix stealing the menu when already present in cocoa.
+- Fix multi texturing support (#28).
+- OSX: Prevent segfault with multiple runs (#37/GC728)
+- ArchLinux: Fix segmentation fault when using gdk_pixbuf (#25)
 
 
 pyglet 1.2.2

{pyglet-2.1.dev2 → pyglet-2.1.dev3}/contrib/qt_sprite_preview.py

@@ -52,15 +52,15 @@ both frag and vertex (IE: test becomes test.vert and test.frag)
 
 Scrolling the mousewheel also zooms in.
 """
+from __future__ import annotations
 
+import argparse
 import os
 import sys
 import traceback
-import argparse
 from pathlib import Path
-
 from textwrap import dedent
-from typing import TYPE_CHECKING, Final, Dict, List, Optional, Tuple, Mapping
+from typing import TYPE_CHECKING, Final, Mapping
 
 # Constants for choosing a Qt backend and summarizing their licensing
 ENV_VARIABLE: Final[str] = 'PYGLET_QT_BACKEND'
@@ -68,9 +68,9 @@ ENV_VARIABLE: Final[str] = 'PYGLET_QT_BACKEND'
 PYSIDE2: Final[str] = 'PySide2'
 PYQT5: Final[str] = 'PyQt5'
 
-valid_backends: Final[Dict[str, str]] = {
+valid_backends: Final[dict[str, str]] = {
     PYSIDE2: "LGPL; may allow releasing under non-GPL licenses",
-    PYQT5: "Dual GPL / Commercial license; requires GPL or a fee"
+    PYQT5: "Dual GPL / Commercial license; requires GPL or a fee",
 }
 
 # Default to PySide2 as part of allowing non-GPL licenses
@@ -80,34 +80,34 @@ DEFAULT: Final[str] = PYSIDE2
 
 # Argument parser for run-time config as __main__
 parser = argparse.ArgumentParser(
-    description=dedent('''\
+    description=dedent("""\
     A sprite & shader previewer using Qt and pyglet together.
 
     It defaults to PySide2, but can run on PyQt5. The details of how may
     be helpful to users who want to avoid spreading PyQt5's GPL license
     while using it as a fallback. See the docstrings and comments in the
     source to learn more.
-    '''),
+    """),
     formatter_class=argparse.RawTextHelpFormatter)
 
 # On Python 3.9+, argparse.BooleanOptionalAction is more concise
 # See https://docs.python.org/3.9/library/argparse.html#action
 parser.add_argument(
     '--use-qt-file-dialog', dest='native_file_dialog', action='store_false',
-    help="Use Qt's file chooser instead of the system's. Helpful on Gnome DE."
+    help="Use Qt's file chooser instead of the system's. Helpful on Gnome DE.",
 )
 parser.set_defaults(native_file_dialog=True)
 
 
 # Generate options help text lines
 backend_column_width: Final[int] = max(map(len, valid_backends))
-help_lines: List[str] = ["Which Qt binding to use.\n"]
+help_lines: list[str] = ["Which Qt binding to use.\n"]
 
 for backend, description in valid_backends.items():
    line_parts = [
        f"{backend: <{backend_column_width}} - ",
        '(Default) ' if backend == DEFAULT else '',
-       description
+       description,
    ]
    help_lines.append(''.join(line_parts))
 
@@ -122,12 +122,12 @@ arguments = None
 if __name__ == "__main__":
     arguments = parser.parse_args()
 
-reasons_with_backend_values: Final[Dict[str, Optional[str]]] = {
+reasons_with_backend_values: Final[dict[str, str | None]] = {
    'first positional argument'       : None if not arguments else arguments.backend,
    # An environment variable allows specifying the binding when
    # importing the module instead of running it as a main program.
    f'{ENV_VARIABLE!r} env variable'  : os.environ.get(ENV_VARIABLE, None),
-   'default'                         : DEFAULT
+   'default'                         : DEFAULT,
 }
 reason, backend = next(filter(
     lambda t: t[1] is not None, reasons_with_backend_values.items()))
@@ -143,16 +143,14 @@ import pyglet
 # uses of PyQt5-specific features as missing. For example, pyright is
 # one of the strict type checking and linting tools which can help.
 if TYPE_CHECKING or backend == PYSIDE2:
-    from PySide2.QtGui import QWheelEvent
-    from PySide2.QtWidgets import QFileDialog
     from PySide2 import QtCore, QtWidgets
-    from PySide2.QtWidgets import QOpenGLWidget
+    from PySide2.QtGui import QWheelEvent
+    from PySide2.QtWidgets import QFileDialog, QOpenGLWidget
 
 elif backend == PYQT5:
-    from PyQt5.QtGui import QWheelEvent
-    from PyQt5.QtWidgets import QFileDialog
     from PyQt5 import QtCore, QtWidgets
-    from PyQt5.QtWidgets import QOpenGLWidget
+    from PyQt5.QtGui import QWheelEvent
+    from PyQt5.QtWidgets import QFileDialog, QOpenGLWidget
 
 else:  # Handle import edge cases
     raise ValueError(
@@ -162,11 +160,18 @@ else:  # Handle import edge cases
 # Import the other constants after the UI libraries to avoid
 # cluttering the symbol table when debugging import problems.
 from pyglet.gl import (
-    glClear, GL_COLOR_BUFFER_BIT, GL_DEPTH_BUFFER_BIT, glActiveTexture,
-    GL_TEXTURE0, glBindTexture, GL_BLEND, glEnable, glBlendFunc, glDisable
+   GL_BLEND,
+   GL_COLOR_BUFFER_BIT,
+   GL_DEPTH_BUFFER_BIT,
+   GL_TEXTURE0,
+   glActiveTexture,
+   glBindTexture,
+   glBlendFunc,
+   glClear,
+   glDisable,
+   glEnable,
 )
 
-
 default_vertex_src = """#version 150 core
 in vec3 translate;
 in vec4 colors;
@@ -233,8 +238,8 @@ class MultiTextureSpriteGroup(pyglet.sprite.SpriteGroup):
             textures: Mapping[str, pyglet.image.Texture],
             blend_src: int,
             blend_dest: int,
-            program: Optional[pyglet.graphics.shader.ShaderProgram] = None,
-            parent: Optional[pyglet.graphics.Group] = None
+            program: pyglet.graphics.shader.ShaderProgram | None = None,
+            parent: pyglet.graphics.Group | None = None,
     ) -> None:
         """Create a sprite group for multiple textures and samplers.
 
@@ -297,7 +302,7 @@ class MultiTextureSpriteGroup(pyglet.sprite.SpriteGroup):
                      self.blend_src, self.blend_dest))
 
 
-class MultiTextureSprite(pyglet.sprite.AdvancedSprite):
+class MultiTextureSprite(pyglet.sprite.Sprite):
 
     def __init__(
             self,
@@ -305,10 +310,10 @@ class MultiTextureSprite(pyglet.sprite.AdvancedSprite):
             x: float = 0, y: float = 0, z: float = 0,
             blend_src: int = pyglet.gl.GL_SRC_ALPHA,
             blend_dest: int = pyglet.gl.GL_ONE_MINUS_SRC_ALPHA,
-            batch: Optional[pyglet.graphics.Batch] = None,
-            group: Optional[MultiTextureSpriteGroup] = None,
+            batch: pyglet.graphics.Batch | None = None,
+            group: MultiTextureSpriteGroup | None = None,
             subpixel: bool = False,
-            program: pyglet.graphics.shader.ShaderProgram = None
+            program: pyglet.graphics.shader.ShaderProgram = None,
     ) -> None:
 
         self._x = x
@@ -484,7 +489,7 @@ class Ui_MainWindow:
             self.program = pyglet.graphics.shader.ShaderProgram(vertex_, fragment_)
 
             if len(self.images) == 1:
-                self.sprite = pyglet.sprite.AdvancedSprite(
+                self.sprite = pyglet.sprite.Sprite(
                     self.images[0],
                     x=self.SPRITE_POSITION[0], y=self.SPRITE_POSITION[1],
                     group=self.group, batch=self.openGLWidget.batch,
@@ -685,7 +690,6 @@ class PygletWidget(QOpenGLWidget):
 
     def initializeGL(self) -> None:
         """Call anything that needs a context to be created."""
-
         self._projection_matrix = pyglet.math.Mat4()
         self._view_matrix = pyglet.math.Mat4()
 
@@ -702,7 +706,7 @@ class PygletWidget(QOpenGLWidget):
         self.viewport = 0, 0, self.width(), self.height()
 
     @property
-    def viewport(self) -> Tuple[int, int, int, int]:
+    def viewport(self) -> tuple[int, int, int, int]:
         """The Window viewport
 
         The Window viewport, expressed as (x, y, width, height).
@@ -712,7 +716,7 @@ class PygletWidget(QOpenGLWidget):
         return self._viewport
 
     @viewport.setter
-    def viewport(self, values: Tuple[int, int, int, int]) -> None:
+    def viewport(self, values: tuple[int, int, int, int]) -> None:
         self._viewport = values
         pr = 1.0
         x, y, w, h = values

pyglet-2.1.dev3/doc/_static/css/custom.css

@@ -0,0 +1,29 @@
+/* Import RTD theme before our own changes. */
+@import 'theme.css';
+
+/* CSS to fix wrapping: https://github.com/readthedocs/sphinx_rtd_theme/issues/1529#issuecomment-1918561608 */
+/* Take out pointless vertical whitespace in the signatures. */
+.rst-content dl .sig dl,
+.rst-content dl .sig dd {
+    margin-bottom: 0;
+    margin-top: 0;
+}
+
+/* Make class boxes full-width, with view-source and header links right-aligned. */
+.py.class > .sig.sig-object.py:first-of-type {
+    width: 100%;
+}
+.py.class > .sig.sig-object.py:first-of-type .viewcode-link {
+  display: inline-flex;
+  float: right;
+  margin-right: 1.5em;
+}
+.py.class > .sig.sig-object.py:first-of-type .headerlink {
+  position: absolute;
+  right: 0.5em;
+}
+
+/* Prevent multiple properties from being on the same row. */
+dl.py.property {
+    display: block !important;
+}

{pyglet-2.1.dev2 → pyglet-2.1.dev3}/doc/conf.py

@@ -1,26 +1,70 @@
-# -*- coding: utf-8 -*-
 #
 # pyglet documentation build configuration file.
 #
 # This file is execfile()d with the current directory set to its containing dir.
-
-
+import datetime
 import os
 import sys
 import time
-import datetime
+import typing
+from typing import TypeVar
+
+import sphinx_autodoc_typehints
+
+# -- Extensions to the  Napoleon GoogleDocstring class ---------------------
+from sphinx.ext.napoleon.docstring import GoogleDocstring
+from sphinx.parsers import RSTParser
+
+
+def parse_attributes_section(self, section):
+    # Combination of _format_fields and _parse_attributes_section to get type hints loaded properly using
+    # the theme and getting the custom name instead of Specifying just 'Variables'
+    field_type = "Class Variables"
+    fields = self._consume_fields()
+
+    field_type = ":%s:" % field_type.strip()
+    padding = " " * len(field_type)
+    multi = len(fields) > 1
+    lines: list[str] = []
+    for _name, _type, _desc in fields:
+        if not _type:
+            _type = self._lookup_annotation(_name)
+            if _name in self._annotations:
+                _type = sphinx_autodoc_typehints.add_type_css_class(
+                   sphinx_autodoc_typehints.format_annotation(self._annotations[_name], self._app.config))
+
+        field = self._format_field(_name, _type, _desc)
+        if multi:
+            if lines:
+                lines.extend(self._format_block(padding + " * ", field))
+            else:
+                lines.extend(self._format_block(field_type + " * ", field))
+        else:
+            lines.extend(self._format_block(field_type + " ", field))
+    if lines and lines[-1]:
+        lines.append("")
+    return lines
+
 
-# Prevents instance attributes from having a default value of None
-# See sphinx ticket: https://github.com/sphinx-doc/sphinx/issues/2044
-from sphinx.ext.autodoc import ClassLevelDocumenter
+GoogleDocstring._parse_attributes_section = parse_attributes_section
 
+# Unpatch... the patch.
+def _revert_patch():
+    pass
 
-def iad_add_directive_header(self, sig):
-    ClassLevelDocumenter.add_directive_header(self, sig)
+sphinx_autodoc_typehints.patches._patch_google_docstring_lookup_annotation = _revert_patch
 
+# Patch to fix our RST insertion issues.
+class _RstSnippetParser(RSTParser):
+    @staticmethod
+    def decorate(_content) -> None:
+        """Override to skip processing rst_epilog/rst_prolog for typing."""
+
+
+sphinx_autodoc_typehints.parser.RSTParser = _RstSnippetParser
 
 def write_build(data, filename):
-    with open(os.path.join('internal', filename), 'w') as f:
+    with open(os.path.join("internal", filename), "w") as f:
         f.write(".. list-table::\n")
         f.write("   :widths: 50 50\n")
         f.write("\n")
@@ -33,10 +77,10 @@ sys.is_pyglet_doc_run = True
 document_modules = ["pyglet"]
 
 # Patched extensions base path.
-sys.path.insert(0, os.path.abspath('.'))
+sys.path.insert(0, os.path.abspath("."))
 
 # import the pyglet package.
-sys.path.insert(0, os.path.abspath('..'))
+sys.path.insert(0, os.path.abspath(".."))
 
 
 try:
@@ -47,8 +91,11 @@ except ImportError:
     sys.exit(1)
 
 
+
+
 # -- PYGLET DOCUMENTATION CONFIGURATION ----------------------------------------
 
+
 # Set up substitutions that can be referenced later.
 # IMPORTANT:
 # Substitutions are moody and NEED control-like characters to be escaped
@@ -58,21 +105,17 @@ except ImportError:
 # avoid having to deal with syntax errors.
 # Also, please note that there does not appear to be a good way to use
 # substitutions within link text by default.
-rst_prolog = """
-.. |min_python_version| replace:: {min_python_version}
-.. |min_python_version_package_name| replace:: ``python{min_python_version}``
-.. |min_python_version_fancy_str| replace:: Python {min_python_version}+
-""".format(
-    min_python_version=pyglet.MIN_PYTHON_VERSION_STR
-)
+rst_epilog = rf"""
+.. |min_python_version| replace:: {pyglet.MIN_PYTHON_VERSION_STR}
+.. |min_python_version_package_name| replace:: ``python{pyglet.MIN_PYTHON_VERSION_STR}``
+.. |min_python_version_fancy_str| replace:: Python {pyglet.MIN_PYTHON_VERSION_STR}\+
+"""
 
 implementations = ["cocoa", "win32", "xlib"]
 
 # For each module, a list of submodules that should not be imported.
 # If value is None, do not try to import any submodule.
 skip_modules = {"pyglet": {
-                     "pyglet.com": None,
-                     "pyglet.compat": None,
                      "pyglet.lib": None,
                      "pyglet.libs": None,
                      "pyglet.app": implementations,
@@ -80,7 +123,8 @@ skip_modules = {"pyglet": {
                      "pyglet.extlibs": None,
                      "pyglet.font": ["quartz",
                                      "win32",
-                                     "freetype", "freetype_lib",
+                                     "freetype",
+                                     "freetype_lib",
                                      "fontconfig",
                                      "win32query"],
                      "pyglet.input": ["darwin_hid",
@@ -110,7 +154,7 @@ skip_modules = {"pyglet": {
 now = datetime.datetime.fromtimestamp(time.time())
 build_data = (("Date", now.strftime("%Y/%m/%d %H:%M:%S")),
               ("pyglet version", pyglet.version))
-write_build(build_data, 'build.rst')
+write_build(build_data, "build.rst")
 
 # -- SPHINX STANDARD OPTIONS ---------------------------------------------------
 
@@ -127,38 +171,53 @@ inheritance_graph_attrs = dict(rankdir="LR", size='""')
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc',
-              'sphinx.ext.intersphinx',
-              'sphinx.ext.inheritance_diagram',
-              'sphinx.ext.todo',
-              'sphinx.ext.napoleon']
+extensions = ["sphinx.ext.autodoc",
+              "sphinx.ext.napoleon",
+              "sphinx.ext.intersphinx",
+              "sphinx.ext.inheritance_diagram",
+              "sphinx.ext.todo",
+              "sphinx_autodoc_typehints",
+              ]
+
+# Autodoc settings.
+autodoc_member_order = "groupwise"
 
-autodoc_member_order = 'groupwise'
+# Separate init from the class header as RTD theme makes it all the same color, reducing readability.
+autodoc_class_signature = "separated"
+
+# Add type hints to description and parameters in docs.
+autodoc_typehints = "signature"
+autodoc_typehints_format = "short"
+
+# Configuration for sphinx_autodoc_typehints
+typehints_use_signature = True
+typehints_use_signature_return = True
+always_use_bars_union = True
 
 # Enable links to Python's main doc
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None)
+    "python": ("https://docs.python.org/3", None),
 }
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'pyglet'
-copyright = u'2006-2008, Alex Holkner. 2008-2023 pyglet contributors'
+project = "pyglet"
+copyright = "2006-2008, Alex Holkner. 2008-2023 pyglet contributors"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '2.0'
+version = "2.0"
 # The full version, including alpha/beta/rc tags.
 release = pyglet.version
 
@@ -174,7 +233,7 @@ release = pyglet.version
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build', '_templates', 'api']
+exclude_patterns = ["_build", "_templates", "api"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
 #default_role = None
@@ -191,23 +250,29 @@ add_module_names = False
 #show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-modindex_common_prefix = ['pyglet.']
+modindex_common_prefix = ["pyglet."]
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'sphinx_rtd_theme'
+html_theme = "sphinx_rtd_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #html_theme_options = {}
 
+# Force custom css to allow multiline inits.
+html_css_files = [
+    "css/custom.css",
+]
+html_style = "css/custom.css"
+
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = ["ext/theme"]
 
@@ -230,7 +295,7 @@ html_favicon = "_static/favicon.ico"
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
@@ -274,7 +339,7 @@ html_show_sourcelink = False
 #html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'pygletdoc'
+htmlhelp_basename = "pygletdoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
@@ -293,8 +358,8 @@ latex_elements = {
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'pyglet.tex', u'pyglet Documentation',
-   u'Alex Holkner', 'manual'),
+  ("index", "pyglet.tex", "pyglet Documentation",
+   "Alex Holkner", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -323,8 +388,8 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'pyglet', u'pyglet Documentation',
-     [u'Alex Holkner'], 1)
+    ("index", "pyglet", "pyglet Documentation",
+     ["Alex Holkner"], 1),
 ]
 
 # If true, show URL addresses after external links.
@@ -337,9 +402,9 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'pyglet', u'pyglet Documentation',
-   u'Alex Holkner', 'pyglet', 'One line description of project.',
-   'Miscellaneous'),
+  ("index", "pyglet", "pyglet Documentation",
+   "Alex Holkner", "pyglet", "One line description of project.",
+   "Miscellaneous"),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -350,3 +415,36 @@ texinfo_documents = [
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
 #texinfo_show_urls = 'footnote'
+
+python_maximum_signature_line_length = 85
+
+nitpicky = True
+
+def custom_formatter(annotation, config):
+    # Fixes TypeVar bounds, where the bound reference is forward referenced and class cannot be determined.
+    # Defaults to a class style. Seems good enough for now since most bound things are classes.
+    if isinstance(annotation, TypeVar):
+        try:
+            module = sphinx_autodoc_typehints.get_annotation_module(annotation)
+            class_name = sphinx_autodoc_typehints.get_annotation_class_name(annotation, module)
+            args = sphinx_autodoc_typehints.get_annotation_args(annotation, module, class_name)
+        except ValueError:
+            return str(annotation).strip("'")
+        params = {k: getattr(annotation, f"__{k}__") for k in ("bound", "covariant", "contravariant")}
+        params = {k: v for k, v in params.items() if v}
+        if "bound" in params:
+            bound_param = params["bound"]
+            if isinstance(bound_param, typing.ForwardRef):
+                # May be wrong but
+                params["bound"] = f":py:class:`{bound_param.__forward_arg__}`"
+            else:
+                params["bound"] = f"{sphinx_autodoc_typehints.format_annotation(bound_param, config)}"
+        args_format = f"\\(``{annotation.__name__}``{', {}' if args else ''}"
+        if params:
+            args_format += "".join(f", *{k} =* {v}" for k, v in params.items())
+        args_format += ")"
+        formatted_args = None if args else args_format
+        return f":py:class:`TypeVar` {formatted_args}"
+    return None
+
+typehints_formatter = custom_formatter

{pyglet-2.1.dev2 → pyglet-2.1.dev3}/doc/index.rst

@@ -77,6 +77,7 @@ If you are migrating from an older version of pyglet, please read through
    modules/app
    modules/clock
    modules/display
+   modules/customtypes
    modules/event
    modules/font
    modules/gl