Merge branch 'main' into events-in-python-2

Author: gresm

.github/workflows/build-manylinux.yml

@@ -75,7 +75,7 @@ jobs:
 
     - name: Build and push Docker image
       if: steps.inspect.outcome == 'failure'
-      uses: docker/build-push-action@5176d81f87c23d6fc96624dfdbcd9f3830bbe445
+      uses: docker/build-push-action@5cd11c3a4ced054e52742c5fd54dca954e0edd85
       with:
         context: ${{ github.workspace }}/buildconfig/manylinux-build/docker_base
         file: ${{ github.workspace }}/buildconfig/manylinux-build/docker_base/Dockerfile-${{ matrix.arch }}

.github/workflows/build-ubuntu-coverage.yml

@@ -0,0 +1,95 @@
+# this workflow generates C code coverage information from the unit test
+# suite. Note that for intrinsics, it only runs what gets compiled
+# and would naturally run. It also is limited to what can run in
+# a CI environment
+# IMPORTANT: binaries are not to be uploaded from this workflow!
+
+name: Ubuntu coverage
+
+# Run CI only when a release is created, on changes to main branch, or any PR
+# to main. Do not run CI on any other branch. Also, skip any non-source changes
+# from running on CI
+on:
+  push:
+    branches: main
+    paths-ignore:
+      - 'docs/**'
+      - 'examples/**'
+      - '.gitignore'
+      - '*.rst'
+      - '*.md'
+      - '.github/workflows/*.yml'
+      # gcov/lcov only gets C coverage
+      - 'src_py/**'
+      # re-include current file to not be excluded
+      - '!.github/workflows/build-ubuntu-coverage.yml'
+
+  pull_request:
+    branches: main
+    paths-ignore:
+      - 'docs/**'
+      - 'examples/**'
+      - '.gitignore'
+      - '*.rst'
+      - '*.md'
+      - '.github/workflows/*.yml'
+      # gcov/lcov only gets C coverage
+      - 'src_py/**'
+      # re-include current file to not be excluded
+      - '!.github/workflows/build-ubuntu-coverage.yml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}-ubuntu-coverage
+  cancel-in-progress: true
+
+jobs:
+  gen_coverage:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false  # if a particular matrix build fails, don't skip the rest
+      matrix:
+        os: [ubuntu-22.04]
+
+    steps:
+    - uses: actions/checkout@v4.1.7
+
+    - name: Install deps
+      # install numpy from pip and not apt because the one from pip is newer,
+      # and has typestubs
+      # https://github.com/actions/runner-images/issues/7192
+      # https://github.com/orgs/community/discussions/47863
+      run: |
+        sudo apt-get update --fix-missing
+        sudo apt-get install lcov -y
+        sudo apt-get install libsdl2-dev libsdl2-image-dev libsdl2-mixer-dev libsdl2-ttf-dev libfreetype6-dev libportmidi-dev python3-dev -y
+        pip3 install --upgrade pip
+        pip3 install meson-python ninja cython "sphinx<=7.2.6"  # because we are doing --no-build-isolation
+        pip3 install numpy>=1.21.0
+
+    - name: Build with coverage hooks and install
+      id: build
+      run: |
+        pip3 install -e . --no-build-isolation -Cbuild-dir=./.mesonpy-rel -Csetup-args=-Dcoverage=true
+
+    - name: Run tests
+      env:
+        SDL_VIDEODRIVER: "dummy"
+        SDL_AUDIODRIVER: "disk"
+      run: python3 -m pygame.tests -v --exclude opengl,music,timing --time_out 300
+
+    - name: Generate coverage
+      id: gen-coverage
+      # want to continue regardless of whether a test failed or not as long as the job wasn't cancelled
+      if: ${{ steps.build.conclusion == 'success' && !cancelled() }}
+      run: |
+        lcov --capture --directory . --output-file ./coverage.info
+        genhtml ./coverage.info --output-directory ./out
+
+    # We upload the generated files under github actions assets
+    - name: Upload coverage html
+      # want to continue only if the coverage generation was successful
+      if: ${{ steps.gen-coverage.conclusion == 'success' && !cancelled() }}
+      uses: actions/upload-artifact@v4
+      with:
+        name: pygame-wheels-coverage
+        path: ./out

.github/workflows/release-gh-draft.yml

@@ -61,7 +61,7 @@ jobs:
         run: echo "VER=${GITHUB_REF_NAME#'release/'}" >> $GITHUB_OUTPUT
 
       - name: Generate release attestation
-        uses: actions/attest-build-provenance@v1.4.0
+        uses: actions/attest-build-provenance@v1.4.2
         with:
           subject-path: "pygame-wheels/*"
 

buildconfig/stubs/gen_stubs.py

