monkey patch python 3.13 shutdown

Author: vijaiaeroastro

.github/workflows/python-package.yml

@@ -1,6 +1,12 @@
 name: Build, Test, and Publish Wheel
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - "**"
+    tags:
+      - "v*"
+  pull_request:
 
 jobs:
   build:
@@ -165,7 +171,8 @@ jobs:
   publish:
     needs: [test-linux, test-windows, test-macos]
     runs-on: ubuntu-latest
-    if: "${{ contains(github.event.head_commit.message, 'PUBLISH_NOW') }}"
+    # Publish only when a version tag (v*) is pushed
+    if: startsWith(github.ref, 'refs/tags/v')
 
     steps:
     - uses: actions/checkout@v4
@@ -198,4 +205,4 @@ jobs:
       env:
         TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
         TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
-      run: twine upload dist/*
+      run: twine upload dist/*

.gitignore

@@ -2,4 +2,5 @@
 *.pyc
 build
 dist
+.idea
 lib3mf.egg-info

README.md

@@ -34,5 +34,6 @@ This script automatically detects the platform and builds the appropriate wheel.
 ## Automatic python wheel building and publishing
 
 Every commit automatically builds and tests the python wheels for all 3 platforms.
-However, to publish them to PyPI, the commit message should contain the string `PUBLISH_NOW`
-Without this string, deployment to PyPI will be skipped.
+Publishing to PyPI now happens only when a version tag is pushed (e.g. `v1.2.3`).
+Push a tag after merging to trigger the publish step; regular commits and PRs continue
+to build and test without deploying.

create_cube_example_complete.py examples/create_cube_example_complete.pycreate_cube_example_complete.py renamed to examples/create_cube_example_complete.py

@@ -8,7 +8,6 @@
 # Determine the current operating system
 system = platform.system().lower()
 
-
 # Determine the platform and choose the right library extension
 if system == "linux":
     lib_file = "lib3mf.so"
@@ -23,40 +22,80 @@
 dir_path = os.path.dirname(os.path.realpath(__file__))
 lib_path = os.path.join(dir_path, lib_file)
 
-
 if not os.path.exists(lib_path):
     raise ImportError(f"The required binary {lib_path} could not be found in {dir_path}")
 
 # Add the path to the system path if necessary (useful for DLLs on Windows)
 sys.path.append(dir_path)
 
-# Ensure that your Lib3MF.py wraps around the shared library correctly
-from .Lib3MF import *  # Import necessary classes/functions from your Lib3MF.py
+# Import generated bindings
+from .Lib3MF import *
+
+
+# ---------------------------
+# Public helpers
+# ---------------------------
 
-# Returns the raw library path
 def get_library_path():
     global lib_path
     return lib_path
 
-# For existing codes that use Wrapper class directly
+
 def get_library_path_for_wrapper():
     global lib_path
-    if system == "linux":
-        if str(lib_path).endswith(".so"):
-            return lib_path[:-3]
-    if system == "windows":
-        if str(lib_path).endswith(".dll"):
-            return lib_path[:-4]
-    if system == "darwin":
-        if str(lib_path).endswith(".dylib"):
-            return lib_path[:-6]
-
-# Your existing logic to use the library
+    path_str = str(lib_path)
+
+    if system == "linux" and path_str.endswith(".so"):
+        return path_str[:-3]
+    if system == "windows" and path_str.endswith(".dll"):
+        return path_str[:-4]
+    if system == "darwin" and path_str.endswith(".dylib"):
+        return path_str[:-6]
+
+    base, _ext = os.path.splitext(path_str)
+    return base
+
+
 def get_wrapper():
-    global lib_path
+    from . import Lib3MF as _Lib3MF
     try:
-        # No need to modify lib_path here; just use it directly in your wrapper
-        return Wrapper(get_library_path_for_wrapper())
-    except ELib3MFException as e:
+        return _Lib3MF.Wrapper(get_library_path_for_wrapper())
+    except _Lib3MF.ELib3MFException as e:
         print("Failed to initialize the Lib3MF wrapper: ", e)
         raise
+
+
+# ---------------------------------------------------------------------------
+# PYTHON 3.13 SHUTDOWN SAFETY MONKEY PATCH
+#
+# Fixes:
+#   Exception ignored in: Base.__del__
+#   AttributeError: 'NoneType' object has no attribute 'SUCCESS'
+#
+# Root cause:
+#   During interpreter shutdown, Lib3MF.ErrorCodes becomes None.
+#   Base.__del__ -> Wrapper.Release -> checkError -> ErrorCodes.SUCCESS
+#
+# Solution:
+#   Patch Wrapper.checkError to NO-OP if ErrorCodes is already None.
+#
+# This preserves full runtime behavior and only affects shutdown.
+# ---------------------------------------------------------------------------
+
+try:
+    from . import Lib3MF as _Lib3MF
+
+    _original_checkError = _Lib3MF.Wrapper.checkError
+
+    def _patched_checkError(self, instance, errorCode):
+        ec = getattr(_Lib3MF, "ErrorCodes", None)
+        if ec is None:
+            # Interpreter shutdown: suppress destructor noise
+            return
+        return _original_checkError(self, instance, errorCode)
+
+    _Lib3MF.Wrapper.checkError = _patched_checkError
+
+except Exception:
+    # Never block import if bindings differ slightly
+    pass

lib3mf/__init__.py

@@ -1,21 +1,22 @@
 import os
 import sys
-import requests
-import zipfile
 import io
 import shutil
 import subprocess
+import zipfile
+
+import requests
 
 # Download SDK directly to zip object
 def download_sdk_zip(url):
-    response = requests.get(url)
+    response = requests.get(url, timeout=30)
     if response.status_code == 200:
         return zipfile.ZipFile(io.BytesIO(response.content))
     else:
         raise Exception(f"Failed to download SDK zip from {url}")
 
 def download_file(url):
-    response = requests.get(url)
+    response = requests.get(url, timeout=30)
     if response.status_code == 200:
         return response.text
     else:
@@ -26,10 +27,16 @@ def clean_lib3mf_directory(lib3mf_dir):
     valid_extensions = {'.so', '.dylib', '.dll', 'Lib3MF.py', '__init__.py'}
     before_path = os.getcwd()
     os.chdir(lib3mf_dir)
-    for item in os.listdir():
-        if not any(item.endswith(ext) for ext in valid_extensions):
-            os.unlink(item)
-    os.chdir(before_path)
+    try:
+        for item in os.listdir():
+            if any(item.endswith(ext) for ext in valid_extensions):
+                continue
+            if os.path.isdir(item):
+                shutil.rmtree(item)
+            else:
+                os.unlink(item)
+    finally:
+        os.chdir(before_path)
     print("Remove unnecessary files and cleaned up the lib3mf directory")
 
 
@@ -69,12 +76,17 @@ def update_readme(version):
     readme_content = download_file(readme_url)
 
     # Read the example script content
-    with open("create_cube_example_complete.py", "r", encoding="utf-8") as file:
+    with open("examples/create_cube_example_complete.py", "r", encoding="utf-8") as file:
         create_cube_example_complete = file.read()
 
     # Insert the example before the documentation section
-    readme_parts = readme_content.split("## Documentation")
-    readme_content = readme_parts[0] + "\n\n## Example (Create Cube)\n\n```python\n" + create_cube_example_complete + "\n```\n\n## Documentation" + readme_parts[1]
+    marker = "## Documentation"
+    if marker in readme_content:
+        readme_parts = readme_content.split(marker, 1)
+        readme_content = readme_parts[0] + "\n\n## Example (Create Cube)\n\n```python\n" + create_cube_example_complete + "\n```\n\n" + marker + readme_parts[1]
+    else:
+        # Fallback: append the example to the end
+        readme_content = readme_content + "\n\n## Example (Create Cube)\n\n```python\n" + create_cube_example_complete + "\n```\n"
 
     with open(readme_file, "w", encoding="utf-8") as file:
         file.write(readme_content)

prepare_pypi_release.py

@@ -43,7 +43,7 @@ def find_real_lib_path():
 # Setup script
 setup(
     name='lib3mf',
-    version='2.4.1',
+    version='2.4.1.post1',
     description='lib3mf is an implementation of the 3D Manufacturing Format file standard',
     long_description=readme_content,
     long_description_content_type='text/markdown',

setup.py

@@ -0,0 +1,32 @@
+import atexit
+import lib3mf
+from lib3mf import Lib3MF as _L  # this is the generated Lib3MF.py module
+
+
+print("Using lib3mf from:", lib3mf.__file__)
+print("Using Lib3MF module from:", _L.__file__)
+
+# --- Create some lib3mf objects as GLOBALS (so they live until shutdown) ---
+
+wrapper = lib3mf.get_wrapper()
+model = wrapper.CreateModel()
+mesh = model.AddMeshObject()
+mesh.SetName("py313-shutdown-test")
+writer = model.QueryWriter("3mf")
+
+
+def simulate_shutdown_bug():
+    print("Simulating interpreter teardown: setting Lib3MF.ErrorCodes = None")
+    # This mimics what CPython does when tearing down modules:
+    _L.ErrorCodes = None
+
+    print("Deleting mesh -> Base.__del__ -> Wrapper.Release -> checkError(ErrorCodes=None)")
+    # Deleting the mesh will trigger Base.__del__, which calls wrapper.Release(self),
+    # which calls checkError and tries to use ErrorCodes.SUCCESS -> boom.
+    global mesh
+    del mesh
+
+
+atexit.register(simulate_shutdown_bug)
+
+print("Setup complete. Exiting will trigger simulated shutdown.\n")