475 lines
13 KiB
Python
475 lines
13 KiB
Python
# pygame-ce - Python Game Library
|
|
# Copyright (C) 2000-2001 Pete Shinners
|
|
#
|
|
# This library is free software; you can redistribute it and/or
|
|
# modify it under the terms of the GNU Library General Public
|
|
# License as published by the Free Software Foundation; either
|
|
# version 2 of the License, or (at your option) any later version.
|
|
#
|
|
# This library is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
# Library General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Library General Public
|
|
# License along with this library; if not, write to the Free
|
|
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
#
|
|
# Pete Shinners
|
|
# pete@shinners.org
|
|
"""Pygame is a set of Python modules designed for writing games.
|
|
It is written on top of the excellent SDL library. This allows you
|
|
to create fully featured games and multimedia programs in the python
|
|
language. The package is highly portable, with games running on
|
|
Windows, macOS, OS X, BeOS, FreeBSD, IRIX, and Linux."""
|
|
|
|
import os
|
|
import sys
|
|
import platform
|
|
|
|
# Choose Windows display driver
|
|
if os.name == "nt":
|
|
pygame_dir = os.path.split(__file__)[0]
|
|
dll_parents = {pygame_dir}
|
|
try:
|
|
# For editable support, add some more folders where DLLs are available.
|
|
# This block only executes under an editable install. In a "normal"
|
|
# install, the json file will not be installed at the supplied path.
|
|
with open(
|
|
os.path.join(
|
|
os.path.dirname(pygame_dir), "buildconfig", "win_dll_dirs.json"
|
|
),
|
|
encoding="utf-8",
|
|
) as f:
|
|
import json
|
|
|
|
dll_parents.update(json.load(f))
|
|
del json
|
|
except (FileNotFoundError, ValueError):
|
|
pass
|
|
|
|
d = "" # define variable here so that we can consistently delete it
|
|
for d in dll_parents:
|
|
# adding to PATH is the legacy way, os.add_dll_directory is the new
|
|
# and recommended method. For extra safety we do both
|
|
os.environ["PATH"] = os.environ["PATH"] + ";" + d
|
|
os.add_dll_directory(d)
|
|
|
|
# cleanup namespace
|
|
del pygame_dir, dll_parents, d
|
|
|
|
# when running under X11, always set the SDL window WM_CLASS to make the
|
|
# window managers correctly match the pygame window.
|
|
elif "DISPLAY" in os.environ and "SDL_VIDEO_X11_WMCLASS" not in os.environ:
|
|
os.environ["SDL_VIDEO_X11_WMCLASS"] = os.path.basename(sys.argv[0])
|
|
|
|
|
|
def _attribute_undefined(name):
|
|
raise RuntimeError(f"{name} is not available")
|
|
|
|
|
|
class MissingModule:
|
|
_NOT_IMPLEMENTED_ = True
|
|
|
|
def __init__(self, name, urgent=0):
|
|
self.name = name
|
|
exc_type, exc_msg, _ = sys.exc_info()
|
|
if exc_type is not None:
|
|
self.info = str(exc_msg)
|
|
self.reason = f"{exc_type.__name__}: {self.info}"
|
|
else:
|
|
self.info = "<no info>"
|
|
self.reason = f"<no exception>: {self.info}"
|
|
self.urgent = urgent
|
|
if urgent:
|
|
self.warn()
|
|
|
|
def __getattr__(self, var):
|
|
if not self.urgent:
|
|
self.warn()
|
|
self.urgent = 1
|
|
missing_msg = f"{self.name} module not available ({self.reason})"
|
|
raise NotImplementedError(missing_msg)
|
|
|
|
def __bool__(self):
|
|
return False
|
|
|
|
def warn(self):
|
|
msg_type = "import" if self.urgent else "use"
|
|
message = f"{msg_type} {self.name}: {self.info}\n({self.reason})"
|
|
try:
|
|
import warnings
|
|
|
|
level = 4 if self.urgent else 3
|
|
warnings.warn(message, RuntimeWarning, level)
|
|
except ImportError:
|
|
print(message)
|
|
|
|
|
|
# This is a special loader for WebAssembly platform
|
|
# where pygame is in fact statically linked
|
|
# mixing single phase (C) and multiphase modules (cython)
|
|
if sys.platform in ("wasi", "emscripten"):
|
|
try:
|
|
import pygame.base as pygame_static
|
|
except ModuleNotFoundError:
|
|
pygame_static = None
|
|
|
|
if pygame_static:
|
|
pygame = sys.modules[__name__]
|
|
|
|
# cython modules use multiphase initialisation when not in builtin Inittab.
|
|
|
|
from pygame import _sdl2
|
|
|
|
import importlib.machinery
|
|
|
|
loader = importlib.machinery.FrozenImporter
|
|
spec = importlib.machinery.ModuleSpec("", loader)
|
|
pygame_static.import_cython(spec)
|
|
del loader, spec
|
|
del pygame_static
|
|
|
|
|
|
# we need to import like this, each at a time. the cleanest way to import
|
|
# our modules is with the import command (not the __import__ function)
|
|
# isort: skip_file
|
|
|
|
# first, the "required" modules
|
|
from pygame.base import * # pylint: disable=wildcard-import; lgtm[py/polluting-import]
|
|
from pygame.constants import * # now has __all__ pylint: disable=wildcard-import; lgtm[py/polluting-import]
|
|
from pygame.version import * # pylint: disable=wildcard-import; lgtm[py/polluting-import]
|
|
from pygame.rwobject import encode_string, encode_file_path
|
|
|
|
|
|
import pygame.rect
|
|
|
|
Rect = pygame.rect.Rect
|
|
FRect = pygame.rect.FRect
|
|
|
|
|
|
import pygame.color
|
|
|
|
Color = pygame.color.Color
|
|
|
|
import pygame.bufferproxy
|
|
|
|
BufferProxy = pygame.bufferproxy.BufferProxy
|
|
|
|
import pygame.math
|
|
|
|
Vector2 = pygame.math.Vector2
|
|
Vector3 = pygame.math.Vector3
|
|
|
|
|
|
from pygame.base import __version__
|
|
|
|
# next, the "standard" modules
|
|
# we still allow them to be missing for stripped down pygame distributions
|
|
try:
|
|
import pygame.display
|
|
except (ImportError, OSError):
|
|
display = MissingModule("display", urgent=1)
|
|
|
|
try:
|
|
import pygame.draw
|
|
except (ImportError, OSError):
|
|
draw = MissingModule("draw", urgent=1)
|
|
|
|
try:
|
|
import pygame.event
|
|
from pygame.event import Event
|
|
except (ImportError, OSError):
|
|
event = MissingModule("event", urgent=1)
|
|
|
|
try:
|
|
import pygame.image
|
|
except (ImportError, OSError):
|
|
image = MissingModule("image", urgent=1)
|
|
|
|
try:
|
|
import pygame.joystick
|
|
from pygame.joystick import Joystick
|
|
except (ImportError, OSError):
|
|
joystick = MissingModule("joystick", urgent=1)
|
|
|
|
try:
|
|
import pygame.key
|
|
except (ImportError, OSError):
|
|
key = MissingModule("key", urgent=1)
|
|
|
|
try:
|
|
import pygame.mouse
|
|
except (ImportError, OSError):
|
|
mouse = MissingModule("mouse", urgent=1)
|
|
|
|
try:
|
|
import pygame.cursors
|
|
from pygame.cursors import Cursor
|
|
except (ImportError, OSError):
|
|
cursors = MissingModule("cursors", urgent=1)
|
|
|
|
def Cursor(*args): # pylint: disable=unused-argument
|
|
_attribute_undefined("pygame.Cursor")
|
|
|
|
|
|
try:
|
|
import pygame.pixelcopy
|
|
except (ImportError, OSError):
|
|
pixelcopy = MissingModule("pixelcopy", urgent=1)
|
|
|
|
|
|
try:
|
|
import pygame.surflock
|
|
from pygame.surface import Surface, SurfaceType
|
|
except (ImportError, OSError):
|
|
|
|
def Surface(size, flags, depth, masks): # pylint: disable=unused-argument
|
|
_attribute_undefined("pygame.Surface")
|
|
|
|
SurfaceType = Surface
|
|
|
|
# sprite.py is using pygame.surface.Surface type
|
|
try:
|
|
import pygame.sprite
|
|
except (ImportError, OSError):
|
|
sprite = MissingModule("sprite", urgent=1)
|
|
|
|
|
|
try:
|
|
import pygame.mask
|
|
from pygame.mask import Mask
|
|
except (ImportError, OSError):
|
|
mask = MissingModule("mask", urgent=0)
|
|
|
|
def Mask(size, fill): # pylint: disable=unused-argument
|
|
_attribute_undefined("pygame.Mask")
|
|
|
|
|
|
try:
|
|
from pygame.pixelarray import PixelArray
|
|
except (ImportError, OSError):
|
|
|
|
def PixelArray(surface): # pylint: disable=unused-argument
|
|
_attribute_undefined("pygame.PixelArray")
|
|
|
|
|
|
try:
|
|
import pygame.time
|
|
from pygame.time import Clock
|
|
except (ImportError, OSError):
|
|
time = MissingModule("time", urgent=1)
|
|
|
|
try:
|
|
import pygame.transform
|
|
except (ImportError, OSError):
|
|
transform = MissingModule("transform", urgent=1)
|
|
|
|
# lastly, the "optional" pygame modules
|
|
if "PYGAME_FREETYPE" in os.environ:
|
|
try:
|
|
import pygame.ftfont as font
|
|
|
|
sys.modules["pygame.font"] = font
|
|
except (ImportError, OSError):
|
|
pass
|
|
try:
|
|
import pygame.font
|
|
import pygame.sysfont
|
|
|
|
from pygame.font import Font
|
|
|
|
pygame.font.SysFont = pygame.sysfont.SysFont
|
|
pygame.font.get_fonts = pygame.sysfont.get_fonts
|
|
pygame.font.match_font = pygame.sysfont.match_font
|
|
except (ImportError, OSError):
|
|
font = MissingModule("font", urgent=0)
|
|
|
|
# try to load pygame.mixer_music before mixer, for py2app...
|
|
try:
|
|
import pygame.mixer_music
|
|
|
|
# del pygame.mixer_music
|
|
# print("NOTE2: failed importing pygame.mixer_music in lib/__init__.py")
|
|
except (ImportError, OSError):
|
|
pass
|
|
|
|
try:
|
|
import pygame.mixer
|
|
from pygame.mixer import Sound
|
|
from pygame.mixer import Channel
|
|
except (ImportError, OSError):
|
|
mixer = MissingModule("mixer", urgent=0)
|
|
|
|
try:
|
|
import pygame.scrap
|
|
except (ImportError, OSError):
|
|
scrap = MissingModule("scrap", urgent=0)
|
|
|
|
# Two lazily imported modules to avoid loading numpy unnecessarily
|
|
|
|
from importlib.util import LazyLoader, find_spec, module_from_spec
|
|
|
|
|
|
def lazy_import(name):
|
|
"""Lazily import a pygame module.
|
|
|
|
See https://docs.python.org/3/library/importlib.html#implementing-lazy-imports
|
|
Only load the module upon its first attribute access.
|
|
|
|
Lazily imported modules are directly referenced in packager_imports function.
|
|
"""
|
|
fullname = "pygame." + name
|
|
spec = find_spec(fullname)
|
|
if spec is None or spec.loader is None:
|
|
return MissingModule(name, urgent=0)
|
|
loader = LazyLoader(spec.loader)
|
|
spec.loader = loader
|
|
module = module_from_spec(spec)
|
|
sys.modules[fullname] = module
|
|
loader.exec_module(module)
|
|
return module
|
|
|
|
|
|
# Check if numpy is available for surfarray and sndarray modules
|
|
numpy_missing = find_spec("numpy") is None
|
|
|
|
try:
|
|
if numpy_missing:
|
|
# Always fails here. Need the error message for MissingModule.reason
|
|
import numpy # pylint: disable=ungrouped-imports
|
|
# Check that module dependencies are not missing, or get error message
|
|
import pygame.pixelcopy # pylint: disable=ungrouped-imports
|
|
except (ImportError, OSError):
|
|
surfarray = MissingModule("surfarray", urgent=0)
|
|
else:
|
|
surfarray = lazy_import("surfarray")
|
|
|
|
try:
|
|
if numpy_missing:
|
|
# Always fails here. Need the error message for MissingModule.reason
|
|
import numpy # pylint: disable=ungrouped-imports
|
|
# Check that module dependencies are not missing, or get error message
|
|
import pygame.mixer # pylint: disable=ungrouped-imports
|
|
except (ImportError, OSError):
|
|
sndarray = MissingModule("sndarray", urgent=0)
|
|
else:
|
|
sndarray = lazy_import("sndarray")
|
|
|
|
del LazyLoader, find_spec, lazy_import, module_from_spec, numpy_missing
|
|
|
|
try:
|
|
import pygame._debug
|
|
from pygame._debug import print_debug_info
|
|
except (ImportError, OSError):
|
|
debug = MissingModule("_debug", urgent=0)
|
|
|
|
try:
|
|
import pygame.system
|
|
from pygame._data_classes import PowerState as power_state
|
|
|
|
power_state.__module__ = "pygame.system"
|
|
del power_state
|
|
except (ImportError, OSError):
|
|
system = MissingModule("system", urgent=0)
|
|
|
|
try:
|
|
from pygame.window import Window
|
|
except (ImportError, OSError):
|
|
|
|
def Window(title="pygame window", size=(640, 480), position=None, **kwargs): # pylint: disable=unused-argument
|
|
_attribute_undefined("pygame.Window")
|
|
|
|
|
|
try:
|
|
import pygame.typing
|
|
except (ImportError, OSError):
|
|
typing = MissingModule("typing", urgent=0)
|
|
|
|
|
|
# there's also a couple "internal" modules not needed
|
|
# by users, but putting them here helps "dependency finder"
|
|
# programs get everything they need (like py2exe)
|
|
try:
|
|
import pygame.imageext
|
|
|
|
del pygame.imageext
|
|
except (ImportError, OSError):
|
|
pass
|
|
|
|
# this internal module needs to be included for dependency
|
|
# finders, but can't be deleted, as some tests need it
|
|
try:
|
|
import pygame.pkgdata
|
|
|
|
except (ImportError, OSError):
|
|
pass
|
|
|
|
|
|
def packager_imports():
|
|
"""Some additional imports that py2app/py2exe will want to see.
|
|
|
|
This function is never executed.
|
|
Some tools scan the source code for import statements.
|
|
"""
|
|
import atexit
|
|
import numpy
|
|
import OpenGL.GL
|
|
import pygame.macosx
|
|
import pygame.colordict
|
|
|
|
# lazy imports
|
|
import pygame.surfarray
|
|
import pygame.sndarray
|
|
|
|
|
|
# make Rects pickleable
|
|
|
|
import copyreg
|
|
|
|
|
|
def __rect_constructor(x, y, w, h):
|
|
return Rect(x, y, w, h)
|
|
|
|
|
|
def __rect_reduce(r):
|
|
assert isinstance(r, Rect)
|
|
return __rect_constructor, (r.x, r.y, r.w, r.h)
|
|
|
|
|
|
copyreg.pickle(Rect, __rect_reduce, __rect_constructor)
|
|
|
|
|
|
# make Colors pickleable
|
|
def __color_constructor(r, g, b, a):
|
|
return Color(r, g, b, a)
|
|
|
|
|
|
def __color_reduce(c):
|
|
assert isinstance(c, Color)
|
|
return __color_constructor, (c.r, c.g, c.b, c.a)
|
|
|
|
|
|
copyreg.pickle(Color, __color_reduce, __color_constructor)
|
|
|
|
if "PYGAME_HIDE_SUPPORT_PROMPT" not in os.environ:
|
|
import sysconfig
|
|
|
|
python_version = platform.python_version()
|
|
|
|
if (
|
|
sys.platform not in ("wasi", "emscripten")
|
|
and (sys.version_info >= (3, 13, 0))
|
|
and sysconfig.get_config_var("Py_GIL_DISABLED")
|
|
):
|
|
python_version += f"t, {'' if sys._is_gil_enabled() else 'No '}GIL"
|
|
|
|
print(
|
|
f"pygame-ce {ver} (SDL {'.'.join(map(str, get_sdl_version()))}, "
|
|
f"Python {python_version})"
|
|
)
|
|
del python_version, sysconfig
|
|
|
|
# cleanup namespace
|
|
del pygame, os, sys, platform, MissingModule, copyreg, packager_imports
|