Python3 & CMake build + Thread caused bug fix

.gitignore

@@ -28,3 +28,9 @@
 *.app
 config.txt
 .DS_Store
+
+# CMake build folder
+*-build
+*__pycache__*
+
+notes*

CMakeLists.txt

@@ -0,0 +1,124 @@
+cmake_minimum_required(VERSION 3.24)
+project(py VERSION 0.1.0 LANGUAGES C CXX)
+
+include(CMakePrintHelpers)
+
+# set(CMAKE_INSTALL_RPATH_USE_LINK_PATH 1)
+
+find_package(Python3 REQUIRED COMPONENTS Interpreter Development NumPy)
+
+if(VERBOSE)
+    cmake_print_variables(Python3_INCLUDE_DIRS)
+    cmake_print_variables(Python3_NumPy_INCLUDE_DIRS)
+endif()
+
+# TODO: make a FindPd.cmake find module to address the following PD_* items:
+execute_process(
+    COMMAND "${Python3_EXECUTABLE}" -c "import platform; print('.pd_' + platform.system().lower())"
+    OUTPUT_VARIABLE PD_EXTERNAL_SUFFIX
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+)
+
+if(VERBOSE)
+    cmake_print_variables(PD_EXTERNAL_SUFFIX)
+endif()
+
+set(PD_EXTERNALS_PATH "~/Documents/Pd/externals" CACHE PATH "Pd externals path")
+
+if(UNIX AND NOT APPLE)
+    set(PD_SOURCE_PATH_DEFAULT /usr/local/pd/src)
+elseif(UNIX AND APPLE)
+    set(PD_SOURCE_PATH_DEFAULT /Applications/Pd-0.54-0.app/Contents/Resources/src)
+elseif(WIN32)
+    set(PD_SOURCE_PATH_DEFAULT c:/pd/src)
+endif()
+
+set(PD_SOURCE_PATH ${PD_SOURCE_PATH_DEFAULT} CACHE PATH "Pd src path")
+set(PD_INSTANCE OFF CACHE BOOL "Builds with PDINSTANCE defined")
+
+set(STRIP_TARGET OFF CACHE BOOL "Strip unneeded symbols from compiled library (saves some disk space)")
+
+set(FLEXT_SOURCE_PATH /usr/local/include/flext CACHE PATH "Flext source path")
+set(FLEXT_BUILD_TYPE SHARED CACHE STRING "Flext build type")
+set_property(CACHE FLEXT_BUILD_TYPE PROPERTY STRINGS "SINGLE" "SHARED" "MULTI")
+
+add_library(objects OBJECT
+    source/bound.cpp
+    source/clmeth.cpp
+    source/main.cpp
+    source/modmeth.cpp
+    source/py.cpp
+    source/pyargs.cpp
+    source/pyatom.cpp
+    source/pybase.cpp
+    source/pybuffer.cpp
+    source/pybundle.cpp
+    source/pycompat.cpp
+    source/pydsp.cpp
+    source/pyext.cpp
+    source/pymeth.cpp
+    source/pysymbol.cpp
+    source/register.cpp)
+
+target_compile_definitions(objects PRIVATE PD)
+target_compile_definitions(objects PRIVATE FLEXT_INLINE)
+target_compile_definitions(objects PRIVATE FLEXT_ATTRIBUTES=1)
+
+if(FLEXT_BUILD_TYPE STREQUAL MULTI)
+    target_compile_definitions(objects PRIVATE FLEXT_THREADS)
+elseif(FLEXT_BUILD_TYPE STREQUAL SHARED)
+    target_compile_definitions(objects PRIVATE FLEXT_SHARED)
+endif()
+
+if(${PD_INSTANCE})
+    target_compile_definitions(objects PRIVATE PDINSTANCE)
+    target_compile_definitions(objects PRIVATE PDTHREAD)
+endif()
+
+if(UNIX)
+    target_compile_definitions(objects PRIVATE UNIX)
+endif()
+
+target_compile_options(objects PRIVATE -O3 -Wl,--trace -fPIC -fcheck-new -Wall -Wextra -Wshadow -Winline -Wstrict-aliasing -ffast-math -funroll-loops -fomit-frame-pointer)
+target_include_directories(objects PRIVATE ${PD_SOURCE_PATH})
+target_include_directories(objects PRIVATE ${FLEXT_SOURCE_PATH})
+target_link_libraries(objects PRIVATE Python3::Python Python3::NumPy)
+
+# ---------------------------------------------- #
+# BUILDING PD EXTERNAL PY/PYEXT
+add_library(${PROJECT_NAME} SHARED $<TARGET_OBJECTS:objects>)
+target_compile_options(${PROJECT_NAME} PRIVATE -rdynamic -shared -fPIC -Wl,-rpath,"\$ORIGIN",--enable-new-dtags)
+target_link_libraries(${PROJECT_NAME}
+    PRIVATE -lc
+    PRIVATE -lm
+    PRIVATE -lstdc++
+)
+target_link_libraries(${PROJECT_NAME} PRIVATE Python3::Python Python3::NumPy)
+
+if(FLEXT_BUILD_TYPE STREQUAL MULTI)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE FLEXT_THREADS)
+elseif(FLEXT_BUILD_TYPE STREQUAL SHARED)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE FLEXT_SHARED)
+endif()
+if(${PD_INSTANCE})
+    target_compile_definitions(${PROJECT_NAME} PRIVATE PDINSTANCE)
+    target_compile_definitions(${PROJECT_NAME} PRIVATE PDTHREAD)
+endif()
+
+set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "")
+set_target_properties(${PROJECT_NAME} PROPERTIES SUFFIX "${PD_EXTERNAL_SUFFIX}")
+
+if(STRIP_TARGET)
+    add_custom_command(TARGET ${PROJECT_NAME} POST_BUILD
+        COMMAND strip --strip-unneeded ${CMAKE_BINARY_DIR}/${PROJECT_NAME}${PD_EXTERNAL_SUFFIX}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        COMMENT "Stripping file..."
+    )
+endif()
+
+# install to Pd externals directory (run `cmake --install <build-dir>` to install)
+if(NOT ${PD_INSTANCE})
+    install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME}${PD_EXTERNAL_SUFFIX} DESTINATION ${PD_EXTERNALS_PATH}/${PROJECT_NAME})
+else()
+    install(FILES ${CMAKE_BINARY_DIR}/${PROJECT_NAME}${PD_EXTERNAL_SUFFIX} DESTINATION ${PD_EXTERNALS_PATH}instance/${PROJECT_NAME})
+endif()

