Merge pull request #579 from hx2A/intel-silicon-problem

Intel silicon problem

Author: hx2A

environment.yml

@@ -33,4 +33,4 @@ dependencies:
   - pip:
     - bump2version==1.0.*
     - stackprinter==0.2.11
-    - opencv-contrib-python>=4.10.*
+    - opencv-contrib-python>=4.10

py5_jar/src/main/java/py5/core/SketchBase.java

@@ -123,7 +123,7 @@ public void py5Println(String text, boolean stderr) {
   @Override
   public void exit() {
     if (!interceptEscape) {
-      if (platform == MACOS && g.isGL() && !isLooping()) {
+      if (platform == MACOS && g != null && g.isGL() && surface != null && !isLooping()) {
         loop();
       }
       super.exit();

py5_resources/data/sketch.csv

@@ -254,7 +254,7 @@ concat,concat,,method,data,array_functions,SKIP,user should use python instead
 split,split,,method,data,string_functions,SKIP,user should use python instead
 join,join,,method,data,string_functions,SKIP,user should use python instead
 trim,trim,,method,data,string_functions,SKIP,user should use python instead
-size,size,@_settings_only('size'),method,environment,,JAVA,
+size,size,@_settings_only('size');@_macos_safety_check,method,environment,,JAVA,
 fill,fill,@_convert_hex_color(),method,color,setting,JAVA,
 apply_filter,filter,,method,image,pixels,JAVA,filter method has name conflict with python builtin function; replaced with apply_filter method
 second,second,,static method,input,time_date,JAVA,

py5_resources/py5_module/py5/__init__.py

@@ -37,10 +37,13 @@
 import numpy as np  # noqa
 import numpy.typing as npt  # noqa
 import py5_tools
+import py5_tools.environ  # noqa
 from jpype import JClass  # noqa
 from jpype.types import JArray, JChar, JFloat, JInt, JString  # noqa
 from PIL import Image  # noqa
 
+_environ = py5_tools.environ.Environment()
+
 if not py5_tools.is_jvm_running():
     base_path = (
         Path(getattr(sys, "_MEIPASS")) / "py5"
@@ -318,3 +321,11 @@ def _prepare_dynamic_variables(caller_locals, caller_globals):
 
 
 _prepare_dynamic_variables(locals(), globals())
+
+
+if platform.system() == "Darwin" and _environ.in_ipython_session:
+    if _environ.ipython_shell.active_eventloop != "osx":
+        print(
+            "Importing py5 on macOS but the necessary Jupyter macOS event loop has not been activated. I'll activate it for you, but next time, execute `%gui osx` before importing this library."
+        )
+        _environ.ipython_shell.run_line_magic("gui", "osx")

py5_resources/py5_module/py5/macos_problem.py

@@ -0,0 +1,122 @@
+# *****************************************************************************
+#
+#   Part of the py5 library
+#   Copyright (C) 2020-2024 Jim Schmitz
+#
+#   This library is free software: you can redistribute it and/or modify it
+#   under the terms of the GNU Lesser General Public License as published by
+#   the Free Software Foundation, either version 2.1 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 Lesser
+#   General Public License for more details.
+#
+#   You should have received a copy of the GNU Lesser General Public License
+#   along with this library. If not, see <https://www.gnu.org/licenses/>.
+#
+# *****************************************************************************
+import functools
+import platform
+
+from py5_tools.environ import Environment
+
+_environ = Environment()
+
+_enforce_safety_check = (
+    platform.system() == "Darwin"
+    and (
+        platform.processor() == "i386"
+        or int(platform.mac_ver()[0].split(".", 1)[0]) < 14
+    )
+    and _environ.in_ipython_session
+)
+_first_renderer_opengl = None
+
+
+def disable_safety_check():
+    global _enforce_safety_check
+    _enforce_safety_check = False
+
+
+def enable_safety_check():
+    global _enforce_safety_check
+    _enforce_safety_check = True
+
+
+OPENGL_RENDERERS = [
+    "processing.opengl.PGraphics2D",
+    "processing.opengl.PGraphics3D",
+]
+
+MESSAGE = """Sorry, but you can't use an OpenGL renderer in your Sketch right now. Doing so might cause Python to crash.
+
+Here's the problem: On macOS machines with Intel CPUs and/or older macOS versions, this version of py5 seems to crash when you use an OpenGL renderer in an IPython or Jupyter session if the first Sketch run in that Python session used the default (JAVA2D) renderer. Sorry if that sounds crazy. This is an unfortunate side effect of an important code change that significantly improved py5 for all macOS users.
+
+The root issue is somewhere in native macOS code that Processing and py5 both depend on. Hopefully in the future we will find a real fix or a better workaround.
+
+You are seeing this message because this version of py5 has a safety feature that detects the sequence of events that might lead to this crash. However, if you'd like to disable this safety feature (and risk Python crashing), use the following code:
+
+    from py5 import macos_problem
+
+    macos_problem.disable_safety_check()
+
+But before doing that, it would be great if you could do a quick test for us. Please run the following code in a new Jupyter Notebook or IPython REPL, with each line of code executed separately:
+
+    from py5 import macos_problem, test
+
+    macos_problem.disable_safety_check()
+
+    # run a Sketch with the default renderer
+    test.test_java2d()
+
+    # run a Sketch with an opengl renderer
+    # does this cause a crash???
+    test.test_p2d()
+
+Then report your findings to the below GitHub issue thread. Include your macOS version and CPU type. (For your convenience, this information will be displayed at the end of this message.) Your feedback will help us understand the problem better and more accurately calibrate this crash protection feature.
+
+https://github.com/py5coding/py5generator/issues/578
+
+If the above test code doesn't cause Python to crash on your machine, great! You can keep using that `disable_safety_check()` function so you never see this warning again. But please take the time report your findings to the GitHub issue thread. The next version of py5 will incorporate your feedback and the safety feature will be adjusted accordingly.
+
+If the above test code does cause Python to crash on your machine, it's OK. If you really need to mix Java2D and OpenGL renderers together in one Python session, you just need to make sure that the first executed Sketch is always an OpenGL Sketch. For convenience, you can use the following code to open a quick Sketch right after importing py5. This will ensure the first Sketch is always an OpenGL Sketch, eliminating the problem (and this warning) entirely:
+
+    import py5
+    from py5 import test
+
+    test.test_p2d()
+
+If you'd like to read about our progress understanding this issue, please visit the above GitHub issue thread.
+
+Sorry again for the weird limitation. We're doing our best to make py5 as stable as possible. This safety feature is here because we don't want users to become upset because Python crashed for confusing reasons. Thank you for your understanding.
+"""
+
+
+def _macos_safety_check(f):
+    @functools.wraps(f)
+    def decorated(self_, *args):
+        global _first_renderer_opengl
+        if _enforce_safety_check:
+            if _first_renderer_opengl is None:
+                # This is the first Sketch. Record if the renderer is OpenGL.
+                if len(args) >= 2 and args[2] in OPENGL_RENDERERS:
+                    _first_renderer_opengl = True
+                else:
+                    _first_renderer_opengl = False
+
+            elif _first_renderer_opengl is False:
+                # The first Sketch was not OpenGL. OpenGL is not allowed now.
+                if len(args) >= 2 and args[2] in OPENGL_RENDERERS:
+                    self_.println(MESSAGE)
+                    if platform.system() == "Darwin":  # just in case
+                        self_.println("macOS version:", platform.mac_ver()[0])
+                    self_.println("macOS CPU type:", platform.processor())
+                    raise RuntimeError(
+                        "Halting Sketch startup to prevent Python from crashing"
+                    )
+
+        f(self_, *args)
+
+    return decorated

py5_resources/py5_module/py5/sketch.py

@@ -55,6 +55,7 @@
 from .graphics import Py5Graphics, _return_py5graphics  # noqa
 from .image import Py5Image, _return_py5image  # noqa
 from .keyevent import Py5KeyEvent, _convert_jchar_to_chr, _convert_jint_to_int  # noqa
+from .macos_problem import _macos_safety_check
 from .mixins import DataMixin, MathMixin, PixelMixin, PrintlnStream, ThreadsMixin
 from .mixins.threads import Py5Promise  # noqa
 from .mouseevent import Py5MouseEvent  # noqa
@@ -78,18 +79,6 @@
 _Sketch = jpype.JClass("py5.core.Sketch")
 _SketchBase = jpype.JClass("py5.core.SketchBase")
 
-_environ = py5_tools.environ.Environment()
-if (
-    sys.platform == "darwin"
-    and _environ.in_ipython_session
-    and _environ.ipython_shell.active_eventloop != "osx"
-):
-    print(
-        "Importing py5 on macOS but the necessary Jupyter macOS event loop has not been activated. I'll activate it for you, but next time, execute `%gui osx` before importing this library."
-    )
-    _environ.ipython_shell.run_line_magic("gui", "osx")
-
-
 _PY5_LAST_WINDOW_X = None
 _PY5_LAST_WINDOW_Y = None
 
@@ -222,7 +211,6 @@ def __init__(self, *args, **kwargs):
         # must always keep the _py5_bridge reference count from hitting zero.
         # otherwise, it will be garbage collected and lead to segmentation faults!
         self._py5_bridge = None
-        self._environ = None
         # TODO: shouldn't this be like the base_path variable in __init__.py?
         iconPath = Path(__file__).parent.parent / "py5_tools/resources/logo-64x64.png"
         if iconPath.exists() and hasattr(self._instance, "setPy5IconPath"):
@@ -312,7 +300,7 @@ def _run_sketch(
         _caller_globals: dict[str, Any] = None,
         _osx_alt_run_method: bool = True,
     ) -> None:
-        self._environ = _environ
+        self._environ = py5_tools.environ.Environment()
         self.set_println_stream(
             _DisplayPubPrintlnStream()
             if self._environ.in_jupyter_zmq_shell

py5_resources/py5_module/py5/test.py

@@ -0,0 +1,101 @@
+# *****************************************************************************
+#
+#   Part of the py5 library
+#   Copyright (C) 2020-2024 Jim Schmitz
+#
+#   This library is free software: you can redistribute it and/or modify it
+#   under the terms of the GNU Lesser General Public License as published by
+#   the Free Software Foundation, either version 2.1 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 Lesser
+#   General Public License for more details.
+#
+#   You should have received a copy of the GNU Lesser General Public License
+#   along with this library. If not, see <https://www.gnu.org/licenses/>.
+#
+# *****************************************************************************
+from pathlib import Path
+
+from .sketch import Sketch
+
+
+class RendererTest(Sketch):
+
+    def __init__(self, renderer, renderer_name):
+        super().__init__()
+        self.renderer = renderer
+        self.renderer_name = renderer_name
+
+    def settings(self):
+        self.size(150, 150, self.renderer)
+
+    def setup(self):
+        self.text_align(self.CENTER, self.CENTER)
+        self.text_size(20)
+        self.image_mode(self.CENTER)
+        self.fill(24)
+
+        self.logo = self.load_image(
+            Path(__file__).parent.parent / "py5_tools/resources/logo-64x64.png"
+        )
+
+    def draw(self):
+        self.background(240)
+        self.image(self.logo, self.width / 2, 50)
+        self.text("testing " + self.renderer_name, self.width / 2, 125)
+
+        if self.frame_count == 60:
+            self.exit_sketch()
+
+
+def test_java2d():
+    test = RendererTest(Sketch.JAVA2D, "JAVA2D")
+    test.run_sketch()
+
+
+def test_p2d():
+    test = RendererTest(Sketch.P2D, "P2D")
+    test.run_sketch()
+
+
+def test_p3d():
+    test = RendererTest(Sketch.P3D, "P3D")
+    test.run_sketch()
+
+
+class TestInteractivity(Sketch):
+
+    def __init__(self, renderer, renderer_name):
+        super().__init__()
+        self.renderer = renderer
+        self.renderer_name = renderer_name
+
+    def settings(self):
+        self.size(250, 250, self.renderer)
+
+    def setup(self):
+        self.rect_mode(self.CENTER)
+
+    def draw(self):
+        self.rect(self.mouse_x, self.mouse_y, 10, 10)
+
+    def key_pressed(self):
+        self.println("key =", self.key)
+
+
+def test_interactivity_java2d():
+    test = TestInteractivity(Sketch.JAVA2D, "JAVA2D")
+    test.run_sketch()
+
+
+def test_interactivity_p2d():
+    test = TestInteractivity(Sketch.P2D, "P2D")
+    test.run_sketch()
+
+
+def test_interactivity_p3d():
+    test = TestInteractivity(Sketch.P3D, "P3D")
+    test.run_sketch()