@@ -4,6 +4,7 @@
 """
 
 import pathlib
+import shutil
 from typing import Any
 
 import pygame.constants
@@ -51,6 +52,7 @@
     "system",
     "geometry",
     "window",
+    "typing",
 ]
 
 # pygame classes that are autoimported into main namespace are kept in this dict
@@ -151,3 +153,8 @@ def get_all(mod: Any):
     for element in get_all(pygame.locals):
         constant_type = getattr(pygame.locals, element).__class__.__name__
         f.write(f"{element}: {constant_type}\n")
+        
+# copy typing.py to typing.pyi for type checkers
+typing_py_file = pathlib.Path(__file__).parent.parent.parent / "src_py" / "typing.py"
+typing_stub_file = pathlib.Path(__file__).parent / "pygame" / "typing.pyi"
+shutil.copyfile(typing_py_file, typing_stub_file)

buildconfig/stubs/mypy_allow_list.txt

@@ -2,10 +2,6 @@
 # listed here are not checked by the mypy stubtest program
 # This allowlist supports regex
 
-# This is not a real typestub file, it is used only in the typestubs to export
-# a few utility typestub definitions
-pygame\._common
-
 # cython files have this top level dunder
 pygame\._sdl2\..*\.__test__
 

buildconfig/stubs/pygame/__init__.pyi

@@ -38,6 +38,7 @@ from pygame import (
     system as system,
     geometry as geometry,
     window as window,
+    typing as typing,
 )
 
 from .rect import Rect as Rect, FRect as FRect
@@ -183,6 +184,9 @@ from .constants import (
     FINGERDOWN as FINGERDOWN,
     FINGERMOTION as FINGERMOTION,
     FINGERUP as FINGERUP,
+    FLASH_BRIEFLY as FLASH_BRIEFLY,
+    FLASH_CANCEL as FLASH_CANCEL,
+    FLASH_UNTIL_FOCUSED as FLASH_UNTIL_FOCUSED,
     FONT_CENTER as FONT_CENTER,
     FONT_LEFT as FONT_LEFT,
     FONT_RIGHT as FONT_RIGHT,

buildconfig/stubs/pygame/_common.pyi

@@ -5,7 +5,7 @@ from pygame.rect import Rect
 from pygame.surface import Surface
 from pygame.window import Window as Window
 
-from .._common import ColorValue, RectValue, Coordinate
+from pygame.typing import ColorLike, RectLike, Coordinate
 
 WINDOWPOS_UNDEFINED: int
 WINDOWPOS_CENTERED: int
@@ -60,13 +60,13 @@ class Texture:
     @property
     def color(self) -> Color: ...
     @color.setter
-    def color(self, value: ColorValue) -> None: ...
+    def color(self, value: ColorLike) -> None: ...
 
     def get_rect(self, **kwargs: Any) -> Rect: ...
     def draw(
         self,
-        srcrect: Optional[RectValue] = None,
-        dstrect: Optional[RectValue] = None,
+        srcrect: Optional[RectLike] = None,
+        dstrect: Optional[RectLike] = None,
         angle: float = 0.0,
         origin: Optional[Iterable[int]] = None,
         flip_x: bool = False,
@@ -99,17 +99,17 @@ class Texture:
         p3_mod: Iterable[int] = (255, 255, 255, 255),
         p4_mod: Iterable[int] = (255, 255, 255, 255),
     ) -> None: ...
-    def update(self, surface: Surface, area: Optional[RectValue] = None) -> None: ...
+    def update(self, surface: Surface, area: Optional[RectLike] = None) -> None: ...
 
 class Image:
     def __init__(
         self,
         texture_or_image: Union[Texture, Image],
-        srcrect: Optional[RectValue] = None,
+        srcrect: Optional[RectLike] = None,
     ) -> None: ...
     def get_rect(self) -> Rect: ...
     def draw(
-        self, srcrect: Optional[RectValue] = None, dstrect: Optional[RectValue] = None
+        self, srcrect: Optional[RectLike] = None, dstrect: Optional[RectLike] = None
     ) -> None: ...
     angle: float
     origin: Optional[Iterable[float]]
@@ -123,7 +123,7 @@ class Image:
     @property
     def color(self) -> Color: ...
     @color.setter
-    def color(self, value: ColorValue) -> None: ...
+    def color(self, value: ColorLike) -> None: ...
 
 class Renderer:
     def __init__(
@@ -140,25 +140,25 @@ class Renderer:
     @property
     def draw_color(self) -> Color: ...
     @draw_color.setter
-    def draw_color(self, value: ColorValue) -> None: ...
+    def draw_color(self, value: ColorLike) -> None: ...
     def clear(self) -> None: ...
     def present(self) -> None: ...
     def get_viewport(self) -> Rect: ...
-    def set_viewport(self, area: Optional[RectValue]) -> None: ...
+    def set_viewport(self, area: Optional[RectLike]) -> None: ...
     logical_size: Iterable[int]
     scale: Iterable[float]
     target: Optional[Texture]
     def blit(
         self,
         source: Union[Texture, Image],
-        dest: Optional[RectValue] = None,
-        area: Optional[RectValue] = None,
+        dest: Optional[RectLike] = None,
+        area: Optional[RectLike] = None,
         special_flags: int = 0,
     ) -> Rect: ...
     def draw_line(self, p1: Coordinate, p2: Coordinate) -> None: ...
     def draw_point(self, point: Coordinate) -> None: ...
-    def draw_rect(self, rect: RectValue) -> None: ...
-    def fill_rect(self, rect: RectValue) -> None: ...
+    def draw_rect(self, rect: RectLike) -> None: ...
+    def fill_rect(self, rect: RectLike) -> None: ...
     def draw_triangle(
         self, p1: Coordinate, p2: Coordinate, p3: Coordinate
     ) -> None: ...
@@ -172,7 +172,7 @@ class Renderer:
         self, p1: Coordinate, p2: Coordinate, p3: Coordinate, p4: Coordinate
     ) -> None: ...
     def to_surface(
-        self, surface: Optional[Surface] = None, area: Optional[RectValue] = None
+        self, surface: Optional[Surface] = None, area: Optional[RectLike] = None
     ) -> Surface: ...
     @staticmethod
     def compose_custom_blend_mode(

buildconfig/stubs/pygame/_sdl2/video.pyi

@@ -1,7 +1,7 @@
 from abc import ABC, abstractmethod
 from typing import List, Optional, Tuple, Union, Literal
 
-from ._common import IntCoordinate
+from pygame.typing import IntCoordinate
 
 from pygame.surface import Surface