Makefile

@@ -0,0 +1,12 @@
+NAME=py
+cflags=-DFLEXT_INLINE -DFLEXT_ATTRIBUTES=1
+
+# source files
+$(NAME).class.sources = $(wildcard source/*.cpp)
+
+# help files
+datafiles = $(wildcard pd/*.pd scripts/*.py)
+
+# include Makefile.pdlibbuilder from submodule directory 'pd-lib-builder'
+PDLIBBUILDER_DIR=./pd-lib-builder/
+include $(PDLIBBUILDER_DIR)/Makefile.pdlibbuilder

README.md

@@ -0,0 +1,53 @@
+# py/pyext for Python 3
+
+## Credits
+
+### py/pyext - python script objects for PD and Max/MSP
+
+Copyright (c)2002-2020 Thomas Grill ([email protected])
+
+For information on usage and redistribution, and for a DISCLAIMER OF ALL
+WARRANTIES, see the file, "license.txt," in this distribution.  
+
+Donations for further development of the package are highly appreciated.
+Visit https://www.paypal.com/xclick/business=gr%40grrrr.org&item_name=pyext&no_note=1&tax=0&currency_code=EUR
+
+More info in the previous `readme.txt`.
+## Installation
+
+### Pre-requisite
+* A python3 environment;
+* An installation of [flext](https://github.com/grrrr/flext/);
+* cmake ;
+* ninja (optional).
+### Build with cmake
+
+Thanks to the work of @fferri, the `CMakeLists.txt` has been largely purified.
+The library can be build with wathever python3 environment ; to build with a conda environment for example, first activate that environment before running the following commands:
+```bash
+mkdir cmake-build
+cd cmake-build
+cmake .. \
+-GNinja \ # optional, builds faster 
+-DFLEXT_BUILD_TYPE=[SINGLE | MULTI | SHARED] # SINGLE is default
+```
+
+The variable `FLEXT_BUILD_TYPE` allows the user to choose which version of flext to use for the build. `MULTI` and `SHARED` enable thread usage.
+
+### Build with pd-lib-builder
+
+See `readme.txt`.
+## Pd configuration & usage
+
+### Configuration
+
+You should create a folder to hold your python scripts - we'll call it the pd script folder; ideally, place it alongside the folder that natively contains the pd externals (for example at `~/Documents/Pd/externals`).
+
+* Open puredata and go to `File > Preferences > Edit Preferences` (*might be something along the lines of `Paths` for older pd versions*);
+* Add the script folder to your search path.
+
+If you want to work with scripts that are located somewhere else on your machine, you can create a link to that file in the pd script folder. That way, you can modify your file in place and the changes will be taken into account in puredata without having to move your file over and over again.
+
+### Usage
+
+There are plenty examples of patches the `pd` folder of this repo. Try them out !

build/config-lnx.def

@@ -1,8 +1,13 @@
 # what is the base prefix of the Python installation?
+ifdef PY_CONDA_ROOT
+PYTHONPREFIX=$(PY_CONDA_ROOT)
+else
 PYTHONPREFIX=/usr
+endif
 
 # which Python version do you want to compile against?
-PYTHONVERSION=2.4
+PY_MAJOR_VERSION=3
+PY_MINOR_VERSION=7
 
 # uncomment if numpy/numarray/numeric support should be compiled in
 # for info see http://numeric.scipy.org
@@ -15,3 +20,6 @@ PY_USE_GIL=1
 
 # use inofficial (pure data) functionality
 # PY_USE_INOFFICIAL=1
+
+# use python with pymalloc (look for "pythonX.Ym" files) 
+PY_USE_PYMALLOC=1

build/config-mac.def

@@ -1,6 +1,9 @@
-# set PY_DEFAULT=0 if you manually installed Python on your system 
-# (overriding the one that came with OS X by default)
-PY_DEFAULT=1
+# which kind of Python installation to use
+#   system - macOS system default
+#   local - local installation
+#   conda - conda environment; specify the environment root dir using the
+#           PY_CONDA_ROOT environment variable
+PY_KIND=conda
 
 #########################################################################
 
@@ -10,16 +13,16 @@ PY_DEFAULT=1
 # Mac OSX 10.5 -> default Python version (major.minor) = 2.5
 # Mac OSX 10.6 -> default Python version (major.minor) = 2.6
 
-PY_MAJOR_VERSION=2
-PY_MINOR_VERSION=6
+PY_MAJOR_VERSION=3
+PY_MINOR_VERSION=7
 
 #########################################################################
 
 # uncomment if numpy/numarray/numeric support should be compiled in
 # for info see http://numeric.scipy.org
 # numarray and numeric are outdated
 
-# PY_NUMPY=1
+PY_NUMPY=1
 # PY_NUMARRAY=1
 # PY_NUMERIC=1
 
@@ -30,3 +33,6 @@ PY_USE_GIL=1
 
 # use inofficial (pure data) functionality
 # PY_USE_INOFFICIAL=1
+
+# use python with pymalloc (look for "pythonX.Ym" files)
+PY_USE_PYMALLOC=1

build/gnumake-lnx-gcc.inc

@@ -1,12 +1,27 @@
+ifdef PY_USE_PYMALLOC
+PYTHONVERSION=$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)m
+else
+PYTHONVERSION=$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)
+endif
+
 DEFS += -DPY_EXPORTS
+
 INCPATH += -I$(PYTHONPREFIX)/include/python$(PYTHONVERSION)
+
+ifdef PY_CONDA_ROOT
+LIBPATH += -L$(PY_CONDA_ROOT)/lib
+LDFLAGS += -Wl,-R$(PY_CONDA_ROOT)/lib
+DEFS += -DPY_INTERPRETER=$(PY_CONDA_ROOT)/bin/python
+endif
+
 LIBS += -lpython$(PYTHONVERSION)
 
 ifdef PY_NUMARRAY
 DEFS += -DPY_NUMARRAY
 endif
 ifdef PY_NUMPY
 DEFS += -DPY_NUMPY
+INCPATH += -I$(PYTHONPREFIX)/lib/python$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)/site-packages/numpy/core/include
 endif
 ifdef PY_NUMERIC
 DEFS += -DPY_NUMERIC

build/gnumake-mac-gcc.inc

@@ -1,42 +1,79 @@
+DEFS += -DPY_EXPORTS
+
+ifdef PY_NUMPY
+DEFS += -DPY_NUMPY
+endif
+
+ifdef PY_NUMARRAY
+DEFS += -DPY_NUMARRAY
+endif
+
+ifdef PY_NUMERIC
+DEFS += -DPY_NUMERIC
+endif
+
+ifdef PY_USE_GIL
+DEFS += -DPY_USE_GIL
+endif
+
+ifdef PY_USE_INOFFICIAL
+DEFS += -DPY_USE_INOFFICIAL
+endif
+
+ifeq ($(PY_KIND),conda)
+
+ifndef PY_CONDA_ROOT
+$(error PY_CONDA_ROOT is undefined)
+endif
+
+DEFS += -DPY_INTERPRETER=$(PY_CONDA_ROOT)/bin/python
+INCPATH += -I$(PY_CONDA_ROOT)/include
+ifdef PY_USE_PYMALLOC
+INCPATH += -I$(PY_CONDA_ROOT)/include/python$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)m
+LIBS += $(PY_CONDA_ROOT)/lib/libpython$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)m.dylib
+else
+INCPATH += -I$(PY_CONDA_ROOT)/include/python$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)
+LIBS += $(PY_CONDA_ROOT)/lib/libpython$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION).dylib
+endif
+LDFLAGS += -rpath $(PY_CONDA_ROOT)/lib
+
+ifdef PY_NUMPY
+INCPATH += -I$(PY_CONDA_ROOT)/lib/python$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)/site-packages/numpy/core/include
+endif
+
+else
+
+DEFS += -DPY_USE_FRAMEWORK
+
 # don't use -framework Python, since this will stick to the default system version
 
 _LOCAL_FRAMEWORK := /Library/Frameworks/Python.framework/Versions/$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)
 _SYSTEM_FRAMEWORK := /System/Library/Frameworks/Python.framework/Versions/$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)
 _LOCAL_LIBRARY := /Library/Python/$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)
 _SYSTEM_LIBRARY := /System/Library/Python/$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)
 
-DEFS += -DPY_EXPORTS
-#INCPATH += -F/Library/Frameworks -framework Python
+INCPATH += -F/Library/Frameworks -framework Python
 
-ifeq ($(PY_DEFAULT),1)
+ifeq ($(PY_KIND),system)
 LIBS += $(_SYSTEM_FRAMEWORK)/Python
 INCPATH += -I$(_SYSTEM_FRAMEWORK)/Headers
 else
 LIBS += $(_LOCAL_FRAMEWORK)/Python
 INCPATH += -I$(_LOCAL_FRAMEWORK)/Headers
 endif
 
-ifdef PY_NUMARRAY
-DEFS += -DPY_NUMARRAY
-endif
 ifdef PY_NUMPY
-DEFS += -DPY_NUMPY
 INCPATH += -I$(_LOCAL_LIBRARY)/python$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)/site-packages/numpy/core/include
-ifeq ($(PY_DEFAULT),1)
+
+ifeq ($(PY_KIND),system)
 INCPATH += -I$(_SYSTEM_FRAMEWORK)/lib/python$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)/site-packages/numpy/core/include
 INCPATH += -I$(_SYSTEM_FRAMEWORK)/Extras/lib/python/numpy/core/include
 else
 INCPATH += -I$(_LOCAL_FRAMEWORK)/lib/python$(PY_MAJOR_VERSION).$(PY_MINOR_VERSION)/site-packages/numpy/core/include
 endif
 endif
-ifdef PY_NUMERIC
-DEFS += -DPY_NUMERIC
-endif
 
-ifdef PY_USE_GIL
-DEFS += -DPY_USE_GIL
 endif
 
-ifdef PY_USE_INOFFICIAL
-DEFS += -DPY_USE_INOFFICIAL
-endif
+#DEBUG = 1
+#DFLAGS += -DFLEXT_DEBUG

maxmsp/py.maxhelp

@@ -133,7 +133,7 @@
 , 			{
 				"box" : 				{
 					"maxclass" : "message",
-					"text" : "gain 0.5",
+					"text" : "set gain 0.5",
 					"fontsize" : 12.0,
 					"numinlets" : 2,
 					"patching_rect" : [ 100.77256, 1262.583496, 53.0, 18.0 ],